Share via

NamespacesOperations Class

  • Reference

NamespacesOperations 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

Name Description
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

Name Description
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.

begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.

Keyword-Only Parameters

Name Description
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 PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

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

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
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.

check_availability(parameters: CheckAvailabilityParameters, **kwargs: Any) -> CheckAvailabilityResult

Parameters

Name Description
parameters
Required
CheckAvailabilityParameters

The namespace name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
CheckAvailabilityResult

CheckAvailabilityResult, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

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

create_or_update(resource_group_name: str, namespace_name: str, parameters: NamespaceCreateOrUpdateParameters, **kwargs: Any) -> NamespaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
parameters
Required
NamespaceCreateOrUpdateParameters

Parameters supplied to create a Namespace Resource.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
NamespaceResource

NamespaceResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update_authorization_rule

Creates an authorization rule for a namespace.

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, **kwargs: Any) -> SharedAccessAuthorizationRuleResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
authorization_rule_name
Required
str

Authorization Rule Name.
parameters
Required
SharedAccessAuthorizationRuleCreateOrUpdateParameters

The shared access authorization rule.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
SharedAccessAuthorizationRuleResource

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete_authorization_rule

Deletes a namespace authorization rule.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
authorization_rule_name
Required
str

Authorization Rule Name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
None

None, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Returns the description for the specified namespace.

get(resource_group_name: str, namespace_name: str, **kwargs: Any) -> NamespaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
NamespaceResource

NamespaceResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_authorization_rule

Gets an authorization rule for a namespace by name.

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) -> SharedAccessAuthorizationRuleResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
authorization_rule_name
Required
str

Authorization rule name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
SharedAccessAuthorizationRuleResource

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists the available namespaces within a resourceGroup.

list(resource_group_name: str, **kwargs: Any) -> Iterable[NamespaceListResult]

Parameters

Name Description
resource_group_name
Required
str

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[NamespaceListResult]

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

Exceptions

Type Description
HttpResponseError

list_all

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

list_all(**kwargs: Any) -> Iterable[NamespaceListResult]

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[NamespaceListResult]

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

Exceptions

Type Description
HttpResponseError

list_authorization_rules

Gets the authorization rules for a namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[SharedAccessAuthorizationRuleListResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[SharedAccessAuthorizationRuleListResult]

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

Exceptions

Type Description
HttpResponseError

list_keys

Gets the Primary and Secondary ConnectionStrings to the namespace.

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) -> ResourceListKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
authorization_rule_name
Required
str

The connection string of the namespace for the specified authorizationRule.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ResourceListKeys

ResourceListKeys, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

patch

Patches the existing namespace.

patch(resource_group_name: str, namespace_name: str, parameters: NamespacePatchParameters, **kwargs: Any) -> NamespaceResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
parameters
Required
NamespacePatchParameters

Parameters supplied to patch a Namespace Resource.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
NamespaceResource

NamespaceResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

regenerate_keys

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

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: PolicykeyResource, **kwargs: Any) -> ResourceListKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
namespace_name
Required
str

The namespace name.
authorization_rule_name
Required
str

The connection string of the namespace for the specified authorizationRule.
parameters
Required
PolicykeyResource

Parameters supplied to regenerate the Namespace Authorization Rule Key.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ResourceListKeys

ResourceListKeys, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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