EventGrid CLI extension: Updates to support new preview API version features

src/eventgrid/azext_eventgrid/_client_factory.py

@@ -13,10 +13,14 @@ def cf_eventgrid(cli_ctx, **_):
 def topics_factory(cli_ctx, _):
     return cf_eventgrid(cli_ctx).topics
 
+def domains_factory(cli_ctx, _):
+    return cf_eventgrid(cli_ctx).domains
+
+def domain_topics_factory(cli_ctx, _):
+    return cf_eventgrid(cli_ctx).domain_topics
 
 def event_subscriptions_factory(cli_ctx, _):
     return cf_eventgrid(cli_ctx).event_subscriptions
 
-
 def topic_types_factory(cli_ctx, _):
     return cf_eventgrid(cli_ctx).topic_types

src/eventgrid/azext_eventgrid/_params.py

@@ -17,8 +17,10 @@
     name_type
 )
 
+from .advanced_filter import EventSubscriptionAddFilter
+
 included_event_types_type = CLIArgumentType(
-    help="A space-separated list of event types. To subscribe to all event types, the string \"All\" should be specified.",
+    help="A space-separated list of event types. Example: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted. To subscribe to all event types, the string \"All\" should be specified.",
     nargs='+'
 )
 
@@ -36,7 +38,7 @@ def load_arguments(self, _):
         c.argument('included_event_types', arg_type=included_event_types_type)
         c.argument('labels', arg_type=labels_type)
         c.argument('endpoint_type', arg_type=get_enum_type(['webhook', 'eventhub', 'storagequeue', 'hybridconnection'], default='webhook'))
-        c.argument('resource_id', help="Fully qualified identifier of the Azure resource.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True), help="Fully qualified identifier of the Azure resource.")
         c.argument('endpoint', help="Endpoint where EventGrid should deliver events matching this event subscription. For webhook endpoint type, this should be the corresponding webhook URL. For other endpoint types, this should be the Azure resource identifier of the endpoint.")
         c.argument('event_subscription_name', help="Name of the event subscription.")
         c.argument('subject_begins_with', help="An optional string to filter events for an event subscription based on a prefix. Wildcard characters are not supported.")
@@ -46,29 +48,55 @@ def load_arguments(self, _):
 
     with self.argument_context('eventgrid topic') as c:
         c.argument('topic_name', arg_type=name_type, help='Name of the topic', id_part='name', completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
-        c.argument('input_mapping_fields', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on field names. Specify space separated mappings in 'key=value' format. Allowed key names are 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the names of the fields in the custom input schema.")
-        c.argument('input_mapping_default_values', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on default values. Specify space separated mappings in 'key=value' format. Allowed key names are 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the default values to be used for the mapping.")
+        c.argument('input_mapping_fields', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on field names. Specify space separated mappings in 'key=value' format. Allowed key names are 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the names of the fields in the custom input schema. If a mapping for either 'id' or 'eventtime' is not provided, Event Grid will auto-generate a default value for these two fields.")
+        c.argument('input_mapping_default_values', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter can be used to specify input mappings based on default values. You can use this parameter when your custom schema does not include a field that corresponds to one of the three fields supported by this parameter. Specify space separated mappings in 'key=value' format. Allowed key names are 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the default values to be used for the mapping and they will be used only when the published event doesn't have a valid mapping for a particular field.")
         c.argument('input_schema', arg_type=get_enum_type(['eventgridschema', 'customeventschema', 'cloudeventv01schema'], default='eventgridschema'), help='Schema in which incoming events will be published for this topic. If customeventschema is specified, either input_mapping_default_values or input_mapping_fields must be specified as well.')
 
+    with self.argument_context('eventgrid domain') as c:
+        c.argument('domain_name', arg_type=name_type, help='Name of the domain', id_part='name', completer=get_resource_name_completion_list('Microsoft.EventGrid/domains'))
+        c.argument('input_mapping_fields', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on field names. Specify space separated mappings in 'key=value' format. Allowed key names are 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the names of the fields in the custom input schema. If a mapping for either 'id' or 'eventtime' is not provided, Event Grid will auto-generate a default value for these two fields.")
+        c.argument('input_mapping_default_values', arg_type=tags_type, help="When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on default values. You can use this parameter when your custom schema does not include a field that corresponds to one of the three fields supported by this parameter. Specify space separated mappings in 'key=value' format. Allowed key names are 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the default values to be used for the mapping and they will be used only when the published event doesn't have a valid mapping for a particular field.")
+        c.argument('input_schema', arg_type=get_enum_type(['eventgridschema', 'customeventschema', 'cloudeventv01schema'], default='eventgridschema'), help='Schema in which incoming events will be published for this domain. If customeventschema is specified, either input_mapping_default_values or input_mapping_fields must be specified as well.')
+
     with self.argument_context('eventgrid event-subscription') as c:
-        c.argument('topic_name', help='Name of the Event Grid topic', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
+        c.argument('topic_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), help='Name of Event Grid topic', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
         c.argument('event_subscription_name', arg_type=name_type, help='Name of the event subscription')
-        c.argument('event_delivery_schema', arg_type=get_enum_type(['eventgridschema', 'inputeventschema', 'cloudeventv01schema'], default='inputeventschema'), help='The schema in which events should be delivered for this event subscription. By default, events are delivered in the same schema in which they are published (inputeventschema).')
+        c.argument('event_delivery_schema', arg_type=get_enum_type(['eventgridschema', 'custominputschema', 'cloudeventv01schema']), help='The schema in which events should be delivered for this event subscription. By default, events will be delivered in the same schema in which they are published (based on the corresponding topic\'s input schema).')
         c.argument('max_delivery_attempts', help="Maximum number of delivery attempts. Must be a number between 1 and 30.")
         c.argument('event_ttl', help="Event time to live (in minutes). Must be a number between 1 and 1440.")
         c.argument('deadletter_endpoint', help="The Azure resource ID of an Azure Storage blob container destination where EventGrid should deadletter undeliverable events for this event subscription.")
 
     with self.argument_context('eventgrid event-subscription create') as c:
-        c.argument('topic_name', help='Name of the Event Grid topic to which the event subscription needs to be created.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
+        c.argument('source_resource_id', help="Fully qualified identifier of the Azure resource to which the event subscription needs to be created.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True))
+        c.argument('resource_group_name', deprecate_info=c.deprecate(expiration='2.1.0'), arg_type=resource_group_name_type)
+        c.argument('topic_name', deprecate_info=c.deprecate(expiration='2.1.0'), help='Name of the Event Grid topic to which the event subscription needs to be created.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
         c.argument('event_subscription_name', arg_type=name_type, help='Name of the new event subscription')
-        c.argument('resource_id', help="Fully qualified identifier of the Azure resource to which the event subscription needs to be created.")
+        c.argument('advanced_filter', action=EventSubscriptionAddFilter, nargs='+')
+        c.argument('expiration_date', help="Date or datetime (in UTC, e.g. '2018-11-30T11:59:59+00:00' or '2018-11-30') after which the event subscription would expire. By default, there is no expiration for the event subscription.")
 
     with self.argument_context('eventgrid event-subscription delete') as c:
-        c.argument('topic_name', help='Name of the Event Grid topic whose event subscription needs to be deleted.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
+        c.argument('source_resource_id', help="Fully qualified identifier of the Azure resource whose event subscription needs to be deleted.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True))
+        c.argument('resource_group_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), arg_type=resource_group_name_type)
+        c.argument('topic_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), help='Name of the Event Grid topic whose event subscription needs to be deleted.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
         c.argument('event_subscription_name', arg_type=name_type, help='Name of the event subscription')
-        c.argument('resource_id', help="Fully qualified identifier of the Azure resource whose event subscription needs to be deleted.")
+
+    with self.argument_context('eventgrid event-subscription list') as c:
+        c.argument('source_resource_id', help="Fully qualified identifier of the Azure resource whose event subscriptions need to be listed.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True))
+
+    with self.argument_context('eventgrid event-subscription update') as c:
+        c.argument('resource_group_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), arg_type=resource_group_name_type)
+        c.argument('topic_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), help='Name of the Event Grid topic whose event subscription needs to be updated.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
+        c.argument('source_resource_id', help="Fully qualified identifier of the Azure resource whose event subscription needs to be updated.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True))
 
     with self.argument_context('eventgrid event-subscription show') as c:
+        c.argument('source_resource_id', help="Fully qualified identifier of the Azure resource whose event subscription needs to be shown.")
+        c.argument('resource_id', deprecate_info=c.deprecate(redirect="--source-resource-id", expiration='2.1.0', hide=True))
+        c.argument('resource_group_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), arg_type=resource_group_name_type)
+        c.argument('topic_name', deprecate_info=c.deprecate(expiration='2.1.0', hide=True), help='Name of the Event Grid topic whose event subscription needs to be updated.', options_list=['--topic-name'], completer=get_resource_name_completion_list('Microsoft.EventGrid/topics'))
         c.argument('include_full_endpoint_url', arg_type=get_three_state_flag(), options_list=['--include-full-endpoint-url'], help="Specify to indicate whether the full endpoint URL should be returned. True if flag present.", )
 
     with self.argument_context('eventgrid topic-type') as c:

src/eventgrid/azext_eventgrid/advanced_filter.py

@@ -0,0 +1,96 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+import argparse
+from knack.util import CLIError
+
+from azext_eventgrid.mgmt.eventgrid.models import (
+    NumberGreaterThanAdvancedFilter,
+    NumberGreaterThanOrEqualsAdvancedFilter,
+    NumberInAdvancedFilter,
+    NumberLessThanAdvancedFilter,
+    NumberLessThanOrEqualsAdvancedFilter,
+    NumberNotInAdvancedFilter,
+    StringBeginsWithAdvancedFilter,
+    StringContainsAdvancedFilter,
+    StringEndsWithAdvancedFilter,
+    StringInAdvancedFilter,
+    StringNotInAdvancedFilter,
+    BoolEqualsAdvancedFilter)
+
+NUMBERIN = "NumberIn"
+NUMBERNOTIN = "NumberNotIn"
+STRINGIN = "StringIn"
+STRINGNOTIN = "StringNotIn"
+STRINGBEGINSWITH = "StringBeginsWith"
+STRINGCONTAINS = "StringContains"
+STRINGENDSWITH = "StringEndsWith"
+NUMBERGREATERTHAN = "NumberGreaterThan"
+NUMBERGREATERTHANOREQUALS = "NumberGreaterThanOrEquals"
+NUMBERLESSTHAN = "NumberLessThan"
+NUMBERLESSTHANOREQUALS = "NumberLessThanOrEquals"
+BOOLEQUALS = "BoolEquals"
+
+# pylint: disable=protected-access
+# pylint: disable=too-few-public-methods
+class EventSubscriptionAddFilter(argparse._AppendAction):
+    def __call__(self, parser, namespace, values, option_string=None):
+        if len(values) < 3:
+            raise CLIError('usage error: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...]')
+
+        key = values[0]
+        operator = values[1]
+
+# operators that support single value
+        if operator.lower() == NUMBERLESSTHAN.lower():
+            _validate_only_single_value_is_specified(NUMBERLESSTHAN, values)
+            advanced_filter = NumberLessThanAdvancedFilter(key=key, value=float(values[2]))
+        elif operator.lower() == NUMBERLESSTHANOREQUALS.lower():
+            _validate_only_single_value_is_specified(NUMBERLESSTHANOREQUALS, values)
+            advanced_filter = NumberLessThanOrEqualsAdvancedFilter(key=key, value=float(values[2]))
+        elif operator.lower() == NUMBERGREATERTHAN.lower():
+            _validate_only_single_value_is_specified(NUMBERGREATERTHAN, values)
+            advanced_filter = NumberGreaterThanAdvancedFilter(key=key, value=float(values[2]))
+        elif operator.lower() == NUMBERGREATERTHANOREQUALS.lower():
+            _validate_only_single_value_is_specified(NUMBERGREATERTHANOREQUALS, values)
+            advanced_filter = NumberGreaterThanOrEqualsAdvancedFilter(key=key, value=float(values[2]))
+        elif operator.lower() == BOOLEQUALS.lower():
+            _validate_only_single_value_is_specified(BOOLEQUALS, values)
+            advanced_filter = BoolEqualsAdvancedFilter(key=key, value=bool(values[2]))
+
+# operators that support multiple values
+        elif operator.lower() == NUMBERIN.lower():
+            float_values = [float(i) for i in values[2:]]
+            advanced_filter = NumberInAdvancedFilter(key=key, values=float_values)
+        elif operator.lower() == NUMBERNOTIN.lower():
+            float_values = [float(i) for i in values[2:]]
+            advanced_filter = NumberNotInAdvancedFilter(key=key, values=float_values)
+        elif operator.lower() == STRINGIN.lower():
+            advanced_filter = StringInAdvancedFilter(key=key, values=values[2:])
+        elif operator.lower() == STRINGNOTIN.lower():
+            advanced_filter = StringNotInAdvancedFilter(key=key, values=values[2:])
+        elif operator.lower() == STRINGBEGINSWITH.lower():
+            advanced_filter = StringBeginsWithAdvancedFilter(key=key, values=values[2:])
+        elif operator.lower() == STRINGENDSWITH.lower():
+            advanced_filter = StringEndsWithAdvancedFilter(key=key, values=values[2:])
+        elif operator.lower() == STRINGCONTAINS.lower():
+            advanced_filter = StringContainsAdvancedFilter(key=key, values=values[2:])
+        else:
+            raise CLIError("--advanced-filter: The specified filter operator '{}' is not"
+                           " a valid operator. Supported values are ".format(operator) +
+                           NUMBERIN + "," + NUMBERNOTIN + "," + STRINGIN + "," +
+                           STRINGNOTIN + "," + STRINGBEGINSWITH + "," +
+                           STRINGCONTAINS + "," + STRINGENDSWITH + "," +
+                           NUMBERGREATERTHAN + "," + NUMBERGREATERTHANOREQUALS + "," +
+                           NUMBERLESSTHAN + "," + NUMBERLESSTHANOREQUALS + "," + BOOLEQUALS + ".")
+        if namespace.advanced_filter is None:
+            namespace.advanced_filter = []
+        namespace.advanced_filter.append(advanced_filter)
+
+
+def _validate_only_single_value_is_specified(operator_type, values):
+    if len(values) != 3:
+        raise CLIError("--advanced-filter: For '{}' operator, only one filter value "
+                       "must be specified.".format(operator_type))