azure.mgmt.servicebus.models module

class azure.mgmt.servicebus.models.TrackedResource(location, tags=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

The Resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – The Geo-location where the resource live
  • tags (dict) – Resource tags
class azure.mgmt.servicebus.models.Resource[source]

Bases: msrest.serialization.Model

The Resource definition for other than namespace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.servicebus.models.ResourceNamespacePatch(location=None, tags=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

The Resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
class azure.mgmt.servicebus.models.SBSku(name, tier=None, capacity=None)[source]

Bases: msrest.serialization.Model

SKU of the namespace.

Parameters:
  • name (str or SkuName) – Name of this SKU. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • tier (str or SkuTier) – The billing tier of this particular SKU. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • capacity (int) – The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4.
class azure.mgmt.servicebus.models.SBNamespace(location, tags=None, sku=None)[source]

Bases: azure.mgmt.servicebus.models.tracked_resource.TrackedResource

Description of a namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – Provisioning state of the namespace.
  • created_at (datetime) – The time the namespace was created.
  • updated_at (datetime) – The time the namespace was updated.
  • service_bus_endpoint (str) – Endpoint you can use to perform Service Bus operations.
  • metric_id (str) – Identifier for Azure Insights metrics
Parameters:
  • location (str) – The Geo-location where the resource live
  • tags (dict) – Resource tags
  • sku (SBSku) – Porperties of Sku
class azure.mgmt.servicebus.models.SBNamespaceUpdateParameters(location=None, tags=None, sku=None)[source]

Bases: azure.mgmt.servicebus.models.resource_namespace_patch.ResourceNamespacePatch

Description of a namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – Provisioning state of the namespace.
  • created_at (datetime) – The time the namespace was created.
  • updated_at (datetime) – The time the namespace was updated.
  • service_bus_endpoint (str) – Endpoint you can use to perform Service Bus operations.
  • metric_id (str) – Identifier for Azure Insights metrics
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (SBSku) – Porperties of Sku
class azure.mgmt.servicebus.models.SBAuthorizationRule(rights=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

Description of a namespace authorization rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:

rights (list of str or AccessRights) – The rights associated with the rule.

class azure.mgmt.servicebus.models.AuthorizationRuleProperties(rights)[source]

Bases: msrest.serialization.Model

AuthorizationRule properties.

Parameters:rights (list of str or AccessRights) – The rights associated with the rule.
class azure.mgmt.servicebus.models.AccessKeys[source]

Bases: msrest.serialization.Model

Namespace/ServiceBus Connection String.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • primary_connection_string (str) – Primary connection string of the created namespace authorization rule.
  • secondary_connection_string (str) – Secondary connection string of the created namespace authorization rule.
  • primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.
  • secondary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.
  • key_name (str) – A string that describes the authorization rule.
class azure.mgmt.servicebus.models.RegenerateAccessKeyParameters(key_type, key=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key neeeds to be reset.

Parameters:
  • 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
class azure.mgmt.servicebus.models.MessageCountDetails[source]

Bases: msrest.serialization.Model

Message Count Details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • active_message_count (long) – Number of active messages in the queue, topic, or subscription.
  • dead_letter_message_count (long) – Number of messages that are dead lettered.
  • scheduled_message_count (long) – Number of scheduled messages.
  • transfer_message_count (long) – Number of messages transferred to another queue, topic, or subscription.
  • transfer_dead_letter_message_count (long) – Number of messages transferred into dead letters.
class azure.mgmt.servicebus.models.SBQueue(lock_duration=None, max_size_in_megabytes=None, requires_duplicate_detection=None, requires_session=None, default_message_time_to_live=None, dead_lettering_on_message_expiration=None, duplicate_detection_history_time_window=None, max_delivery_count=None, status=None, auto_delete_on_idle=None, enable_partitioning=None, enable_express=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

Description of queue Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • count_details (MessageCountDetails) – Message Count Details.
  • created_at (datetime) – The exact time the message was created.
  • updated_at (datetime) – The exact time the message was updated.
  • accessed_at (datetime) – Last time a message was sent, or the last time there was a receive request to this queue.
  • size_in_bytes (long) – The size of the queue, in bytes.
  • message_count (long) – The number of messages in the queue.
Parameters:
  • lock_duration (timedelta) – ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
  • max_size_in_megabytes (int) – The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
  • requires_duplicate_detection (bool) – A value indicating if this queue requires duplicate detection.
  • requires_session (bool) – A value that indicates whether the queue supports the concept of sessions.
  • default_message_time_to_live (timedelta) – ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
  • dead_lettering_on_message_expiration (bool) – A value that indicates whether this queue has dead letter support when a message expires.
  • duplicate_detection_history_time_window (timedelta) – ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
  • max_delivery_count (int) – The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
  • status (str or EntityStatus) – Enumerates the possible values for the status of a messaging entity. Possible values include: ‘Active’, ‘Disabled’, ‘Restoring’, ‘SendDisabled’, ‘ReceiveDisabled’, ‘Creating’, ‘Deleting’, ‘Renaming’, ‘Unknown’
  • auto_delete_on_idle (timedelta) – ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
  • enable_partitioning (bool) – A value that indicates whether the queue is to be partitioned across multiple message brokers.
  • enable_express (bool) – A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
class azure.mgmt.servicebus.models.SBTopic(default_message_time_to_live=None, max_size_in_megabytes=None, requires_duplicate_detection=None, duplicate_detection_history_time_window=None, enable_batched_operations=None, status=None, support_ordering=None, auto_delete_on_idle=None, enable_partitioning=None, enable_express=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

Description of topic resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • size_in_bytes (long) – Size of the topic, in bytes.
  • created_at (datetime) – Exact time the message was created.
  • updated_at (datetime) – The exact time the message was updated.
  • accessed_at (datetime) – Last time the message was sent, or a request was received, for this topic.
  • subscription_count (int) – Number of subscriptions.
  • count_details (MessageCountDetails) – Message count deatils
Parameters:
  • default_message_time_to_live (timedelta) – ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
  • max_size_in_megabytes (int) – Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
  • requires_duplicate_detection (bool) – Value indicating if this topic requires duplicate detection.
  • duplicate_detection_history_time_window (timedelta) – ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
  • enable_batched_operations (bool) – Value that indicates whether server-side batched operations are enabled.
  • status (str or EntityStatus) – Enumerates the possible values for the status of a messaging entity. Possible values include: ‘Active’, ‘Disabled’, ‘Restoring’, ‘SendDisabled’, ‘ReceiveDisabled’, ‘Creating’, ‘Deleting’, ‘Renaming’, ‘Unknown’
  • support_ordering (bool) – Value that indicates whether the topic supports ordering.
  • auto_delete_on_idle (timedelta) – ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
  • enable_partitioning (bool) – Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
  • enable_express (bool) – Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
class azure.mgmt.servicebus.models.SBSubscription(lock_duration=None, requires_session=None, default_message_time_to_live=None, dead_lettering_on_message_expiration=None, duplicate_detection_history_time_window=None, max_delivery_count=None, status=None, enable_batched_operations=None, auto_delete_on_idle=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

Description of subscription resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • message_count (long) – Number of messages.
  • created_at (datetime) – Exact time the message was created.
  • accessed_at (datetime) – Last time there was a receive request to this subscription.
  • updated_at (datetime) – The exact time the message was updated.
  • count_details (MessageCountDetails) – Message count details
Parameters:
  • lock_duration (timedelta) – ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
  • requires_session (bool) – Value indicating if a subscription supports the concept of sessions.
  • default_message_time_to_live (timedelta) – ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
  • dead_lettering_on_message_expiration (bool) – Value that indicates whether a subscription has dead letter support when a message expires.
  • duplicate_detection_history_time_window (timedelta) – ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
  • max_delivery_count (int) – Number of maximum deliveries.
  • status (str or EntityStatus) – Enumerates the possible values for the status of a messaging entity. Possible values include: ‘Active’, ‘Disabled’, ‘Restoring’, ‘SendDisabled’, ‘ReceiveDisabled’, ‘Creating’, ‘Deleting’, ‘Renaming’, ‘Unknown’
  • enable_batched_operations (bool) – Value that indicates whether server-side batched operations are enabled.
  • auto_delete_on_idle (timedelta) – ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
class azure.mgmt.servicebus.models.CheckNameAvailability(name)[source]

Bases: msrest.serialization.Model

Description of a Check Name availability request properties.

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.
class azure.mgmt.servicebus.models.CheckNameAvailabilityResult(name_available=None, reason=None)[source]

Bases: msrest.serialization.Model

Description of a Check Name availability request properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

message (str) – The detailed info regarding the reason associated with the namespace.

Parameters:
  • name_available (bool) – Value indicating namespace is availability, true if the namespace is available; otherwise, false.
  • reason (str or UnavailableReason) – The reason for unavailability of a namespace. Possible values include: ‘None’, ‘InvalidName’, ‘SubscriptionIsDisabled’, ‘NameInUse’, ‘NameInLockdown’, ‘TooManyNamespaceInCurrentSubscription’
class azure.mgmt.servicebus.models.OperationDisplay[source]

Bases: msrest.serialization.Model

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • provider (str) – Service provider: Microsoft.ServiceBus
  • resource (str) – Resource on which the operation is performed: Invoice, etc.
  • operation (str) – Operation type: Read, write, delete, etc.
class azure.mgmt.servicebus.models.Operation(display=None)[source]

Bases: msrest.serialization.Model

A ServiceBus REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:name (str) – Operation name: {provider}/{resource}/{operation}
Parameters:display (OperationDisplay) – The object that represents the operation.
class azure.mgmt.servicebus.models.ErrorResponse(code=None, message=None)[source]

Bases: msrest.serialization.Model

Error reponse indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

Parameters:
  • code (str) – Error code.
  • message (str) – Error message indicating why the operation failed.
exception azure.mgmt.servicebus.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.mgmt.servicebus.models.Action(sql_expression=None, compatibility_level=None, requires_preprocessing=True)[source]

Bases: msrest.serialization.Model

Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

Parameters:
  • sql_expression (str) – SQL expression. e.g. MyProperty=’ABC’
  • compatibility_level (int) – This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
  • requires_preprocessing (bool) – Value that indicates whether the rule action requires preprocessing. Default value: True .
class azure.mgmt.servicebus.models.SqlFilter(sql_expression=None, requires_preprocessing=True)[source]

Bases: msrest.serialization.Model

Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:
  • sql_expression (str) – The SQL expression. e.g. MyProperty=’ABC’
  • requires_preprocessing (bool) – Value that indicates whether the rule action requires preprocessing. Default value: True .
Variables:

compatibility_level (int) – This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. Default value: 20 .

class azure.mgmt.servicebus.models.CorrelationFilter(correlation_id=None, message_id=None, to=None, reply_to=None, label=None, session_id=None, reply_to_session_id=None, content_type=None, requires_preprocessing=True)[source]

Bases: msrest.serialization.Model

Represents the correlation filter expression.

Parameters:
  • correlation_id (str) – Identifier of the correlation.
  • message_id (str) – Identifier of the message.
  • to (str) – Address to send to.
  • reply_to (str) – Address of the queue to reply to.
  • label (str) – Application specific label.
  • session_id (str) – Session identifier.
  • reply_to_session_id (str) – Session identifier to reply to.
  • content_type (str) – Content type of the message.
  • requires_preprocessing (bool) – Value that indicates whether the rule action requires preprocessing. Default value: True .
class azure.mgmt.servicebus.models.Rule(action=None, filter_type=None, sql_filter=None, correlation_filter=None)[source]

Bases: azure.mgmt.servicebus.models.resource.Resource

Description of Rule Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • action (Action) – Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
  • filter_type (str or FilterType) – Filter type that is evaluated against a BrokeredMessage. Possible values include: ‘SqlFilter’, ‘CorrelationFilter’
  • sql_filter (SqlFilter) – Properties of sqlFilter
  • correlation_filter (CorrelationFilter) – Properties of correlationFilter
class azure.mgmt.servicebus.models.SqlRuleAction(sql_expression=None, compatibility_level=None, requires_preprocessing=True)[source]

Bases: azure.mgmt.servicebus.models.action.Action

Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage .

Parameters:
  • sql_expression (str) – SQL expression. e.g. MyProperty=’ABC’
  • compatibility_level (int) – This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
  • requires_preprocessing (bool) – Value that indicates whether the rule action requires preprocessing. Default value: True .
class azure.mgmt.servicebus.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.servicebus.models.SBNamespacePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SBNamespace object

class azure.mgmt.servicebus.models.SBAuthorizationRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SBAuthorizationRule object

class azure.mgmt.servicebus.models.SBQueuePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SBQueue object

class azure.mgmt.servicebus.models.SBTopicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SBTopic object

class azure.mgmt.servicebus.models.SBSubscriptionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SBSubscription object

class azure.mgmt.servicebus.models.RulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Rule object

class azure.mgmt.servicebus.models.SkuName[source]

Bases: enum.Enum

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.servicebus.models.SkuTier[source]

Bases: enum.Enum

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.servicebus.models.AccessRights[source]

Bases: enum.Enum

listen = 'Listen'
manage = 'Manage'
send = 'Send'
class azure.mgmt.servicebus.models.KeyType[source]

Bases: enum.Enum

primary_key = 'PrimaryKey'
secondary_key = 'SecondaryKey'
class azure.mgmt.servicebus.models.EntityStatus[source]

Bases: enum.Enum

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
receive_disabled = 'ReceiveDisabled'
renaming = 'Renaming'
restoring = 'Restoring'
send_disabled = 'SendDisabled'
unknown = 'Unknown'
class azure.mgmt.servicebus.models.UnavailableReason[source]

Bases: enum.Enum

invalid_name = 'InvalidName'
name_in_lockdown = 'NameInLockdown'
name_in_use = 'NameInUse'
none = 'None'
subscription_is_disabled = 'SubscriptionIsDisabled'
too_many_namespace_in_current_subscription = 'TooManyNamespaceInCurrentSubscription'
class azure.mgmt.servicebus.models.FilterType[source]

Bases: enum.Enum

correlation_filter = 'CorrelationFilter'
sql_filter = 'SqlFilter'