azure.mgmt.servicebus.operations module

class azure.mgmt.servicebus.operations.NamespacesOperations(client, config, serializer, deserializer)[source]

Bases: object

NamespacesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a service namespace. Once created, this namespace’s resource manifest is immutable. This operation is idempotent.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • parameters (NamespaceCreateOrUpdateParameters) – Parameters supplied to create a namespace resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns NamespaceResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_authorization_rule(resource_group_name, namespace_name, authorization_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates an authorization rule for a namespace.

Parameters:
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_authorization_rule(resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a namespace authorization rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a description for the specified namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

NamespaceResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_authorization_rule(resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an authorization rule for a namespace by rule name.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_authorization_rules(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the authorization rules for a namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResourcePaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the available namespaces within a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NamespaceResourcePaged

Raises:

CloudError

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]

Gets all the available namespaces within the subscription, irrespective of the resource groups.

Parameters:
Return type:

NamespaceResourcePaged

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) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

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 namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.servicebus.operations.QueuesOperations(client, config, serializer, deserializer)[source]

Bases: object

QueuesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, namespace_name, queue_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a Service Bus queue. This operation is idempotent.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue name.
  • parameters (QueueCreateOrUpdateParameters) – Parameters supplied to create or update a queue resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

QueueResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_authorization_rule(resource_group_name, namespace_name, queue_name, authorization_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates an authorization rule for a queue.

Parameters:
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a queue from the specified namespace in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The name of the queue to be deleted.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_authorization_rule(resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a queue authorization rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a description for the specified queue.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

QueueResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_authorization_rule(resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an authorization rule for a queue by rule name.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_all(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the queues within a namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

QueueResourcePaged

Raises:

CloudError

list_authorization_rules(resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all authorization rules for a queue.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name
  • queue_name (str) – The queue name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResourcePaged

Raises:

CloudError

list_keys(resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Primary and secondary connection strings to the queue.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

regenerate_keys(resource_group_name, namespace_name, queue_name, authorization_rule_name, policykey=None, custom_headers=None, raw=False, **operation_config)[source]

Regenerates the primary or secondary connection strings to the queue.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • queue_name (str) – The queue 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.servicebus.operations.TopicsOperations(client, config, serializer, deserializer)[source]

Bases: object

TopicsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, namespace_name, topic_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates a topic in the specified namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • parameters (TopicCreateOrUpdateParameters) – Parameters supplied to create a topic resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

TopicResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_authorization_rule(resource_group_name, namespace_name, topic_name, authorization_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates an authorizatio rule for the specified topic.

Parameters:
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a topic from the specified namespace and resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The name of the topic to delete.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_authorization_rule(resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a topic authorization rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a description for the specified topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

TopicResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_authorization_rule(resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Returns the specified authorization rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • authorization_rule_name (str) – 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_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_all(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all the topics in a namespace.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • 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_configOperation configuration overrides.
Return type:

TopicResourcePaged

Raises:

CloudError

list_authorization_rules(resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config)[source]

Gets authorization rules for a topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SharedAccessAuthorizationRuleResourcePaged

Raises:

CloudError

list_keys(resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the primary and secondary connection strings for the topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

regenerate_keys(resource_group_name, namespace_name, topic_name, authorization_rule_name, policykey=None, custom_headers=None, raw=False, **operation_config)[source]

Regenerates primary or secondary connection strings for the topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic 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_configOperation configuration overrides.
Return type:

ResourceListKeys

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.servicebus.operations.SubscriptionsOperations(client, config, serializer, deserializer)[source]

Bases: object

SubscriptionsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, namespace_name, topic_name, subscription_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates a topic subscription.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • subscription_name (str) – The subscription name.
  • parameters (SubscriptionCreateOrUpdateParameters) – Parameters supplied to create a subscription resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SubscriptionResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, namespace_name, topic_name, subscription_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a subscription from the specified topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • subscription_name (str) – The subscription name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, namespace_name, topic_name, subscription_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a subscription description for the specified topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • subscription_name (str) – The subscription name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SubscriptionResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_all(resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config)[source]

Lsit all the subscriptions under a specified topic.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • namespace_name (str) – The namespace name.
  • topic_name (str) – The topic name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SubscriptionResourcePaged

Raises:

CloudError