azure.mgmt.eventhub.v2015_08_01.operations module¶
-
class
azure.mgmt.eventhub.v2015_08_01.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API Version. Constant value: “2015-08-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available Event Hub REST API operations.
Parameters: Returns: An iterator like instance of Operation
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
class
azure.mgmt.eventhub.v2015_08_01.operations.
NamespacesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
NamespacesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API Version. Constant value: “2015-08-01”.
-
check_name_availability
(name, custom_headers=None, raw=False, **operation_config)[source]¶ Check the give Namespace name availability.
Parameters: Returns: CheckNameAvailabilityResult or ClientRawResponse if raw=true
Return type: CheckNameAvailabilityResult or ClientRawResponse
Raises: CloudError
-
create_or_update
(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a namespace. Once created, this namespace’s resource manifest is immutable. This operation is idempotent.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- parameters (NamespaceCreateOrUpdateParameters) – Parameters for creating a namespace resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns NamespaceResource or ClientRawResponse<NamespaceResource> if raw==True
Return type: AzureOperationPoller[NamespaceResource] or AzureOperationPoller[ClientRawResponse[NamespaceResource]]
Raises: CloudError
Creates or updates an AuthorizationRule for a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- authorization_rule_name (str) – The authorization rule name.
- parameters (SharedAccessAuthorizationRuleCreateOrUpdateParameters) – The shared access AuthorizationRule.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SharedAccessAuthorizationRuleResource or ClientRawResponse if raw=true
Return type: SharedAccessAuthorizationRuleResource or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, namespace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
Deletes an AuthorizationRule for a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the description of the specified namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: NamespaceResource or ClientRawResponse if raw=true
Return type: NamespaceResource or ClientRawResponse
Raises: CloudError
Gets an AuthorizationRule for a Namespace by rule name.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SharedAccessAuthorizationRuleResource or ClientRawResponse if raw=true
Return type: SharedAccessAuthorizationRuleResource or ClientRawResponse
Raises: CloudError
Gets a list of authorization rules for a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of SharedAccessAuthorizationRuleResource
Return type: SharedAccessAuthorizationRuleResourcePaged[SharedAccessAuthorizationRuleResource]
Raises: CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the available Namespaces within a resource group.
Parameters: Returns: An iterator like instance of NamespaceResource
Return type: Raises: CloudError
-
list_by_subscription
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the available Namespaces within a subscription, irrespective of the resource groups.
Parameters: Returns: An iterator like instance of NamespaceResource
Return type: Raises: CloudError
-
list_keys
(resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the primary and secondary connection strings for the Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ResourceListKeys or ClientRawResponse if raw=true
Return type: ResourceListKeys or ClientRawResponse
Raises: CloudError
-
regenerate_keys
(resource_group_name, namespace_name, authorization_rule_name, policykey=None, custom_headers=None, raw=False, **operation_config)[source]¶ Regenerates the primary or secondary connection strings for the specified Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- authorization_rule_name (str) – The authorization rule name.
- policykey (str or Policykey) – Key that needs to be regenerated. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ResourceListKeys or ClientRawResponse if raw=true
Return type: ResourceListKeys or ClientRawResponse
Raises: CloudError
-
update
(resource_group_name, namespace_name, tags=None, sku=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a namespace. Once created, this namespace’s resource manifest is immutable. This operation is idempotent.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- tags (dict[str, str]) – Resource tags
- sku (Sku) – The sku of the created Namespace
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: NamespaceResource or ClientRawResponse if raw=true
Return type: NamespaceResource or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
class
azure.mgmt.eventhub.v2015_08_01.operations.
EventHubsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
EventHubsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API Version. Constant value: “2015-08-01”.
-
create_or_update
(resource_group_name, namespace_name, event_hub_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a new Event Hub as a nested resource within a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- parameters (EventHubCreateOrUpdateParameters) – Parameters supplied to create an Event Hub resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EventHubResource or ClientRawResponse if raw=true
Return type: EventHubResource or ClientRawResponse
Raises: CloudError
Creates or updates an AuthorizationRule for the specified Event Hub.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- parameters (SharedAccessAuthorizationRuleCreateOrUpdateParameters) – The shared access AuthorizationRule.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SharedAccessAuthorizationRuleResource or ClientRawResponse if raw=true
Return type: SharedAccessAuthorizationRuleResource or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an Event Hub from the specified Namespace and resource group.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
Deletes an Event Hub AuthorizationRule.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an Event Hubs description for the specified Event Hub.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EventHubResource or ClientRawResponse if raw=true
Return type: EventHubResource or ClientRawResponse
Raises: CloudError
Gets an AuthorizationRule for an Event Hub by rule name.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SharedAccessAuthorizationRuleResource or ClientRawResponse if raw=true
Return type: SharedAccessAuthorizationRuleResource or ClientRawResponse
Raises: CloudError
-
list_all
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all the Event Hubs in a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of EventHubResource
Return type: Raises: CloudError
Gets the authorization rules for an Event Hub.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of SharedAccessAuthorizationRuleResource
Return type: SharedAccessAuthorizationRuleResourcePaged[SharedAccessAuthorizationRuleResource]
Raises: CloudError
-
list_keys
(resource_group_name, namespace_name, event_hub_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the ACS and SAS connection strings for the Event Hub.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ResourceListKeys or ClientRawResponse if raw=true
Return type: ResourceListKeys or ClientRawResponse
Raises: CloudError
Gets an AuthorizationRule for an Event Hub by rule name.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SharedAccessAuthorizationRuleResource or ClientRawResponse if raw=true
Return type: SharedAccessAuthorizationRuleResource or ClientRawResponse
Raises: CloudError
-
regenerate_keys
(resource_group_name, namespace_name, event_hub_name, authorization_rule_name, policykey=None, custom_headers=None, raw=False, **operation_config)[source]¶ Regenerates the ACS and SAS connection strings for the Event Hub.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- authorization_rule_name (str) – The authorization rule name.
- policykey (str or Policykey) – Key that needs to be regenerated. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ResourceListKeys or ClientRawResponse if raw=true
Return type: ResourceListKeys or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
class
azure.mgmt.eventhub.v2015_08_01.operations.
ConsumerGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ConsumerGroupsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client API Version. Constant value: “2015-08-01”.
-
create_or_update
(resource_group_name, namespace_name, event_hub_name, consumer_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- consumer_group_name (str) – The consumer group name
- parameters (ConsumerGroupCreateOrUpdateParameters) – Parameters supplied to create or update a consumer group resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ConsumerGroupResource or ClientRawResponse if raw=true
Return type: ConsumerGroupResource or ClientRawResponse
Raises: CloudError
-
delete
(resource_group_name, namespace_name, event_hub_name, consumer_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a consumer group from the specified Event Hub and resource group.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- consumer_group_name (str) – The consumer group name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, namespace_name, event_hub_name, consumer_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a description for the specified consumer group.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- consumer_group_name (str) – The consumer group name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ConsumerGroupResource or ClientRawResponse if raw=true
Return type: ConsumerGroupResource or ClientRawResponse
Raises: CloudError
-
list_all
(resource_group_name, namespace_name, event_hub_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
Parameters: - resource_group_name (str) – Name of the resource group within the azure subscription.
- namespace_name (str) – The Namespace name
- event_hub_name (str) – The Event Hub name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ConsumerGroupResource
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶