NamespacesOperations Class

NamespacesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

NamespacesOperations

Constructor

NamespacesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_delete	Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
check_availability	Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.
create_or_update	Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
create_or_update_authorization_rule	Creates an authorization rule for a namespace.
delete_authorization_rule	Deletes a namespace authorization rule.
get	Returns the description for the specified namespace.
get_authorization_rule	Gets an authorization rule for a namespace by name.
list	Lists the available namespaces within a resourceGroup.
list_all	Lists all the available namespaces within the subscription irrespective of the resourceGroups.
list_authorization_rules	Gets the authorization rules for a namespace.
list_keys	Gets the Primary and Secondary ConnectionStrings to the namespace.
patch	Patches the existing namespace.
regenerate_keys	Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.

begin_delete

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

async begin_delete(resource_group_name: str, namespace_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

check_availability

Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

async check_availability(parameters: azure.mgmt.notificationhubs.models._models_py3.CheckAvailabilityParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.CheckAvailabilityResult

Parameters

parameters

CheckAvailabilityParameters

Required

The namespace name.

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckAvailabilityResult, or the result of cls(response)

Return type

CheckAvailabilityResult

Exceptions

HttpResponseError

create_or_update

Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

async create_or_update(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.NamespaceCreateOrUpdateParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NamespaceResource

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

parameters

NamespaceCreateOrUpdateParameters

Required

Parameters supplied to create a Namespace Resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

NamespaceResource, or the result of cls(response)

Return type

NamespaceResource

Exceptions

HttpResponseError

create_or_update_authorization_rule

Creates an authorization rule for a namespace.

async create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleCreateOrUpdateParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleResource

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

authorization_rule_name

str

Required

Authorization Rule Name.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

Required

The shared access authorization rule.

cls

callable

A custom type or function that will be passed the direct response

Returns

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

Exceptions

HttpResponseError

delete_authorization_rule

Deletes a namespace authorization rule.

async delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

authorization_rule_name

str

Required

Authorization Rule Name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Returns the description for the specified namespace.

async get(resource_group_name: str, namespace_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NamespaceResource

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

cls

callable

A custom type or function that will be passed the direct response

Returns

NamespaceResource, or the result of cls(response)

Return type

NamespaceResource

Exceptions

HttpResponseError

get_authorization_rule

Gets an authorization rule for a namespace by name.

async get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleResource

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

authorization_rule_name

str

Required

Authorization rule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

Exceptions

HttpResponseError

list

Lists the available namespaces within a resourceGroup.

list(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.notificationhubs.models._models_py3.NamespaceListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NamespaceListResult or the result of cls(response)

Return type

AsyncItemPaged[NamespaceListResult]

Exceptions

HttpResponseError

list_all

Lists all the available namespaces within the subscription irrespective of the resourceGroups.

list_all(**kwargs) -> AsyncIterable[azure.mgmt.notificationhubs.models._models_py3.NamespaceListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NamespaceListResult or the result of cls(response)

Return type

AsyncItemPaged[NamespaceListResult]

Exceptions

HttpResponseError

list_authorization_rules

Gets the authorization rules for a namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs) -> AsyncIterable[azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SharedAccessAuthorizationRuleListResult or the result of cls(response)

Return type

AsyncItemPaged[SharedAccessAuthorizationRuleListResult]

Exceptions

HttpResponseError

list_keys

Gets the Primary and Secondary ConnectionStrings to the namespace.

async list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleListResult

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

authorization_rule_name

str

Required

The connection string of the namespace for the specified authorizationRule.

cls

callable

A custom type or function that will be passed the direct response

Returns

SharedAccessAuthorizationRuleListResult, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleListResult

Exceptions

HttpResponseError

patch

Patches the existing namespace.

async patch(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.NamespacePatchParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NamespaceResource

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

parameters

NamespacePatchParameters

Required

Parameters supplied to patch a Namespace Resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

NamespaceResource, or the result of cls(response)

Return type

NamespaceResource

Exceptions

HttpResponseError

regenerate_keys

Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.

async regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.PolicykeyResource, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.ResourceListKeys

Parameters

resource_group_name

str

Required

The name of the resource group.

namespace_name

str

Required

The namespace name.

authorization_rule_name

str

Required

The connection string of the namespace for the specified authorizationRule.

parameters

PolicykeyResource

Required

Parameters supplied to regenerate the Namespace Authorization Rule Key.

cls

callable

A custom type or function that will be passed the direct response

Returns

ResourceListKeys, or the result of cls(response)

Return type

ResourceListKeys

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.notificationhubs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\notificationhubs\\models\\__init__.py'>