azure.servicemanagement.servicebusmanagementservice module

class azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', request_session=None, timeout=65)[source]

Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient

Initializes the service bus management service.

subscription_id:
Subscription to manage.
cert_file:
Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store (winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then this is unused.
host:
Live ServiceClient URL. Defaults to Azure public cloud.
request_session:
Session object to use for http requests. If this is specified, it replaces the default use of httplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The session object handles authentication, and as such can support multiple types of authentication: .pem certificate, oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificate authentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout:
Optional. Timeout for the http request, in seconds.
check_namespace_availability(name)[source]

Checks to see if the specified service bus namespace is available, or if it has already been taken.

name:
Name of the service bus namespace to validate.
create_namespace(name, region)[source]

Create a new service bus namespace.

name:
Name of the service bus namespace to create.
region:
Region to create the namespace in.
delete_namespace(name)[source]

Delete a service bus namespace.

name:
Name of the service bus namespace to delete.
get_metrics_data_notification_hub(name, hub_name, metric, rollup, filter_expresssion)[source]

Retrieves the list of supported metrics for this namespace and topic

name:
Name of the service bus namespace.
hub_name:
Name of the service bus notification hub in this namespace.
metric:
name of a supported metric
rollup:
name of a supported rollup
filter_expression:
filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z’”
get_metrics_data_queue(name, queue_name, metric, rollup, filter_expresssion)[source]

Retrieves the list of supported metrics for this namespace and queue

name:
Name of the service bus namespace.
queue_name:
Name of the service bus queue in this namespace.
metric:
name of a supported metric
rollup:
name of a supported rollup
filter_expression:
filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z’”
get_metrics_data_relay(name, relay_name, metric, rollup, filter_expresssion)[source]

Retrieves the list of supported metrics for this namespace and relay

name:
Name of the service bus namespace.
relay_name:
Name of the service bus relay in this namespace.
metric:
name of a supported metric
rollup:
name of a supported rollup
filter_expression:
filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z’”
get_metrics_data_topic(name, topic_name, metric, rollup, filter_expresssion)[source]

Retrieves the list of supported metrics for this namespace and topic

name:
Name of the service bus namespace.
topic_name:
Name of the service bus queue in this namespace.
metric:
name of a supported metric
rollup:
name of a supported rollup
filter_expression:
filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z’”
get_metrics_rollups_notification_hub(name, hub_name, metric)[source]

This operation gets rollup data for Service Bus metrics notification hub. Rollup data includes the time granularity for the telemetry aggregation as well as the retention settings for each time granularity.

name:
Name of the service bus namespace.
hub_name:
Name of the service bus notification hub in this namespace.
metric:
name of a supported metric
get_metrics_rollups_queue(name, queue_name, metric)[source]

This operation gets rollup data for Service Bus metrics queue. Rollup data includes the time granularity for the telemetry aggregation as well as the retention settings for each time granularity.

name:
Name of the service bus namespace.
queue_name:
Name of the service bus queue in this namespace.
metric:
name of a supported metric
get_metrics_rollups_relay(name, relay_name, metric)[source]

This operation gets rollup data for Service Bus metrics relay. Rollup data includes the time granularity for the telemetry aggregation as well as the retention settings for each time granularity.

name:
Name of the service bus namespace.
relay_name:
Name of the service bus relay in this namespace.
metric:
name of a supported metric
get_metrics_rollups_topic(name, topic_name, metric)[source]

This operation gets rollup data for Service Bus metrics topic. Rollup data includes the time granularity for the telemetry aggregation as well as the retention settings for each time granularity.

name:
Name of the service bus namespace.
topic_name:
Name of the service bus queue in this namespace.
metric:
name of a supported metric
get_namespace(name)[source]

Get details about a specific namespace.

name:
Name of the service bus namespace.
get_regions()[source]

Get list of available service bus regions.

get_supported_metrics_notification_hub(name, hub_name)[source]

Retrieves the list of supported metrics for this namespace and topic

name:
Name of the service bus namespace.
hub_name:
Name of the service bus notification hub in this namespace.
get_supported_metrics_queue(name, queue_name)[source]

Retrieves the list of supported metrics for this namespace and queue

name:
Name of the service bus namespace.
queue_name:
Name of the service bus queue in this namespace.
get_supported_metrics_relay(name, relay_name)[source]

Retrieves the list of supported metrics for this namespace and relay

name:
Name of the service bus namespace.
relay_name:
Name of the service bus relay in this namespace.
get_supported_metrics_topic(name, topic_name)[source]

Retrieves the list of supported metrics for this namespace and topic

name:
Name of the service bus namespace.
topic_name:
Name of the service bus queue in this namespace.
list_namespaces()[source]

List the service bus namespaces defined on the account.

list_notification_hubs(name)[source]

Retrieves the notification hubs in the service namespace.

name:
Name of the service bus namespace.
list_queues(name)[source]

Enumerates the queues in the service namespace.

name:
Name of the service bus namespace.
list_relays(name)[source]

Retrieves the relays in the service namespace.

name:
Name of the service bus namespace.
list_topics(name)[source]

Retrieves the topics in the service namespace.

name:
Name of the service bus namespace.