azure.mgmt.servicebus.operations module¶
-
class
azure.mgmt.servicebus.operations.
Operations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
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 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)[source]¶ Check the give namespace name availability.
Parameters: - name (str) – The Name to check the namespce 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:
-
create_or_update
(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, polling=True, **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) – 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:
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 authorizationrule 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:
-
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:
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 authorizationrule 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:
-
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) – 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:
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 authorizationrule 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:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
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: Raises:
-
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) – 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: Raises:
-
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 authorizationrule 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:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
regenerate_keys
(resource_group_name, namespace_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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 authorizationrule 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:
-
update
(resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
class
azure.mgmt.servicebus.operations.
DisasterRecoveryConfigsOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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:
-
check_name_availability_method
(resource_group_name, namespace_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ 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 namespce 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:
-
create_or_update
(resource_group_name, namespace_name, alias, partner_namespace=None, alternate_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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 pairning
- alternate_name (str) – Primary/Secondary eventhub namespace name, which is part of GEO DR pairning
- 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:
-
delete
(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
fail_over
(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)[source]¶ envokes 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:
-
get
(resource_group_name, namespace_name, alias, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
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 authorizationrule 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:
-
list
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
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: Raises:
-
list_keys
(resource_group_name, namespace_name, alias, 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
- alias (str) – The Disaster Recovery configuration name
- authorization_rule_name (str) – The authorizationrule 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:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
class
azure.mgmt.servicebus.operations.
MigrationConfigsOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any enties 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:
-
create_and_start_migration
(resource_group_name, namespace_name, target_namespace, post_migration_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates Migration configuration and starts migration of enties 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:
-
delete
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
get
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
list
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
revert
(resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
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 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)[source]¶ 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:
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 authorizationrule 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:
-
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) – 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:
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 authorizationrule 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:
-
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) – 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:
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 authorizationrule 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:
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: Raises:
-
list_by_namespace
(resource_group_name, namespace_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
-
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) – 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 authorizationrule 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:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
regenerate_keys
(resource_group_name, namespace_name, queue_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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 authorizationrule 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:
-
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 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)[source]¶ 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:
Creates an authorizatio 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 authorizationrule 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:
-
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) – 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:
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 authorizationrule 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:
-
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) – 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:
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 authorizationrule 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:
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: Raises:
-
list_by_namespace
(resource_group_name, namespace_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
-
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) – 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 authorizationrule 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:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
regenerate_keys
(resource_group_name, namespace_name, topic_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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 authorizationrule 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:
-
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 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)[source]¶ 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:
-
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) – 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:
-
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) – 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:
-
list_by_topic
(resource_group_name, namespace_name, topic_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
class
azure.mgmt.servicebus.operations.
RulesOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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:
-
delete
(resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
get
(resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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:
-
list_by_subscriptions
(resource_group_name, namespace_name, topic_name, subscription_name, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
class
azure.mgmt.servicebus.operations.
RegionsOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
class
azure.mgmt.servicebus.operations.
PremiumMessagingRegionsOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶
-
class
azure.mgmt.servicebus.operations.
EventHubsOperations
(client, config, serializer, deserializer)[source]¶ 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)[source]¶ 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: Raises:
-
models
= <module 'azure.mgmt.servicebus.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/servicebus/models/__init__.py'>¶