From 1f27fb9e6cb3b690c6330d6fdf92192729648887 Mon Sep 17 00:00:00 2001 From: SwaggerToSDK Automation Date: Wed, 9 Nov 2016 23:54:11 +0000 Subject: [PATCH] Generated from 08de0bfdbc6b93843d8defaa9b3e63a23044b97f --- .../eventhub/event_hub_management_client.py | 10 +-- ...sumer_group_create_or_update_parameters.py | 6 +- .../models/consumer_group_resource.py | 6 +- .../event_hub_create_or_update_parameters.py | 2 +- .../eventhub/models/event_hub_properties.py | 10 +-- .../eventhub/models/event_hub_resource.py | 12 ++-- .../namespace_create_or_update_parameters.py | 8 +-- .../eventhub/models/namespace_resource.py | 8 +-- .../models/regenerate_keys_parameters.py | 4 +- .../eventhub/models/resource_list_keys.py | 14 ++-- ...zation_rule_create_or_update_parameters.py | 6 +- ...ared_access_authorization_rule_resource.py | 2 +- .../azure/mgmt/eventhub/models/sku.py | 10 +-- .../operations/consumer_groups_operations.py | 30 ++++---- .../operations/event_hubs_operations.py | 53 +++++++------- .../operations/namespaces_operations.py | 70 +++++++++++-------- 16 files changed, 130 insertions(+), 121 deletions(-) diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/event_hub_management_client.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/event_hub_management_client.py index 4a2b5306a5657..0ef5b761bb6a6 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/event_hub_management_client.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/event_hub_management_client.py @@ -27,11 +27,11 @@ class EventHubManagementClientConfiguration(AzureConfiguration): :param credentials: Credentials needed for the client to connect to Azure. :type credentials: :mod:`A msrestazure Credentials object` - :param subscription_id: Subscription credentials which uniquely identify + :param subscription_id: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. :type subscription_id: str - :param api_version: Client Api Version. + :param api_version: Client API Version. :type api_version: str :param accept_language: Gets or sets the preferred language for the response. @@ -77,7 +77,7 @@ def __init__( class EventHubManagementClient(object): - """Azure EventHub client + """Azure Event Hubs client :ivar config: Configuration for client. :vartype config: EventHubManagementClientConfiguration @@ -92,11 +92,11 @@ class EventHubManagementClient(object): :param credentials: Credentials needed for the client to connect to Azure. :type credentials: :mod:`A msrestazure Credentials object` - :param subscription_id: Subscription credentials which uniquely identify + :param subscription_id: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. :type subscription_id: str - :param api_version: Client Api Version. + :param api_version: Client API Version. :type api_version: str :param accept_language: Gets or sets the preferred language for the response. diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_create_or_update_parameters.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_create_or_update_parameters.py index 22ea6ee0888f3..3dcfaa8178b6e 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_create_or_update_parameters.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_create_or_update_parameters.py @@ -13,7 +13,7 @@ class ConsumerGroupCreateOrUpdateParameters(Model): - """Parameters supplied to the CreateOrUpdate Consumer Group operation. + """Parameters supplied to the Create Or Update Consumer Group operation. :param location: Location of the resource. :type location: str @@ -23,9 +23,9 @@ class ConsumerGroupCreateOrUpdateParameters(Model): :type name: str :param created_at: Exact time the message was created. :type created_at: datetime - :param event_hub_path: The path of the event hub. + :param event_hub_path: The path of the Event Hub. :type event_hub_path: str - :param updated_at: The exact time the message has been updated. + :param updated_at: The exact time the message was updated. :type updated_at: datetime :param user_metadata: The user metadata. :type user_metadata: str diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_resource.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_resource.py index 1f0b43acc9629..a9acaa6d149bd 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_resource.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/consumer_group_resource.py @@ -13,7 +13,7 @@ class ConsumerGroupResource(Resource): - """Description of Consumer Group Resource. + """Description of the consumer group resource. Variables are only populated by the server, and will be ignored when sending a request. @@ -30,9 +30,9 @@ class ConsumerGroupResource(Resource): :type tags: dict :param created_at: Exact time the message was created. :type created_at: datetime - :param event_hub_path: The path of the event hub. + :param event_hub_path: The path of the Event Hub. :type event_hub_path: str - :param updated_at: The exact time the message has been updated. + :param updated_at: The exact time the message was updated. :type updated_at: datetime :param user_metadata: The user metadata. :type user_metadata: str diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_create_or_update_parameters.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_create_or_update_parameters.py index 695f77e6b8f63..5977042fc3ef6 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_create_or_update_parameters.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_create_or_update_parameters.py @@ -13,7 +13,7 @@ class EventHubCreateOrUpdateParameters(Model): - """Parameters supplied to the CreateOrUpdate EventHub operation. + """Parameters supplied to the Create Or Update Event Hub operation. :param location: Location of the resource. :type location: str diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_properties.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_properties.py index ccc5908cb5a8d..4439cd0a94072 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_properties.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_properties.py @@ -15,22 +15,22 @@ class EventHubProperties(Model): """EventHubProperties. - :param created_at: Exact time the Event was created. + :param created_at: Exact time the Event Hub was created. :type created_at: datetime :param message_retention_in_days: Number of days to retain the events for this Event Hub. :type message_retention_in_days: long - :param partition_count: Number of partitions created for EventHub. + :param partition_count: Number of partitions created for the Event Hub. :type partition_count: long :param partition_ids: Current number of shards on the Event Hub. :type partition_ids: list of str - :param status: Enumerates the possible values for the status of the - EventHub. Possible values include: 'Active', 'Disabled', 'Restoring', + :param status: Enumerates the possible values for the status of the Event + Hub. Possible values include: 'Active', 'Disabled', 'Restoring', 'SendDisabled', 'ReceiveDisabled', 'Creating', 'Deleting', 'Renaming', 'Unknown' :type status: str or :class:`EntityStatus ` - :param updated_at: The exact time the message has been updated. + :param updated_at: The exact time the message was updated. :type updated_at: datetime """ diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_resource.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_resource.py index c0e54f841e5bf..57bc5745a35d3 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_resource.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/event_hub_resource.py @@ -13,7 +13,7 @@ class EventHubResource(Resource): - """Description of EventHub Resource. + """Description of the Event Hub resource. Variables are only populated by the server, and will be ignored when sending a request. @@ -28,22 +28,22 @@ class EventHubResource(Resource): :type location: str :param tags: Resource tags :type tags: dict - :param created_at: Exact time the Event was created. + :param created_at: Exact time the Event Hub was created. :type created_at: datetime :param message_retention_in_days: Number of days to retain the events for this Event Hub. :type message_retention_in_days: long - :param partition_count: Number of partitions created for EventHub. + :param partition_count: Number of partitions created for the Event Hub. :type partition_count: long :param partition_ids: Current number of shards on the Event Hub. :type partition_ids: list of str - :param status: Enumerates the possible values for the status of the - EventHub. Possible values include: 'Active', 'Disabled', 'Restoring', + :param status: Enumerates the possible values for the status of the Event + Hub. Possible values include: 'Active', 'Disabled', 'Restoring', 'SendDisabled', 'ReceiveDisabled', 'Creating', 'Deleting', 'Renaming', 'Unknown' :type status: str or :class:`EntityStatus ` - :param updated_at: The exact time the message has been updated. + :param updated_at: The exact time the message was updated. :type updated_at: datetime """ diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_create_or_update_parameters.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_create_or_update_parameters.py index 2dc39f568b330..576e858ecfa74 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_create_or_update_parameters.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_create_or_update_parameters.py @@ -13,7 +13,7 @@ class NamespaceCreateOrUpdateParameters(Model): - """Parameters supplied to the CreateOrUpdate Namespace operation. + """Parameters supplied to the Create Or Update Namespace operation. :param location: Namespace location. :type location: str @@ -21,7 +21,7 @@ class NamespaceCreateOrUpdateParameters(Model): :type sku: :class:`Sku ` :param tags: Namespace tags. :type tags: dict - :param provisioning_state: Provisioning state of the Namespace. + :param provisioning_state: Provisioning state of the namespace. :type provisioning_state: str :param status: State of the namespace. Possible values include: 'Unknown', 'Creating', 'Created', 'Activating', 'Enabling', 'Active', @@ -33,10 +33,10 @@ class NamespaceCreateOrUpdateParameters(Model): :type created_at: datetime :param updated_at: The time the namespace was updated. :type updated_at: datetime - :param service_bus_endpoint: Endpoint you can use to perform ServiceBus + :param service_bus_endpoint: Endpoint you can use to perform Service Bus operations. :type service_bus_endpoint: str - :param create_acs_namespace: Indicates whether to create ACS namespace. + :param create_acs_namespace: Indicates whether to create an ACS namespace. :type create_acs_namespace: bool :param enabled: Specifies whether this instance is enabled. :type enabled: bool diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_resource.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_resource.py index 6d549d64c73a8..72a53c891ae1a 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_resource.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/namespace_resource.py @@ -13,7 +13,7 @@ class NamespaceResource(Resource): - """Description of a Namespace resource. + """Description of a namespace resource. Variables are only populated by the server, and will be ignored when sending a request. @@ -30,7 +30,7 @@ class NamespaceResource(Resource): :type tags: dict :param sku: :type sku: :class:`Sku ` - :param provisioning_state: Provisioning state of the Namespace. + :param provisioning_state: Provisioning state of the namespace. :type provisioning_state: str :param status: State of the namespace. Possible values include: 'Unknown', 'Creating', 'Created', 'Activating', 'Enabling', 'Active', @@ -42,10 +42,10 @@ class NamespaceResource(Resource): :type created_at: datetime :param updated_at: The time the namespace was updated. :type updated_at: datetime - :param service_bus_endpoint: Endpoint you can use to perform ServiceBus + :param service_bus_endpoint: Endpoint you can use to perform Service Bus operations. :type service_bus_endpoint: str - :param create_acs_namespace: Indicates whether to create ACS namespace. + :param create_acs_namespace: Indicates whether to create an ACS namespace. :type create_acs_namespace: bool :param enabled: Specifies whether this instance is enabled. :type enabled: bool diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/regenerate_keys_parameters.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/regenerate_keys_parameters.py index e756fcdccffe5..d52a763cfdf19 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/regenerate_keys_parameters.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/regenerate_keys_parameters.py @@ -13,9 +13,9 @@ class RegenerateKeysParameters(Model): - """Parameters supplied to the Regenerate Auth Rule. + """Parameters supplied to the Regenerate Authorization Rule operation. - :param policykey: Key that needs to be regenerated . Possible values + :param policykey: Key that needs to be regenerated. Possible values include: 'PrimaryKey', 'SecondaryKey' :type policykey: str or :class:`Policykey ` diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/resource_list_keys.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/resource_list_keys.py index b505b40a7a4fc..ade436818e039 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/resource_list_keys.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/resource_list_keys.py @@ -15,19 +15,19 @@ class ResourceListKeys(Model): """Namespace/EventHub Connection String. - :param primary_connection_string: PrimaryConnectionString of the created - Namespace AuthorizationRule. + :param primary_connection_string: Primary connection string of the + created namespace authorization rule. :type primary_connection_string: str - :param secondary_connection_string: SecondaryConnectionString of the - created Namespace AuthorizationRule + :param secondary_connection_string: Secondary connection string of the + created namespace authorization rule. :type secondary_connection_string: str :param primary_key: A base64-encoded 256-bit primary key for signing and - validating the SAS token + validating the SAS token. :type primary_key: str :param secondary_key: A base64-encoded 256-bit primary key for signing - and validating the SAS token + and validating the SAS token. :type secondary_key: str - :param key_name: A string that describes the authorization rule + :param key_name: A string that describes the authorization rule. :type key_name: str """ diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_create_or_update_parameters.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_create_or_update_parameters.py index 404be963d5139..cc0b3ed039201 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_create_or_update_parameters.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_create_or_update_parameters.py @@ -13,11 +13,11 @@ class SharedAccessAuthorizationRuleCreateOrUpdateParameters(Model): - """Parameters supplied to the CreateOrUpdate AuthorizationRules. + """Parameters supplied to the Create Or Update Authorization Rules operation. - :param location: data center location. + :param location: Data center location. :type location: str - :param name: Name of the AuthorizationRule. + :param name: Name of the authorization rule. :type name: str :param rights: The rights associated with the rule. :type rights: list of str or :class:`AccessRights diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_resource.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_resource.py index e50189314bf7d..342f60af5ae41 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_resource.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/shared_access_authorization_rule_resource.py @@ -13,7 +13,7 @@ class SharedAccessAuthorizationRuleResource(Resource): - """Description of a Namespace AuthorizationRules. + """Description of a namespace authorization rule. Variables are only populated by the server, and will be ignored when sending a request. diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/sku.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/sku.py index 6c1b4d1053008..3267209d84d41 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/models/sku.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/models/sku.py @@ -13,15 +13,15 @@ class Sku(Model): - """Sku of the Namespace. + """SKU of the namespace. - :param name: Name of this Sku. Possible values include: 'Basic', + :param name: Name of this SKU. Possible values include: 'Basic', 'Standard', 'Premium' :type name: str or :class:`SkuName ` - :param tier: The tier of this particular SKU. Possible values include: - 'Basic', 'Standard', 'Premium' + :param tier: The billing tier of this particular SKU. Possible values + include: 'Basic', 'Standard', 'Premium' :type tier: str or :class:`SkuTier ` - :param capacity: The eventhub throughput units + :param capacity: The Event Hubs throughput units. :type capacity: int """ diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/consumer_groups_operations.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/consumer_groups_operations.py index aadeb326204ff..1fd9daecea0be 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/consumer_groups_operations.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/consumer_groups_operations.py @@ -35,19 +35,19 @@ def __init__(self, client, config, serializer, deserializer): def create_or_update( self, resource_group_name, namespace_name, event_hub_name, consumer_group_name, parameters, custom_headers=None, raw=False, **operation_config): - """Creates/Updates a consumer group as a nested resource within a - namespace. + """Creates or updates an Event Hubs consumer group as a nested resource + within a namespace. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param consumer_group_name: The Consumer Group name. + :param consumer_group_name: The consumer group name. :type consumer_group_name: str - :param parameters: Parameters supplied to create a Consumer Group - Resource. + :param parameters: Parameters supplied to create a consumer group + resource. :type parameters: :class:`ConsumerGroupCreateOrUpdateParameters ` :param dict custom_headers: headers that will be added to the request @@ -112,16 +112,16 @@ def create_or_update( def delete( self, resource_group_name, namespace_name, event_hub_name, consumer_group_name, custom_headers=None, raw=False, **operation_config): - """Deletes an ConsumerGroup from the specified EventHub and resource + """Deletes a consumer group from the specified Event Hub and resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param consumer_group_name: The Consumer Group name. + :param consumer_group_name: The Cconsumer group name. :type consumer_group_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -173,15 +173,15 @@ def delete( def get( self, resource_group_name, namespace_name, event_hub_name, consumer_group_name, custom_headers=None, raw=False, **operation_config): - """Returns an Consumer Group description for the specified Consumer Group. + """Gets a description for the specified consumer group. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param consumer_group_name: The Consumer Group name. + :param consumer_group_name: The consumer group name. :type consumer_group_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -241,14 +241,14 @@ def get( def list_all( self, resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config): - """Enumerates the consumer groups in a namespace. An empty feed is - returned if no consumer group exists in the namespace. + """Gets all the consumer groups in a namespace. An empty feed is returned + if no consumer group exists in the namespace. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/event_hubs_operations.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/event_hubs_operations.py index c4aaab176d402..83677d93a6b39 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/event_hubs_operations.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/event_hubs_operations.py @@ -35,7 +35,7 @@ def __init__(self, client, config, serializer, deserializer): def list_all( self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config): - """Enumerates the Event Hubs in a namespace. + """Gets all the Event Hubs in a namespace. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -104,16 +104,17 @@ def internal_paging(next_link=None, raw=False): def create_or_update( self, resource_group_name, namespace_name, event_hub_name, parameters, custom_headers=None, raw=False, **operation_config): - """Creates/Updates a new Event Hub as a nested resource within a + """Creates or updates a new Event Hub as a nested resource within a namespace. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param parameters: Parameters supplied to create a EventHub Resource. + :param parameters: Parameters supplied to create an Event Hub + resource. :type parameters: :class:`EventHubCreateOrUpdateParameters ` :param dict custom_headers: headers that will be added to the request @@ -177,13 +178,13 @@ def create_or_update( def delete( self, resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config): - """Deletes an Event hub from the specified namespace and resource group. + """Deletes an Event Hub from the specified namespace and resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The name of the Event Hub to delete. :type event_hub_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -234,13 +235,13 @@ def delete( def get( self, resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config): - """Returns an Event Hub description for the specified Event Hub. + """Gets an Event Hubs description for the specified Event Hub. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -299,13 +300,13 @@ def get( def list_authorization_rules( self, resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config): - """Authorization rules for a EventHub. + """Gets the authorization rules for an Event Hub. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param namespace_name: The NameSpace name + :param namespace_name: The namespace name :type namespace_name: str - :param event_hub_name: The EventHub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -371,7 +372,7 @@ def internal_paging(next_link=None, raw=False): def create_or_update_authorization_rule( self, resource_group_name, namespace_name, event_hub_name, authorization_rule_name, parameters, custom_headers=None, raw=False, **operation_config): - """Creates an authorization rule for the specified Event Hub. + """Creates or updates an authorization rule for the specified Event Hub. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -379,7 +380,7 @@ def create_or_update_authorization_rule( :type namespace_name: str :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param authorization_rule_name: Aauthorization Rule Name. + :param authorization_rule_name: The authorization rule name. :type authorization_rule_name: str :param parameters: The shared access authorization rule. :type parameters: @@ -447,15 +448,15 @@ def create_or_update_authorization_rule( def get_authorization_rule( self, resource_group_name, namespace_name, event_hub_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Authorization rule for a EventHub by name. + """Gets an authorization rule for an Event Hub by rule name. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param namespace_name: The namespace name + :param namespace_name: The namespace name. :type namespace_name: str :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param authorization_rule_name: Authorization rule name. + :param authorization_rule_name: The authorization rule name. :type authorization_rule_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -515,15 +516,15 @@ def get_authorization_rule( def delete_authorization_rule( self, resource_group_name, namespace_name, event_hub_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Deletes a EventHub authorization rule. + """Deletes an Event Hubs authorization rule. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The Eventhub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param authorization_rule_name: Authorization Rule Name. + :param authorization_rule_name: The authorization rule name. :type authorization_rule_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -575,16 +576,16 @@ def delete_authorization_rule( def list_keys( self, resource_group_name, namespace_name, event_hub_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Returns the ACS and SAS connection strings for the Event Hub. + """Gets the ACS and SAS connection strings for the Event Hub. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The event hub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str :param authorization_rule_name: The connection string of the - namespace for the specified authorizationRule. + namespace for the specified authorization rule. :type authorization_rule_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -650,12 +651,12 @@ def regenerate_keys( :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param event_hub_name: The event hub name. + :param event_hub_name: The Event Hub name. :type event_hub_name: str - :param authorization_rule_name: The connection string of the EventHub - for the specified authorizationRule. + :param authorization_rule_name: The connection string of the Event + Hub for the specified authorization rule. :type authorization_rule_name: str - :param policykey: Key that needs to be regenerated . Possible values + :param policykey: Key that needs to be regenerated. Possible values include: 'PrimaryKey', 'SecondaryKey' :type policykey: str or :class:`Policykey ` diff --git a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/namespaces_operations.py b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/namespaces_operations.py index a52ace57c0f73..cd67db43bb6fe 100644 --- a/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/namespaces_operations.py +++ b/azure-mgmt-eventhub/azure/mgmt/eventhub/operations/namespaces_operations.py @@ -36,8 +36,8 @@ def __init__(self, client, config, serializer, deserializer): def list_by_subscription( self, custom_headers=None, raw=False, **operation_config): - """Lists all the available namespaces within the subscription - irrespective of the resourceGroups. + """Lists all the available namespaces within a subscription, irrespective + of the resource groups. :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -100,7 +100,7 @@ def internal_paging(next_link=None, raw=False): def list_by_resource_group( self, resource_group_name, custom_headers=None, raw=False, **operation_config): - """Lists the available namespaces within a resourceGroup. + """Lists the available namespaces within a resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -166,14 +166,14 @@ def internal_paging(next_link=None, raw=False): def create_or_update( self, resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config): - """Creates Updates namespace. Once created, this namespace's resource - manifest is immutable. This operation is idempotent. + """Creates or updates a namespace. Once created, this namespace's + resource manifest is immutable. This operation is idempotent. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param parameters: Parameters supplied to create a Namespace Resource. + :param parameters: Parameters for creating a namespace resource. :type parameters: :class:`NamespaceCreateOrUpdateParameters ` :param dict custom_headers: headers that will be added to the request @@ -264,9 +264,10 @@ def delete( """Deletes an existing namespace. This operation also removes all associated resources under the namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str - :param namespace_name: The namespace name. + :param namespace_name: The name of the namespace to delete. :type namespace_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -339,11 +340,12 @@ def get_long_running_output(response): def get( self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config): - """Returns the description for the specified namespace. + """Gets the description of the specified namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str - :param namespace_name: The namespace name. + :param namespace_name: The name of the specified namespace. :type namespace_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -401,11 +403,12 @@ def get( def list_authorization_rules( self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config): - """Authorization rules for a namespace. + """Gets a list of authorization rules for a namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str - :param namespace_name: The namespace name + :param namespace_name: The namespace name. :type namespace_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -470,13 +473,14 @@ def internal_paging(next_link=None, raw=False): def create_or_update_authorization_rule( self, resource_group_name, namespace_name, authorization_rule_name, parameters, custom_headers=None, raw=False, **operation_config): - """Creates an authorization rule for a namespace. + """Creates or updates an authorization rule for a namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param authorization_rule_name: Namespace Aauthorization Rule Name. + :param authorization_rule_name: Namespace authorization rule name. :type authorization_rule_name: str :param parameters: The shared access authorization rule. :type parameters: @@ -543,13 +547,14 @@ def create_or_update_authorization_rule( def delete_authorization_rule( self, resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Deletes a namespace authorization rule. + """Deletes an authorization rule for a namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param authorization_rule_name: Authorization Rule Name. + :param authorization_rule_name: Authorization rule name. :type authorization_rule_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -600,11 +605,12 @@ def delete_authorization_rule( def get_authorization_rule( self, resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Authorization rule for a namespace by name. + """Gets an authorization rule for a namespace by rule name. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str - :param namespace_name: The namespace name + :param namespace_name: The namespace name. :type namespace_name: str :param authorization_rule_name: Authorization rule name. :type authorization_rule_name: str @@ -665,13 +671,14 @@ def get_authorization_rule( def list_keys( self, resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config): - """Primary and Secondary ConnectionStrings to the namespace . + """Gets the primary and secondary connection strings for the namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param authorization_rule_name: The authorizationRule name. + :param authorization_rule_name: The authorization rule name. :type authorization_rule_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -730,16 +737,17 @@ def list_keys( def regenerate_keys( self, resource_group_name, namespace_name, authorization_rule_name, policykey=None, custom_headers=None, raw=False, **operation_config): - """Regenerats the Primary or Secondary ConnectionStrings to the namespace - . + """Regenerates the primary or secondary connection strings for the + specified namespace. - :param resource_group_name: The name of the resource group. + :param resource_group_name: The name of the resource group in which + the namespace lives. :type resource_group_name: str :param namespace_name: The namespace name. :type namespace_name: str - :param authorization_rule_name: The authorizationRule name. + :param authorization_rule_name: The authorization rule name. :type authorization_rule_name: str - :param policykey: Key that needs to be regenerated . Possible values + :param policykey: Key that needs to be regenerated. Possible values include: 'PrimaryKey', 'SecondaryKey' :type policykey: str or :class:`Policykey `