Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotificationHubs

Package version

Class representing a NotificationHubs.

Hierarchy

  • NotificationHubs

Index

Constructors

Methods

Constructors

constructor

Methods

checkNotificationHubAvailability

  • checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsCheckNotificationHubAvailabilityResponse>
  • checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, callback: msRest.ServiceCallback<CheckAvailabilityResult>): void
  • checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CheckAvailabilityResult>): void

  • Checks the availability of the given notificationHub in a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: CheckAvailabilityParameters

      The notificationHub name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsCheckNotificationHubAvailabilityResponse>

    Promise<Models.NotificationHubsCheckNotificationHubAvailabilityResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: CheckAvailabilityParameters

      The notificationHub name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CheckAvailabilityResult>

      The callback

    Returns void

createOrUpdate

  • Creates/Update a NotificationHub in a namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsCreateOrUpdateResponse>

    Promise<Models.NotificationHubsCreateOrUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

createOrUpdateAuthorizationRule

debugSend

  • debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: Models.NotificationHubsDebugSendOptionalParams): Promise<Models.NotificationHubsDebugSendResponse>
  • debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<DebugSendResponse>): void
  • debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: NotificationHubsDebugSendOptionalParams, callback: msRest.ServiceCallback<DebugSendResponse>): void

  • test send a push notification

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • Optional options: Models.NotificationHubsDebugSendOptionalParams

    Returns Promise<Models.NotificationHubsDebugSendResponse>

    Promise<Models.NotificationHubsDebugSendResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<DebugSendResponse>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • options: NotificationHubsDebugSendOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<DebugSendResponse>

      The callback

    Returns void

deleteAuthorizationRule

  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<void>): void
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a notificationHub authorization rule

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a notification hub associated with a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsGetResponse>
  • get(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<NotificationHubResource>): void
  • get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NotificationHubResource>): void

  • Lists the notification hubs associated with a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsGetResponse>

    Promise<Models.NotificationHubsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

getAuthorizationRule

  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsGetAuthorizationRuleResponse>
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>): void
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>): void

  • Gets an authorization rule for a NotificationHub by name.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsGetAuthorizationRuleResponse>

    Promise<Models.NotificationHubsGetAuthorizationRuleResponse>

  • 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.

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>

      The callback

    Returns void

getPnsCredentials

  • getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsGetPnsCredentialsResponse>
  • getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<PnsCredentialsResource>): void
  • getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PnsCredentialsResource>): void

  • Lists the PNS Credentials associated with a notification hub .

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsGetPnsCredentialsResponse>

    Promise<Models.NotificationHubsGetPnsCredentialsResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<PnsCredentialsResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PnsCredentialsResource>

      The callback

    Returns void

list

  • list(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsListResponse>
  • list(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<NotificationHubListResult>): void
  • list(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NotificationHubListResult>): void

  • Lists the notification hubs associated with a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsListResponse>

    Promise<Models.NotificationHubsListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • callback: msRest.ServiceCallback<NotificationHubListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NotificationHubListResult>

      The callback

    Returns void

listAuthorizationRules

  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsListAuthorizationRulesResponse>
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void

  • Gets the authorization rules for a NotificationHub.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • notificationHubName: string

      The notification hub name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsListAuthorizationRulesResponse>

    Promise<Models.NotificationHubsListAuthorizationRulesResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • notificationHubName: string

      The notification hub name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

listAuthorizationRulesNext

  • listAuthorizationRulesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsListAuthorizationRulesNextResponse>
  • listAuthorizationRulesNext(nextPageLink: string, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • listAuthorizationRulesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void

  • Gets the authorization rules for a NotificationHub.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsListAuthorizationRulesNextResponse>

    Promise<Models.NotificationHubsListAuthorizationRulesNextResponse>

  • Parameters

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

listKeys

  • listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsListKeysResponse>
  • listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<ResourceListKeys>): void
  • listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceListKeys>): void

  • Gets the Primary and Secondary ConnectionStrings to the NotificationHub

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsListKeysResponse>

    Promise<Models.NotificationHubsListKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<NotificationHubListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NotificationHubListResult>): void

  • Lists the notification hubs associated with a namespace.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsListNextResponse>

    Promise<Models.NotificationHubsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<NotificationHubListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NotificationHubListResult>

      The callback

    Returns void

patch

  • patch(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: Models.NotificationHubsPatchOptionalParams): Promise<Models.NotificationHubsPatchResponse>
  • patch(resourceGroupName: string, namespaceName: string, notificationHubName: string, callback: msRest.ServiceCallback<NotificationHubResource>): void
  • patch(resourceGroupName: string, namespaceName: string, notificationHubName: string, options: NotificationHubsPatchOptionalParams, callback: msRest.ServiceCallback<NotificationHubResource>): void

  • Patch a NotificationHub in a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • Optional options: Models.NotificationHubsPatchOptionalParams

    Returns Promise<Models.NotificationHubsPatchResponse>

    Promise<Models.NotificationHubsPatchResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • notificationHubName: string

      The notification hub name.

    • options: NotificationHubsPatchOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<NotificationHubResource>

      The callback

    Returns void

regenerateKeys

  • regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: msRest.RequestOptionsBase): Promise<Models.NotificationHubsRegenerateKeysResponse>
  • regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicykeyResource, callback: msRest.ServiceCallback<ResourceListKeys>): void
  • regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicykeyResource, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceListKeys>): void

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NotificationHubsRegenerateKeysResponse>

    Promise<Models.NotificationHubsRegenerateKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

Generated using TypeDoc