NotificationHubsOperations Class
NotificationHubsOperations 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.objectNotificationHubsOperations
Constructor
NotificationHubsOperations(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
| 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.
async check_notification_hub_availability(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.CheckAvailabilityParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.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/Update a NotificationHub in a namespace.
async create_or_update(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.NotificationHubCreateOrUpdateParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NotificationHubResourceParameters
- parameters
- NotificationHubCreateOrUpdateParameters
Parameters supplied to the create/update a NotificationHub Resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NotificationHubResource, or the result of cls(response)
Return type
Exceptions
create_or_update_authorization_rule
Creates/Updates an authorization rule for a NotificationHub.
async create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.SharedAccessAuthorizationRuleCreateOrUpdateParameters, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.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
debug_send
test send a push notification.
async debug_send(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: Optional[object] = None, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.DebugSendResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DebugSendResponse, or the result of cls(response)
Return type
Exceptions
delete
Deletes a notification hub associated with a namespace.
async delete(resource_group_name: str, namespace_name: str, notification_hub_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_authorization_rule
Deletes a notificationHub authorization rule.
async delete_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_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
get
Lists the notification hubs associated with a namespace.
async get(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NotificationHubResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NotificationHubResource, or the result of cls(response)
Return type
Exceptions
get_authorization_rule
Gets an authorization rule for a NotificationHub by name.
async get_authorization_rule(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.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
get_pns_credentials
Lists the PNS Credentials associated with a notification hub .
async get_pns_credentials(resource_group_name: str, namespace_name: str, notification_hub_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.PnsCredentialsResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PnsCredentialsResource, or the result of cls(response)
Return type
Exceptions
list
Lists the notification hubs associated with a namespace.
list(resource_group_name: str, namespace_name: str, **kwargs) -> AsyncIterable[azure.mgmt.notificationhubs.models._models_py3.NotificationHubListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either NotificationHubListResult or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.notificationhubs.models._models_py3.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 NotificationHub.
async list_keys(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.ResourceListKeysParameters
- authorization_rule_name
- str
The connection string of the NotificationHub for the specified authorizationRule.
- 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
patch
Patch a NotificationHub in a namespace.
async patch(resource_group_name: str, namespace_name: str, notification_hub_name: str, parameters: Optional[azure.mgmt.notificationhubs.models._models_py3.NotificationHubPatchParameters] = None, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.NotificationHubResourceParameters
- parameters
- NotificationHubPatchParameters
Parameters supplied to patch a NotificationHub Resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NotificationHubResource, or the result of cls(response)
Return type
Exceptions
regenerate_keys
Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.
async regenerate_keys(resource_group_name: str, namespace_name: str, notification_hub_name: str, authorization_rule_name: str, parameters: azure.mgmt.notificationhubs.models._models_py3.PolicykeyResource, **kwargs) -> azure.mgmt.notificationhubs.models._models_py3.ResourceListKeysParameters
- authorization_rule_name
- str
The connection string of the NotificationHub for the specified authorizationRule.
- parameters
- PolicykeyResource
Parameters supplied to regenerate the NotificationHub 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