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_create_or_update |
Create Azure Relay namespace. |
| begin_delete |
Deletes an existing namespace. This operation also removes all associated resources under the namespace. |
| check_name_availability |
Check the specified namespace name availability. |
| create_or_update_authorization_rule |
Creates or updates 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 |
Authorization rule for a namespace by name. |
| list |
Lists all the available namespaces within the subscription regardless of the resourceGroups. |
| list_authorization_rules |
Authorization rules for a namespace. |
| list_by_resource_group |
Lists all the available namespaces within the ResourceGroup. |
| list_keys |
Primary and secondary connection strings to the namespace. |
| regenerate_keys |
Regenerates the primary or secondary connection strings to the namespace. |
| update |
Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
begin_create_or_update
Create Azure Relay namespace.
begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: _models.RelayNamespace, **kwargs: Any) -> LROPoller[_models.RelayNamespace]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
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
An instance of LROPoller that returns either RelayNamespace 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.
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
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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
check_name_availability
Check the specified namespace name availability.
check_name_availability(parameters: _models.CheckNameAvailability, **kwargs: Any) -> _models.CheckNameAvailabilityResultParameters
- parameters
- CheckNameAvailability
Parameters to check availability of the specified 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.
create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, **kwargs: Any) -> _models.AuthorizationRuleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AuthorizationRule, 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.RelayNamespaceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RelayNamespace, or the result of cls(response)
Return type
Exceptions
get_authorization_rule
Authorization rule for a namespace by name.
get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) -> _models.AuthorizationRuleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AuthorizationRule, or the result of cls(response)
Return type
Exceptions
list
Lists all the available namespaces within the subscription regardless of the resourceGroups.
list(**kwargs: Any) -> Iterable[_models.RelayNamespaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RelayNamespaceListResult or the result of cls(response)
Return type
Exceptions
list_authorization_rules
Authorization rules for a namespace.
list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[_models.AuthorizationRuleListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AuthorizationRuleListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Lists all the available namespaces within the ResourceGroup.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.RelayNamespaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RelayNamespaceListResult or the result of cls(response)
Return type
Exceptions
list_keys
Primary and secondary connection strings to the namespace.
list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) -> _models.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
regenerate_keys
Regenerates the primary or secondary connection strings to the namespace.
regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, **kwargs: Any) -> _models.AccessKeysParameters
- parameters
- RegenerateAccessKeyParameters
Parameters supplied to regenerate 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
Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
update(resource_group_name: str, namespace_name: str, parameters: _models.RelayUpdateParameters, **kwargs: Any) -> _models.RelayNamespaceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RelayNamespace, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.relay.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\relay\\models\\__init__.py'>Feedback
Submit and view feedback for