NotificationHubs interface

Package:

@azure/arm-notificationhubs

Interface representing a NotificationHubs.

Methods

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)	Checks the availability of the given notificationHub in a namespace.
createOrUpdate(string, string, string, NotificationHubCreateOrUpdateParameters, NotificationHubsCreateOrUpdateOptionalParams)	Creates/Update a NotificationHub in a namespace.
createOrUpdateAuthorizationRule(string, string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams)	Creates/Updates an authorization rule for a NotificationHub
debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)	test send a push notification
delete(string, string, string, NotificationHubsDeleteOptionalParams)	Deletes a notification hub associated with a namespace.
deleteAuthorizationRule(string, string, string, string, NotificationHubsDeleteAuthorizationRuleOptionalParams)	Deletes a notificationHub authorization rule
get(string, string, string, NotificationHubsGetOptionalParams)	Lists the notification hubs associated with a namespace.
getAuthorizationRule(string, string, string, string, NotificationHubsGetAuthorizationRuleOptionalParams)	Gets an authorization rule for a NotificationHub by name.
getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)	Lists the PNS Credentials associated with a notification hub .
list(string, string, NotificationHubsListOptionalParams)	Lists the notification hubs associated with a namespace.
listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)	Gets the authorization rules for a NotificationHub.
listKeys(string, string, string, string, NotificationHubsListKeysOptionalParams)	Gets the Primary and Secondary ConnectionStrings to the NotificationHub
patch(string, string, string, NotificationHubsPatchOptionalParams)	Patch a NotificationHub in a namespace.
regenerateKeys(string, string, string, string, PolicykeyResource, NotificationHubsRegenerateKeysOptionalParams)	Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule

Method Details

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)

Checks the availability of the given notificationHub in a namespace.

function checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, options?: NotificationHubsCheckNotificationHubAvailabilityOptionalParams): Promise<CheckAvailabilityResult>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

parameters

CheckAvailabilityParameters

The notificationHub name.

options

NotificationHubsCheckNotificationHubAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, string, NotificationHubCreateOrUpdateParameters, NotificationHubsCreateOrUpdateOptionalParams)

Creates/Update a NotificationHub in a namespace.

function createOrUpdate(resourceGroupName: string, namespaceName: string, notificationHubName: string, parameters: NotificationHubCreateOrUpdateParameters, options?: NotificationHubsCreateOrUpdateOptionalParams): Promise<NotificationHubResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

parameters

NotificationHubCreateOrUpdateParameters

Parameters supplied to the create/update a NotificationHub Resource.

options

NotificationHubsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NotificationHubResource>

createOrUpdateAuthorizationRule(string, string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams)

Creates/Updates an authorization rule for a NotificationHub

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

authorizationRuleName

string

Authorization Rule Name.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

The shared access authorization rule.

options

NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<SharedAccessAuthorizationRuleResource>

debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)

test send a push notification

function debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDebugSendOptionalParams): Promise<DebugSendResponse>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

options

NotificationHubsDebugSendOptionalParams

The options parameters.

Returns

Promise<DebugSendResponse>

delete(string, string, string, NotificationHubsDeleteOptionalParams)

Deletes a notification hub associated with a namespace.

function delete(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

options

NotificationHubsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAuthorizationRule(string, string, string, string, NotificationHubsDeleteAuthorizationRuleOptionalParams)

Deletes a notificationHub authorization rule

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsDeleteAuthorizationRuleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

authorizationRuleName

string

Authorization Rule Name.

options

NotificationHubsDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, NotificationHubsGetOptionalParams)

Lists the notification hubs associated with a namespace.

function get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetOptionalParams): Promise<NotificationHubResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

options

NotificationHubsGetOptionalParams

The options parameters.

Returns

Promise<NotificationHubResource>

getAuthorizationRule(string, string, string, string, NotificationHubsGetAuthorizationRuleOptionalParams)

Gets an authorization rule for a NotificationHub by name.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name

notificationHubName

string

The notification hub name.

authorizationRuleName

string

authorization rule name.

options

NotificationHubsGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<SharedAccessAuthorizationRuleResource>

getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)

Lists the PNS Credentials associated with a notification hub .

function getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetPnsCredentialsOptionalParams): Promise<PnsCredentialsResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

options

NotificationHubsGetPnsCredentialsOptionalParams

The options parameters.

Returns

Promise<PnsCredentialsResource>

list(string, string, NotificationHubsListOptionalParams)

Lists the notification hubs associated with a namespace.

function list(resourceGroupName: string, namespaceName: string, options?: NotificationHubsListOptionalParams): PagedAsyncIterableIterator<NotificationHubResource, NotificationHubResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

options

NotificationHubsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NotificationHubResource, NotificationHubResource[], PageSettings>

listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)

Gets the authorization rules for a NotificationHub.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name

notificationHubName

string

The notification hub name.

options

NotificationHubsListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, string, NotificationHubsListKeysOptionalParams)

Gets the Primary and Secondary ConnectionStrings to the NotificationHub

function listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsListKeysOptionalParams): Promise<ResourceListKeys>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

authorizationRuleName

string

The connection string of the NotificationHub for the specified authorizationRule.

options

NotificationHubsListKeysOptionalParams

The options parameters.

Returns

Promise<ResourceListKeys>

patch(string, string, string, NotificationHubsPatchOptionalParams)

Patch a NotificationHub in a namespace.

function patch(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsPatchOptionalParams): Promise<NotificationHubResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

options

NotificationHubsPatchOptionalParams

The options parameters.

Returns

Promise<NotificationHubResource>

regenerateKeys(string, string, string, string, PolicykeyResource, NotificationHubsRegenerateKeysOptionalParams)

Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule

function regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NotificationHubsRegenerateKeysOptionalParams): Promise<ResourceListKeys>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

notificationHubName

string

The notification hub name.

authorizationRuleName

string

The connection string of the NotificationHub for the specified authorizationRule.

parameters

PolicykeyResource

Parameters supplied to regenerate the NotificationHub Authorization Rule Key.

options

NotificationHubsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<ResourceListKeys>