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.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_create_or_update |
Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
| begin_delete |
Deletes an existing namespace. This operation also removes all associated resources under the namespace. |
| check_name_availability |
Check the give namespace name availability. |
| create_or_update_authorization_rule |
Creates or updates an authorization rule for a namespace. |
| create_or_update_ip_filter_rule |
Creates or updates an IpFilterRule for a Namespace. |
| create_or_update_network_rule_set |
Gets NetworkRuleSet for a Namespace. |
| create_or_update_virtual_network_rule |
Creates or updates an VirtualNetworkRule for a Namespace. |
| delete_authorization_rule |
Deletes a namespace authorization rule. |
| delete_ip_filter_rule |
Deletes an IpFilterRule for a Namespace. |
| delete_virtual_network_rule |
Deletes an VirtualNetworkRule for a Namespace. |
| get |
Gets a description for the specified namespace. |
| get_authorization_rule |
Gets an authorization rule for a namespace by rule name. |
| get_ip_filter_rule |
Gets an IpFilterRule for a Namespace by rule name. |
| get_network_rule_set |
Gets NetworkRuleSet for a Namespace. |
| get_virtual_network_rule |
Gets an VirtualNetworkRule for a Namespace by rule name. |
| list |
Gets all the available namespaces within the subscription, irrespective of the resource groups. |
| list_authorization_rules |
Gets the authorization rules for a namespace. |
| list_by_resource_group |
Gets the available namespaces within a resource group. |
| list_ip_filter_rules |
Gets a list of IP Filter rules for a Namespace. |
| list_keys |
Gets the primary and secondary connection strings for the namespace. |
| list_virtual_network_rules |
Gets a list of VirtualNetwork rules for a Namespace. |
| migrate |
This operation Migrate the given namespace to provided name type. |
| regenerate_keys |
Regenerates the primary or secondary connection strings for the namespace. |
| update |
Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
begin_create_or_update
Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
async begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespace, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespace]Parameters
- parameters
- <xref:azure.mgmt.servicebus.models.SBNamespace>
Parameters supplied to create a namespace resource.
- 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 SBNamespace or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes an existing namespace. This operation also removes all associated resources under the namespace.
async begin_delete(resource_group_name: str, namespace_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[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 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
Exceptions
check_name_availability
Check the give namespace name availability.
async check_name_availability(parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.CheckNameAvailability, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.CheckNameAvailabilityResultParameters
- parameters
- <xref:azure.mgmt.servicebus.models.CheckNameAvailability>
Parameters to check availability of the given namespace name.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CheckNameAvailabilityResult, or the result of cls(response)
Return type
Exceptions
create_or_update_authorization_rule
Creates or updates 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.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleParameters
- parameters
- <xref:azure.mgmt.servicebus.models.SBAuthorizationRule>
The shared access authorization rule.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SBAuthorizationRule, or the result of cls(response)
Return type
Exceptions
create_or_update_ip_filter_rule
Creates or updates an IpFilterRule for a Namespace.
async create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: _models.IpFilterRule, **kwargs) -> _models.IpFilterRuleParameters
- parameters
- <xref:azure.mgmt.servicebus.models.IpFilterRule>
The Namespace IpFilterRule.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IpFilterRule, or the result of cls(response)
Return type
Exceptions
create_or_update_network_rule_set
Gets NetworkRuleSet for a Namespace.
async create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.NetworkRuleSet, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.NetworkRuleSetParameters
- parameters
- <xref:azure.mgmt.servicebus.models.NetworkRuleSet>
The Namespace NetworkRuleSet.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NetworkRuleSet, or the result of cls(response)
Return type
Exceptions
create_or_update_virtual_network_rule
Creates or updates an VirtualNetworkRule for a Namespace.
async create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, **kwargs) -> _models.VirtualNetworkRuleParameters
- parameters
- <xref:azure.mgmt.servicebus.models.VirtualNetworkRule>
The Namespace VirtualNetworkRule.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
VirtualNetworkRule, or the result of cls(response)
Return type
Exceptions
delete_authorization_rule
Deletes a namespace authorization rule.
async delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> 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
delete_ip_filter_rule
Deletes an IpFilterRule for a Namespace.
async delete_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs) -> 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
delete_virtual_network_rule
Deletes an VirtualNetworkRule for a Namespace.
async delete_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs) -> 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
Gets a description for the specified namespace.
async get(resource_group_name: str, namespace_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespaceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SBNamespace, or the result of cls(response)
Return type
Exceptions
get_authorization_rule
Gets an authorization rule for a namespace by rule name.
async get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SBAuthorizationRule, or the result of cls(response)
Return type
Exceptions
get_ip_filter_rule
Gets an IpFilterRule for a Namespace by rule name.
async get_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs) -> _models.IpFilterRuleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IpFilterRule, or the result of cls(response)
Return type
Exceptions
get_network_rule_set
Gets NetworkRuleSet for a Namespace.
async get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.NetworkRuleSetParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NetworkRuleSet, or the result of cls(response)
Return type
Exceptions
get_virtual_network_rule
Gets an VirtualNetworkRule for a Namespace by rule name.
async get_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs) -> _models.VirtualNetworkRuleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
VirtualNetworkRule, or the result of cls(response)
Return type
Exceptions
list
Gets all the available namespaces within the subscription, irrespective of the resource groups.
list(**kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SBNamespaceListResult 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) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SBAuthorizationRuleListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Gets the available namespaces within a resource group.
list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SBNamespaceListResult or the result of cls(response)
Return type
Exceptions
list_ip_filter_rules
Gets a list of IP Filter rules for a Namespace.
list_ip_filter_rules(resource_group_name: str, namespace_name: str, **kwargs) -> AsyncIterable[_models.IpFilterRuleListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either IpFilterRuleListResult or the result of cls(response)
Return type
Exceptions
list_keys
Gets the primary and secondary connection strings for the namespace.
async list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AccessKeys, or the result of cls(response)
Return type
Exceptions
list_virtual_network_rules
Gets a list of VirtualNetwork rules for a Namespace.
list_virtual_network_rules(resource_group_name: str, namespace_name: str, **kwargs) -> AsyncIterable[_models.VirtualNetworkRuleListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either VirtualNetworkRuleListResult or the result of cls(response)
Return type
Exceptions
migrate
This operation Migrate the given namespace to provided name type.
async migrate(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespaceMigrate, **kwargs) -> NoneParameters
- parameters
- <xref:azure.mgmt.servicebus.models.SBNamespaceMigrate>
Parameters supplied to migrate namespace type.
- 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
regenerate_keys
Regenerates the primary or secondary connection strings for the namespace.
async regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.RegenerateAccessKeyParameters, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeysParameters
- parameters
- <xref:azure.mgmt.servicebus.models.RegenerateAccessKeyParameters>
Parameters supplied to regenerate the authorization rule.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AccessKeys, or the result of cls(response)
Return type
Exceptions
update
Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
async update(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespaceUpdateParameters, **kwargs) -> Optional[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBNamespace]Parameters
- parameters
- <xref:azure.mgmt.servicebus.models.SBNamespaceUpdateParameters>
Parameters supplied to update a namespace resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SBNamespace, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.servicebus.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\servicebus\\models.py'>Feedback
Submit and view feedback for