azure.mgmt.notificationhubs.operations module¶
- class azure.mgmt.notificationhubs.operations.NamespacesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
NotificationHubsManagementClient’snamespacesattribute.- begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: _models.NamespaceResource, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.NamespaceResource][source]¶
- begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.NamespaceResource]
Creates / Updates a Notification Hub namespace. This operation is idempotent.
Creates / Updates a Notification Hub namespace. This operation is idempotent.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
parameters (NamespaceResource or IO[bytes]) – Request content. Is either a NamespaceResource type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either NamespaceResource or the result of cls(response)
- Return type:
- Raises:
- check_availability(parameters: _models.CheckAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckAvailabilityResult[source]¶
- check_availability(parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckAvailabilityResult
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.
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.
- Parameters:
parameters (CheckAvailabilityParameters or IO[bytes]) – Request content. Is either a CheckAvailabilityParameters type or a IO[bytes] type. Required.
- Returns:
CheckAvailabilityResult or the result of cls(response)
- Return type:
- Raises:
- create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.SharedAccessAuthorizationRuleResource, *, content_type: str = 'application/json', **kwargs: Any) _models.SharedAccessAuthorizationRuleResource[source]¶
- create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.SharedAccessAuthorizationRuleResource
Creates an authorization rule for a namespace.
Creates an authorization rule for a namespace.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
authorization_rule_name (str) – Authorization Rule Name. Required.
parameters (SharedAccessAuthorizationRuleResource or IO[bytes]) – Request content. Is either a SharedAccessAuthorizationRuleResource type or a IO[bytes] type. Required.
- Returns:
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, namespace_name: str, **kwargs: Any) None[source]¶
Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) None[source]¶
Deletes a namespace authorization rule.
Deletes a namespace authorization rule.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, namespace_name: str, **kwargs: Any) NamespaceResource[source]¶
Returns the given namespace.
Returns the given namespace.
- Parameters:
- Returns:
NamespaceResource or the result of cls(response)
- Return type:
- Raises:
- get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) SharedAccessAuthorizationRuleResource[source]¶
Gets an authorization rule for a namespace by name.
Gets an authorization rule for a namespace by name.
- Parameters:
- Returns:
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- get_pns_credentials(resource_group_name: str, namespace_name: str, **kwargs: Any) PnsCredentialsResource[source]¶
Lists the PNS credentials associated with a namespace.
Lists the PNS credentials associated with a namespace.
- Parameters:
- Returns:
PnsCredentialsResource or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, skip_token: str | None = None, top: int = 100, **kwargs: Any) Iterable[NamespaceResource][source]¶
Lists the available namespaces within a resource group.
Lists the available namespaces within a resource group.
- Parameters:
- Returns:
An iterator like instance of either NamespaceResource or the result of cls(response)
- Return type:
- Raises:
- list_all(skip_token: str | None = None, top: int = 100, **kwargs: Any) Iterable[NamespaceResource][source]¶
Lists all the available namespaces within the subscription.
Lists all the available namespaces within the subscription.
- Parameters:
- Returns:
An iterator like instance of either NamespaceResource or the result of cls(response)
- Return type:
- Raises:
- list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) Iterable[SharedAccessAuthorizationRuleResource][source]¶
Gets the authorization rules for a namespace.
Gets the authorization rules for a namespace.
- Parameters:
- Returns:
An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) ResourceListKeys[source]¶
Gets the Primary and Secondary ConnectionStrings to the namespace.
Gets the Primary and Secondary ConnectionStrings to the namespace.
- Parameters:
- Returns:
ResourceListKeys or the result of cls(response)
- Return type:
- Raises:
- regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.PolicyKeyResource, *, content_type: str = 'application/json', **kwargs: Any) _models.ResourceListKeys[source]¶
- regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.ResourceListKeys
Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.
Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
authorization_rule_name (str) – Authorization Rule Name. Required.
parameters (PolicyKeyResource or IO[bytes]) – Request content. Is either a PolicyKeyResource type or a IO[bytes] type. Required.
- Returns:
ResourceListKeys or the result of cls(response)
- Return type:
- Raises:
- update(resource_group_name: str, namespace_name: str, parameters: _models.NamespacePatchParameters, *, content_type: str = 'application/json', **kwargs: Any) _models.NamespaceResource[source]¶
- update(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.NamespaceResource
Patches the existing namespace.
Patches the existing namespace.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
parameters (NamespacePatchParameters or IO[bytes]) – Request content. Is either a NamespacePatchParameters type or a IO[bytes] type. Required.
- Returns:
NamespaceResource or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.notificationhubs.models' from '/mnt/vss/_work/1/s/sdk/notificationhubs/azure-mgmt-notificationhubs/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/notificationhubs/models/__init__.py'>¶
- class azure.mgmt.notificationhubs.operations.NotificationHubsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
NotificationHubsManagementClient’snotification_hubsattribute.- check_notification_hub_availability(resource_group_name: str, namespace_name: str, parameters: _models.CheckAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckAvailabilityResult[source]¶
- check_notification_hub_availability(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckAvailabilityResult
Checks the availability of the given notificationHub in a namespace.
Checks the availability of the given notificationHub in a namespace.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
parameters (CheckAvailabilityParameters or IO[bytes]) – Request content. Is either a CheckAvailabilityParameters type or a IO[bytes] type. Required.
- Returns:
CheckAvailabilityResult or the result of cls(response)
- Return type:
- Raises:
- create_or_update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: _models.NotificationHubResource, *, content_type: str = 'application/json', **kwargs: Any) _models.NotificationHubResource[source]¶
- create_or_update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.NotificationHubResource
Creates/Update a NotificationHub in a namespace.
Creates/Update a NotificationHub in a namespace.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
notification_hub_name (str) – Notification Hub name. Required.
parameters (NotificationHubResource or IO[bytes]) – Request content. Is either a NotificationHubResource type or a IO[bytes] type. Required.
- Returns:
NotificationHubResource or the result of cls(response)
- Return type:
- Raises:
- create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: _models.SharedAccessAuthorizationRuleResource, *, content_type: str = 'application/json', **kwargs: Any) _models.SharedAccessAuthorizationRuleResource[source]¶
- create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.SharedAccessAuthorizationRuleResource
Creates/Updates an authorization rule for a NotificationHub.
Creates/Updates an authorization rule for a NotificationHub.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
notification_hub_name (str) – Notification Hub name. Required.
authorization_rule_name (str) – Authorization Rule Name. Required.
parameters (SharedAccessAuthorizationRuleResource or IO[bytes]) – Request content. Is either a SharedAccessAuthorizationRuleResource type or a IO[bytes] type. Required.
- Returns:
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- debug_send(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) DebugSendResponse[source]¶
Test send a push notification.
Test send a push notification.
- Parameters:
- Returns:
DebugSendResponse or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) None[source]¶
Deletes a notification hub associated with a namespace.
Deletes a notification hub associated with a namespace.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- delete_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, **kwargs: Any) None[source]¶
Deletes a notificationHub authorization rule.
Deletes a notificationHub authorization rule.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) NotificationHubResource[source]¶
Gets the notification hub.
Gets the notification hub.
- Parameters:
- Returns:
NotificationHubResource or the result of cls(response)
- Return type:
- Raises:
- get_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, **kwargs: Any) SharedAccessAuthorizationRuleResource[source]¶
Gets an authorization rule for a NotificationHub by name.
Gets an authorization rule for a NotificationHub by name.
- Parameters:
- Returns:
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- get_pns_credentials(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) PnsCredentialsResource[source]¶
Lists the PNS Credentials associated with a notification hub.
Lists the PNS Credentials associated with a notification hub.
- Parameters:
- Returns:
PnsCredentialsResource or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, namespace_name: str, skip_token: str | None = None, top: int = 100, **kwargs: Any) Iterable[NotificationHubResource][source]¶
Lists the notification hubs associated with a namespace.
Lists the notification hubs associated with a namespace.
- Parameters:
- Returns:
An iterator like instance of either NotificationHubResource or the result of cls(response)
- Return type:
- Raises:
- list_authorization_rules(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) Iterable[SharedAccessAuthorizationRuleResource][source]¶
Gets the authorization rules for a NotificationHub.
Gets the authorization rules for a NotificationHub.
- Parameters:
- Returns:
An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type:
- Raises:
- list_keys(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, **kwargs: Any) ResourceListKeys[source]¶
Gets the Primary and Secondary ConnectionStrings to the NotificationHub.
Gets the Primary and Secondary ConnectionStrings to the NotificationHub.
- Parameters:
- Returns:
ResourceListKeys or the result of cls(response)
- Return type:
- Raises:
- regenerate_keys(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: _models.PolicyKeyResource, *, content_type: str = 'application/json', **kwargs: Any) _models.ResourceListKeys[source]¶
- regenerate_keys(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.ResourceListKeys
Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.
Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
notification_hub_name (str) – Notification Hub name. Required.
authorization_rule_name (str) – Authorization Rule Name. Required.
parameters (PolicyKeyResource or IO[bytes]) – Request content. Is either a PolicyKeyResource type or a IO[bytes] type. Required.
- Returns:
ResourceListKeys or the result of cls(response)
- Return type:
- Raises:
- update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: _models.NotificationHubPatchParameters, *, content_type: str = 'application/json', **kwargs: Any) _models.NotificationHubResource[source]¶
- update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.NotificationHubResource
Patch a NotificationHub in a namespace.
Patch a NotificationHub in a namespace.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
notification_hub_name (str) – Notification Hub name. Required.
parameters (NotificationHubPatchParameters or IO[bytes]) – Request content. Is either a NotificationHubPatchParameters type or a IO[bytes] type. Required.
- Returns:
NotificationHubResource or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.notificationhubs.models' from '/mnt/vss/_work/1/s/sdk/notificationhubs/azure-mgmt-notificationhubs/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/notificationhubs/models/__init__.py'>¶
- class azure.mgmt.notificationhubs.operations.Operations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
NotificationHubsManagementClient’soperationsattribute.- list(**kwargs: Any) Iterable[Operation][source]¶
Lists all available Notification Hubs operations.
Lists all available Notification Hubs operations.
- Returns:
An iterator like instance of either Operation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.notificationhubs.models' from '/mnt/vss/_work/1/s/sdk/notificationhubs/azure-mgmt-notificationhubs/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/notificationhubs/models/__init__.py'>¶
- class azure.mgmt.notificationhubs.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
NotificationHubsManagementClient’sprivate_endpoint_connectionsattribute.- begin_delete(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) LROPoller[None][source]¶
Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
- Parameters:
- Returns:
An instance of LROPoller that returns either None or the result of cls(response)
- Return type:
LROPoller[None]
- Raises:
- begin_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnectionResource, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.PrivateEndpointConnectionResource][source]¶
- begin_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.PrivateEndpointConnectionResource]
Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
namespace_name (str) – Namespace name. Required.
private_endpoint_connection_name (str) – Private Endpoint Connection Name. Required.
parameters (PrivateEndpointConnectionResource or IO[bytes]) – Description of the Private Endpoint Connection resource. Is either a PrivateEndpointConnectionResource type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either PrivateEndpointConnectionResource or the result of cls(response)
- Return type:
- Raises:
- get(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) PrivateEndpointConnectionResource[source]¶
Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.
Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.
- Parameters:
- Returns:
PrivateEndpointConnectionResource or the result of cls(response)
- Return type:
- Raises:
- get_group_id(resource_group_name: str, namespace_name: str, sub_resource_name: str, **kwargs: Any) PrivateLinkResource[source]¶
Returns Group Id response. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users.
Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it’s called. That’s why we don’t send it to the sibling RP, but process it directly in the scale unit that received the request.
- Parameters:
- Returns:
PrivateLinkResource or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, namespace_name: str, **kwargs: Any) Iterable[PrivateEndpointConnectionResource][source]¶
Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.
Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.
- Parameters:
- Returns:
An iterator like instance of either PrivateEndpointConnectionResource or the result of cls(response)
- Return type:
- Raises:
- list_group_ids(resource_group_name: str, namespace_name: str, **kwargs: Any) Iterable[PrivateLinkResource][source]¶
Returns all Group Ids supported by the Notification Hubs RP. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users.
Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it’s called. That’s why we don’t send it to the sibling RP, but process it directly in the scale unit that received the request.
- Parameters:
- Returns:
An iterator like instance of either PrivateLinkResource or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.notificationhubs.models' from '/mnt/vss/_work/1/s/sdk/notificationhubs/azure-mgmt-notificationhubs/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/notificationhubs/models/__init__.py'>¶