NamespacesOperations Class
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.objectNamespacesOperations
Constructor
NamespacesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
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.
begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- 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
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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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: _models.CheckAvailabilityParameters, **kwargs: Any) -> _models.CheckAvailabilityResultParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CheckAvailabilityResult, or the result of cls(response)
Return type
Exceptions
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: _models.NamespaceCreateOrUpdateParameters, **kwargs: Any) -> _models.NamespaceResourceParameters
- parameters
- NamespaceCreateOrUpdateParameters
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
Exceptions
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: _models.SharedAccessAuthorizationRuleCreateOrUpdateParameters, **kwargs: Any) -> _models.SharedAccessAuthorizationRuleResourceParameters
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
Exceptions
delete_authorization_rule
Deletes a namespace authorization rule.
delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Returns the description for the specified namespace.
get(resource_group_name: str, namespace_name: str, **kwargs: Any) -> _models.NamespaceResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NamespaceResource, or the result of cls(response)
Return type
Exceptions
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) -> _models.SharedAccessAuthorizationRuleResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SharedAccessAuthorizationRuleResource, or the result of cls(response)
Return type
Exceptions
list
Lists the available namespaces within a resourceGroup.
list(resource_group_name: str, **kwargs: Any) -> Iterable[_models.NamespaceListResult]Parameters
- resource_group_name
- str
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
Exceptions
list_all
Lists all the available namespaces within the subscription irrespective of the resourceGroups.
list_all(**kwargs: Any) -> Iterable[_models.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
Exceptions
list_authorization_rules
Gets the authorization rules for a namespace.
list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[_models.SharedAccessAuthorizationRuleListResult]Parameters
- 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
Exceptions
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) -> _models.SharedAccessAuthorizationRuleListResultParameters
- authorization_rule_name
- str
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
Exceptions
patch
Patches the existing namespace.
patch(resource_group_name: str, namespace_name: str, parameters: _models.NamespacePatchParameters, **kwargs: Any) -> _models.NamespaceResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NamespaceResource, or the result of cls(response)
Return type
Exceptions
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: _models.PolicykeyResource, **kwargs: Any) -> _models.ResourceListKeysParameters
- authorization_rule_name
- str
The connection string of the namespace for the specified authorizationRule.
- parameters
- PolicykeyResource
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
Exceptions
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'>Feedback
Submit and view feedback for