azure.mgmt.servicebus.operations module

class azure.mgmt.servicebus.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

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: “2017-04-01”.

list(custom_headers=None, raw=False, **operation_config)

Lists all of the available ServiceBus REST API operations.

Parameters

• 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 Operation

Return type

OperationPaged[Operation]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

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

Bases: object

NamespacesOperations operations.

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: “2017-04-01”.

check_name_availability_method(name, custom_headers=None, raw=False, **operation_config)

Check the give namespace name availability.

Parameters

• name (str) – The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

• 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

CheckNameAvailabilityResult or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResult or ClientRawResponse

Raises

ErrorResponseException

create_or_update(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates or updates a service 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 (SBNamespace) – Parameters supplied to create 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 SBNamespace or ClientRawResponse<SBNamespace> if raw==True

Return type

AzureOperationPoller[SBNamespace] or AzureOperationPoller[ClientRawResponse[SBNamespace]]

Raises

ErrorResponseException

create_or_update_authorization_rule(resource_group_name, namespace_name, authorization_rule_name, rights, custom_headers=None, raw=False, **operation_config)

Creates or updates an authorization rule 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.

• rights (list[str or AccessRights]) – The rights associated with the rule.

• 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

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

create_or_update_network_rule_set(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config)

Create or update NetworkRuleSet for a Namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• parameters (NetworkRuleSet) – The Namespace IpFilterRule.

• 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

NetworkRuleSet or ClientRawResponse if raw=true

Return type

NetworkRuleSet or ClientRawResponse

Raises

ErrorResponseException

delete(resource_group_name, namespace_name, custom_headers=None, raw=False, polling=True, **operation_config)

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

ErrorResponseException

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

Deletes a namespace authorization rule.

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

ErrorResponseException

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

Gets a description for 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

SBNamespace or ClientRawResponse if raw=true

Return type

SBNamespace or ClientRawResponse

Raises

ErrorResponseException

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

Gets an authorization rule 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

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

get_network_rule_set(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

Gets NetworkRuleSet 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

NetworkRuleSet or ClientRawResponse if raw=true

Return type

NetworkRuleSet or ClientRawResponse

Raises

ErrorResponseException

list(custom_headers=None, raw=False, **operation_config)

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

Parameters

• 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 SBNamespace

Return type

SBNamespacePaged[SBNamespace]

Raises

ErrorResponseException

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

Gets the 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 SBAuthorizationRule

Return type

SBAuthorizationRulePaged[SBAuthorizationRule]

Raises

ErrorResponseException

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

Gets the available namespaces within a resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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 SBNamespace

Return type

SBNamespacePaged[SBNamespace]

Raises

ErrorResponseException

list_keys(resource_group_name, namespace_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config)

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

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

migrate(resource_group_name, namespace_name, target_namespace_type, custom_headers=None, raw=False, **operation_config)

This operation Migrate the given namespace to provided name type.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• target_namespace_type (str or NameSpaceType) – Type of namespaces. Possible values include: ‘Messaging’, ‘NotificationHub’, ‘Mixed’, ‘EventHub’, ‘Relay’

• 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

ErrorResponseException

regenerate_keys(resource_group_name, namespace_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)

Regenerates the primary or 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.

• key_type (str or KeyType) – The access key to regenerate. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’

• key (str) – Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType

• 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

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

update(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config)

Updates a service 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 (SBNamespaceUpdateParameters) – Parameters supplied to update a namespace 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

SBNamespace or ClientRawResponse if raw=true

Return type

SBNamespace or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.DisasterRecoveryConfigsOperations(client, config, serializer, deserializer)

Bases: object

DisasterRecoveryConfigsOperations operations.

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: “2017-04-01”.

break_pairing(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• alias (str) – The Disaster Recovery configuration 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

ErrorResponseException

check_name_availability_method(resource_group_name, namespace_name, name, custom_headers=None, raw=False, **operation_config)

Check the give namespace name availability.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• name (str) – The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

• 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

CheckNameAvailabilityResult or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResult or ClientRawResponse

Raises

ErrorResponseException

create_or_update(resource_group_name, namespace_name, alias, partner_namespace=None, alternate_name=None, custom_headers=None, raw=False, **operation_config)

Creates or updates a new Alias(Disaster Recovery configuration).

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• alias (str) – The Disaster Recovery configuration name

• partner_namespace (str) – ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing

• alternate_name (str) – Primary/Secondary eventhub namespace name, which is part of GEO DR pairing

• 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

ArmDisasterRecovery or ClientRawResponse if raw=true

Return type

ArmDisasterRecovery or ClientRawResponse

Raises

ErrorResponseException

delete(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)

Deletes an Alias(Disaster Recovery configuration).

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• alias (str) – The Disaster Recovery configuration 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

ErrorResponseException

fail_over(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• alias (str) – The Disaster Recovery configuration 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

ErrorResponseException

get(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• alias (str) – The Disaster Recovery configuration 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

ArmDisasterRecovery or ClientRawResponse if raw=true

Return type

ArmDisasterRecovery or ClientRawResponse

Raises

ErrorResponseException

get_authorization_rule(resource_group_name, namespace_name, alias, authorization_rule_name, custom_headers=None, raw=False, **operation_config)

Gets an authorization rule 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

• alias (str) – The Disaster Recovery configuration 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

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

list(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

Gets all Alias(Disaster Recovery configurations).

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 ArmDisasterRecovery

Return type

ArmDisasterRecoveryPaged[ArmDisasterRecovery]

Raises

ErrorResponseException

list_authorization_rules(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)

Gets the 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

• alias (str) – The Disaster Recovery configuration 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 SBAuthorizationRule

Return type

SBAuthorizationRulePaged[SBAuthorizationRule]

Raises

ErrorResponseException

list_keys(resource_group_name, namespace_name, alias, authorization_rule_name, custom_headers=None, raw=False, **operation_config)

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

• alias (str) – The Disaster Recovery configuration 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

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.MigrationConfigsOperations(client, config, serializer, deserializer)

Bases: object

MigrationConfigsOperations operations.

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: “2017-04-01”.

• config_name – The configuration name. Should always be “$default”. Constant value: “$default”.

complete_migration(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.

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

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

create_and_start_migration(resource_group_name, namespace_name, target_namespace, post_migration_name, custom_headers=None, raw=False, polling=True, **operation_config)

Creates Migration configuration and starts migration of entities from Standard to Premium namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• target_namespace (str) – Existing premium Namespace ARM Id name which has no entities, will be used for migration

• post_migration_name (str) – Name to access Standard Namespace after migration

• 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 MigrationConfigProperties or ClientRawResponse<MigrationConfigProperties> if raw==True

Return type

AzureOperationPoller[MigrationConfigProperties] or AzureOperationPoller[ClientRawResponse[MigrationConfigProperties]]

Raises

ErrorResponseException

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

Deletes a MigrationConfiguration.

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

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Retrieves Migration Config.

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

MigrationConfigProperties or ClientRawResponse if raw=true

Return type

MigrationConfigProperties or ClientRawResponse

Raises

ErrorResponseException

list(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

Gets all migrationConfigurations.

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 MigrationConfigProperties

Return type

MigrationConfigPropertiesPaged[MigrationConfigProperties]

Raises

ErrorResponseException

revert(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

This operation reverts Migration.

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

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

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

Bases: object

QueuesOperations operations.

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: “2017-04-01”.

create_or_update(resource_group_name, namespace_name, queue_name, parameters, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• queue_name (str) – The queue name.

• parameters (SBQueue) – 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_config – Operation configuration overrides.

Returns

SBQueue or ClientRawResponse if raw=true

Return type

SBQueue or ClientRawResponse

Raises

ErrorResponseException

create_or_update_authorization_rule(resource_group_name, namespace_name, queue_name, authorization_rule_name, rights, custom_headers=None, raw=False, **operation_config)

Creates an authorization rule for a queue.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• queue_name (str) – The queue name.

• authorization_rule_name (str) – The authorization rule name.

• rights (list[str or AccessRights]) – The rights associated with the rule.

• 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

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

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

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

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Deletes a queue authorization rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Returns a description for the specified queue.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

SBQueue or ClientRawResponse if raw=true

Return type

SBQueue or ClientRawResponse

Raises

ErrorResponseException

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

Gets an authorization rule for a queue by rule name.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

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

Gets all authorization rules for a queue.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

An iterator like instance of SBAuthorizationRule

Return type

SBAuthorizationRulePaged[SBAuthorizationRule]

Raises

ErrorResponseException

list_by_namespace(resource_group_name, namespace_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)

Gets the queues within a namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

• top (int) – May be used to limit the number of results to the most recent N usageDetails.

• 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 SBQueue

Return type

SBQueuePaged[SBQueue]

Raises

ErrorResponseException

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

Primary and secondary connection strings to the queue.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

regenerate_keys(resource_group_name, namespace_name, queue_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)

Regenerates the primary or secondary connection strings to the queue.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• queue_name (str) – The queue name.

• authorization_rule_name (str) – The authorization rule name.

• key_type (str or KeyType) – The access key to regenerate. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’

• key (str) – Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType

• 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

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

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

Bases: object

TopicsOperations operations.

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: “2017-04-01”.

create_or_update(resource_group_name, namespace_name, topic_name, parameters, custom_headers=None, raw=False, **operation_config)

Creates a topic in the specified namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• parameters (SBTopic) – 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_config – Operation configuration overrides.

Returns

SBTopic or ClientRawResponse if raw=true

Return type

SBTopic or ClientRawResponse

Raises

ErrorResponseException

create_or_update_authorization_rule(resource_group_name, namespace_name, topic_name, authorization_rule_name, rights, custom_headers=None, raw=False, **operation_config)

Creates an authorization rule for the specified topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• authorization_rule_name (str) – The authorization rule name.

• rights (list[str or AccessRights]) – The rights associated with the rule.

• 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

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

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

Deletes a topic 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

• 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_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Deletes a topic authorization rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Returns a description for the specified topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

SBTopic or ClientRawResponse if raw=true

Return type

SBTopic or ClientRawResponse

Raises

ErrorResponseException

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

Returns the specified authorization rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

SBAuthorizationRule or ClientRawResponse if raw=true

Return type

SBAuthorizationRule or ClientRawResponse

Raises

ErrorResponseException

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

Gets authorization rules for a topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

An iterator like instance of SBAuthorizationRule

Return type

SBAuthorizationRulePaged[SBAuthorizationRule]

Raises

ErrorResponseException

list_by_namespace(resource_group_name, namespace_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)

Gets all the topics in a namespace.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

• top (int) – May be used to limit the number of results to the most recent N usageDetails.

• 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 SBTopic

Return type

SBTopicPaged[SBTopic]

Raises

ErrorResponseException

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

Gets the primary and secondary connection strings for the topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

regenerate_keys(resource_group_name, namespace_name, topic_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)

Regenerates primary or secondary connection strings for the topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• authorization_rule_name (str) – The authorization rule name.

• key_type (str or KeyType) – The access key to regenerate. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’

• key (str) – Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType

• 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

AccessKeys or ClientRawResponse if raw=true

Return type

AccessKeys or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

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

Bases: object

SubscriptionsOperations operations.

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: “2017-04-01”.

create_or_update(resource_group_name, namespace_name, topic_name, subscription_name, parameters, custom_headers=None, raw=False, **operation_config)

Creates a topic subscription.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• subscription_name (str) – The subscription name.

• parameters (SBSubscription) – 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_config – Operation configuration overrides.

Returns

SBSubscription or ClientRawResponse if raw=true

Return type

SBSubscription or ClientRawResponse

Raises

ErrorResponseException

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

Deletes a subscription from the specified topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

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

Returns a subscription description for the specified topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• 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_config – Operation configuration overrides.

Returns

SBSubscription or ClientRawResponse if raw=true

Return type

SBSubscription or ClientRawResponse

Raises

ErrorResponseException

list_by_topic(resource_group_name, namespace_name, topic_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)

List all the subscriptions under a specified topic.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

• top (int) – May be used to limit the number of results to the most recent N usageDetails.

• 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 SBSubscription

Return type

SBSubscriptionPaged[SBSubscription]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.RulesOperations(client, config, serializer, deserializer)

Bases: object

RulesOperations operations.

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: “2017-04-01”.

create_or_update(resource_group_name, namespace_name, topic_name, subscription_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config)

Creates a new rule and updates an existing rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• subscription_name (str) – The subscription name.

• rule_name (str) – The rule name.

• parameters (Rule) – Parameters supplied to create a rule.

• 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

Rule or ClientRawResponse if raw=true

Return type

Rule or ClientRawResponse

Raises

ErrorResponseException

delete(resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config)

Deletes an existing rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• subscription_name (str) – The subscription name.

• rule_name (str) – The 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

ErrorResponseException

get(resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config)

Retrieves the description for the specified rule.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• subscription_name (str) – The subscription name.

• rule_name (str) – The 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

Rule or ClientRawResponse if raw=true

Return type

Rule or ClientRawResponse

Raises

ErrorResponseException

list_by_subscriptions(resource_group_name, namespace_name, topic_name, subscription_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)

List all the rules within given topic-subscription.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription.

• namespace_name (str) – The namespace name

• topic_name (str) – The topic name.

• subscription_name (str) – The subscription name.

• skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

• top (int) – May be used to limit the number of results to the most recent N usageDetails.

• 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 Rule

Return type

RulePaged[Rule]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.RegionsOperations(client, config, serializer, deserializer)

Bases: object

RegionsOperations operations.

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: “2017-04-01”.

list_by_sku(sku, custom_headers=None, raw=False, **operation_config)

Gets the available Regions for a given sku.

Parameters

• sku (str) – The sku type.

• 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 PremiumMessagingRegions

Return type

PremiumMessagingRegionsPaged[PremiumMessagingRegions]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.PremiumMessagingRegionsOperations(client, config, serializer, deserializer)

Bases: object

PremiumMessagingRegionsOperations operations.

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: “2017-04-01”.

list(custom_headers=None, raw=False, **operation_config)

Gets the available premium messaging regions for servicebus .

Parameters

• 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 PremiumMessagingRegions

Return type

PremiumMessagingRegionsPaged[PremiumMessagingRegions]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>

class azure.mgmt.servicebus.operations.EventHubsOperations(client, config, serializer, deserializer)

Bases: object

EventHubsOperations operations.

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: “2017-04-01”.

list_by_namespace(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)

Gets all the Event Hubs in a service bus 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 Eventhub

Return type

EventhubPaged[Eventhub]

Raises

ErrorResponseException

models = <module 'azure.mgmt.servicebus.models' from '/home/vsts/work/1/s/sdk/servicebus/azure-mgmt-servicebus/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicebus/models/__init__.py'>