NotificationHubsOperations Class

NotificationHubsOperations 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

NotificationHubsOperations

Constructor

NotificationHubsOperations(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

check_notification_hub_availability	Checks the availability of the given notificationHub in a namespace.
create_or_update	Creates/Update a NotificationHub in a namespace.
create_or_update_authorization_rule	Creates/Updates an authorization rule for a NotificationHub.
debug_send	test send a push notification.
delete	Deletes a notification hub associated with a namespace.
delete_authorization_rule	Deletes a notificationHub authorization rule.
get	Lists the notification hubs associated with a namespace.
get_authorization_rule	Gets an authorization rule for a NotificationHub by name.
get_pns_credentials	Lists the PNS Credentials associated with a notification hub .
list	Lists the notification hubs associated with a namespace.
list_authorization_rules	Gets the authorization rules for a NotificationHub.
list_keys	Gets the Primary and Secondary ConnectionStrings to the NotificationHub.
patch	Patch a NotificationHub in a namespace.
regenerate_keys	Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.

check_notification_hub_availability

Checks the availability of the given notificationHub in a namespace.

check_notification_hub_availability(resource_group_name: str, namespace_name: str, parameters: CheckAvailabilityParameters, **kwargs: Any) -> CheckAvailabilityResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
parameters Required	CheckAvailabilityParameters The notificationHub 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/Update a NotificationHub in a namespace.

create_or_update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: NotificationHubCreateOrUpdateParameters, **kwargs: Any) -> NotificationHubResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
notification_hub_name Required	str The notification hub name.
parameters Required	NotificationHubCreateOrUpdateParameters Parameters supplied to the create/update a NotificationHub Resource.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
NotificationHubResource	NotificationHubResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_authorization_rule

Creates/Updates an authorization rule for a NotificationHub.

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub 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

debug_send

test send a push notification.

debug_send(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: Any = None, **kwargs: Any) -> DebugSendResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
notification_hub_name Required	str The notification hub name.
parameters Required	any Debug send parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DebugSendResponse	DebugSendResponse, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a notification hub associated with a namespace.

delete(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub 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

delete_authorization_rule

Deletes a notificationHub authorization rule.

delete_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub 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

Lists the notification hubs associated with a namespace.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
notification_hub_name Required	str The notification hub name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
NotificationHubResource	NotificationHubResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_authorization_rule

Gets an authorization rule for a NotificationHub by name.

get_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub 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

get_pns_credentials

Lists the PNS Credentials associated with a notification hub .

get_pns_credentials(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs: Any) -> PnsCredentialsResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
notification_hub_name Required	str The notification hub name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
PnsCredentialsResource	PnsCredentialsResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists the notification hubs associated with a namespace.

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

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[NotificationHubListResult]	An iterator like instance of either NotificationHubListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_authorization_rules

Gets the authorization rules for a NotificationHub.

list_authorization_rules(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub 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 NotificationHub.

list_keys(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub name.
authorization_rule_name Required	str The connection string of the NotificationHub 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

Patch a NotificationHub in a namespace.

patch(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: NotificationHubPatchParameters | None = None, **kwargs: Any) -> NotificationHubResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
namespace_name Required	str The namespace name.
notification_hub_name Required	str The notification hub name.
parameters Required	NotificationHubPatchParameters Parameters supplied to patch a NotificationHub Resource.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
NotificationHubResource	NotificationHubResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

regenerate_keys

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

regenerate_keys(resource_group_name: str, namespace_name: str, notification_hub_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.
notification_hub_name Required	str The notification hub name.
authorization_rule_name Required	str The connection string of the NotificationHub for the specified authorizationRule.
parameters Required	PolicykeyResource Parameters supplied to regenerate the NotificationHub 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'>