azure_notificationhubs

@datafire/azure_notificationhubs

Client library for NotificationHubsManagementClient

Installation and Usage

npm install --save @datafire/azure_notificationhubs

let azure_notificationhubs = require('@datafire/azure_notificationhubs').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Azure NotificationHub client

Actions

Operations_List

Lists all of the available NotificationHubs REST API operations.

azure_notificationhubs.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: Client Api Version.

Output

• output OperationListResult

Namespaces_CheckAvailability

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.

azure_notificationhubs.Namespaces_CheckAvailability({
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • parameters required CheckAvailabilityParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output CheckAvailabilityResult

Namespaces_ListAll

Lists all the available namespaces within the subscription irrespective of the resourceGroups.

azure_notificationhubs.Namespaces_ListAll({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NamespaceListResult

Namespaces_List

Lists the available namespaces within a resourceGroup.

azure_notificationhubs.Namespaces_List({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NamespaceListResult

Namespaces_Delete

Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.

azure_notificationhubs.Namespaces_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Namespaces_Get

Returns the description for the specified namespace.

azure_notificationhubs.Namespaces_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NamespaceResource

Namespaces_Patch

Patches the existing namespace

azure_notificationhubs.Namespaces_Patch({
  "resourceGroupName": "",
  "namespaceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • parameters required NamespacePatchParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NamespaceResource

Namespaces_CreateOrUpdate

Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

azure_notificationhubs.Namespaces_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • parameters required NamespaceCreateOrUpdateParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NamespaceResource

Namespaces_ListAuthorizationRules

Gets the authorization rules for a namespace.

azure_notificationhubs.Namespaces_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleListResult

Namespaces_DeleteAuthorizationRule

Deletes a namespace authorization rule

azure_notificationhubs.Namespaces_DeleteAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • authorizationRuleName required string: Authorization Rule Name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Namespaces_GetAuthorizationRule

Gets an authorization rule for a namespace by name.

azure_notificationhubs.Namespaces_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: Authorization rule name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleResource

Namespaces_CreateOrUpdateAuthorizationRule

Creates an authorization rule for a namespace

azure_notificationhubs.Namespaces_CreateOrUpdateAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • authorizationRuleName required string: Authorization Rule Name.
  • parameters required SharedAccessAuthorizationRuleCreateOrUpdateParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleResource

Namespaces_ListKeys

Gets the Primary and Secondary ConnectionStrings to the namespace

azure_notificationhubs.Namespaces_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • authorizationRuleName required string: The connection string of the namespace for the specified authorizationRule.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleListResult

Namespaces_RegenerateKeys

Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule

azure_notificationhubs.Namespaces_RegenerateKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • authorizationRuleName required string: The connection string of the namespace for the specified authorizationRule.
  • parameters required PolicykeyResource
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ResourceListKeys

NotificationHubs_CheckNotificationHubAvailability

Checks the availability of the given notificationHub in a namespace.

azure_notificationhubs.NotificationHubs_CheckNotificationHubAvailability({
  "resourceGroupName": "",
  "namespaceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • parameters required CheckAvailabilityParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output CheckAvailabilityResult

NotificationHubs_List

Lists the notification hubs associated with a namespace.

azure_notificationhubs.NotificationHubs_List({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NotificationHubListResult

NotificationHubs_Delete

Deletes a notification hub associated with a namespace.

azure_notificationhubs.NotificationHubs_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationHubs_Get

Lists the notification hubs associated with a namespace.

azure_notificationhubs.NotificationHubs_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NotificationHubResource

NotificationHubs_Patch

Patch a NotificationHub in a namespace.

azure_notificationhubs.NotificationHubs_Patch({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • parameters NotificationHubPatchParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NotificationHubResource

NotificationHubs_CreateOrUpdate

Creates/Update a NotificationHub in a namespace.

azure_notificationhubs.NotificationHubs_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • parameters required NotificationHubCreateOrUpdateParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NotificationHubResource

NotificationHubs_ListAuthorizationRules

Gets the authorization rules for a NotificationHub.

azure_notificationhubs.NotificationHubs_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name
  • notificationHubName required string: The notification hub name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleListResult

NotificationHubs_DeleteAuthorizationRule

Deletes a notificationHub authorization rule

azure_notificationhubs.NotificationHubs_DeleteAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • authorizationRuleName required string: Authorization Rule Name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationHubs_GetAuthorizationRule

Gets an authorization rule for a NotificationHub by name.

azure_notificationhubs.NotificationHubs_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name
  • notificationHubName required string: The notification hub name.
  • authorizationRuleName required string: authorization rule name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleResource

NotificationHubs_CreateOrUpdateAuthorizationRule

Creates/Updates an authorization rule for a NotificationHub

azure_notificationhubs.NotificationHubs_CreateOrUpdateAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • authorizationRuleName required string: Authorization Rule Name.
  • parameters required SharedAccessAuthorizationRuleCreateOrUpdateParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SharedAccessAuthorizationRuleResource

NotificationHubs_ListKeys

Gets the Primary and Secondary ConnectionStrings to the NotificationHub

azure_notificationhubs.NotificationHubs_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • authorizationRuleName required string: The connection string of the NotificationHub for the specified authorizationRule.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ResourceListKeys

NotificationHubs_RegenerateKeys

Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule

azure_notificationhubs.NotificationHubs_RegenerateKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • authorizationRuleName required string: The connection string of the NotificationHub for the specified authorizationRule.
  • parameters required PolicykeyResource
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ResourceListKeys

NotificationHubs_DebugSend

test send a push notification

azure_notificationhubs.NotificationHubs_DebugSend({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • parameters DebugSendParameters
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output DebugSendResponse

NotificationHubs_GetPnsCredentials

Lists the PNS Credentials associated with a notification hub .

azure_notificationhubs.NotificationHubs_GetPnsCredentials({
  "resourceGroupName": "",
  "namespaceName": "",
  "notificationHubName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • namespaceName required string: The namespace name.
  • notificationHubName required string: The notification hub name.
  • api-version required string: Client Api Version.
  • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output PnsCredentialsResource

Definitions

AdmCredential

• AdmCredential object: Description of a NotificationHub AdmCredential.
  • properties AdmCredentialProperties

AdmCredentialProperties

• AdmCredentialProperties object: Description of a NotificationHub AdmCredential.
  • authTokenUrl string: The URL of the authorization token.
  • clientId string: The client identifier.
  • clientSecret string: The credential secret access key.

ApnsCredential

• ApnsCredential object: Description of a NotificationHub ApnsCredential.
  • properties ApnsCredentialProperties

ApnsCredentialProperties

• ApnsCredentialProperties object: Description of a NotificationHub ApnsCredential.
  • apnsCertificate string: The APNS certificate.
  • appId string: The issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account
  • appName string: The name of the application
  • certificateKey string: The certificate key.
  • endpoint string: The endpoint of this credential.
  • keyId string: A 10-character key identifier (kid) key, obtained from your developer account
  • thumbprint string: The APNS certificate Thumbprint
  • token string: Provider Authentication Token, obtained through your developer account

BaiduCredential

• BaiduCredential object: Description of a NotificationHub BaiduCredential.
  • properties BaiduCredentialProperties

BaiduCredentialProperties

• BaiduCredentialProperties object: Description of a NotificationHub BaiduCredential.
  • baiduApiKey string: Baidu Api Key.
  • baiduEndPoint string: Baidu Endpoint.
  • baiduSecretKey string: Baidu Secret Key

CheckAvailabilityParameters

• CheckAvailabilityParameters object: Parameters supplied to the Check Name Availability for Namespace and NotificationHubs.
  • id string: Resource Id
  • isAvailiable boolean: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
  • location string: Resource location
  • name required string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

CheckAvailabilityResult

• CheckAvailabilityResult object: Description of a CheckAvailability resource.
  • isAvailiable boolean: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

DebugSendParameters

• DebugSendParameters object: Debug Send payload

DebugSendResponse

• DebugSendResponse object: Description of a NotificationHub Resource.
  • properties DebugSendResult
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

DebugSendResult

• DebugSendResult object
  • failure number: send failure
  • results object: actual failure description
  • success number: successful send

ErrorResponse

• ErrorResponse object: Error response indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.
  • code string: Error code.
  • message string: Error message indicating why the operation failed.

GcmCredential

• GcmCredential object: Description of a NotificationHub GcmCredential.
  • properties GcmCredentialProperties

GcmCredentialProperties

• GcmCredentialProperties object: Description of a NotificationHub GcmCredential.
  • gcmEndpoint string: The GCM endpoint.
  • googleApiKey string: The Google API key.

MpnsCredential

• MpnsCredential object: Description of a NotificationHub MpnsCredential.
  • properties MpnsCredentialProperties

MpnsCredentialProperties

• MpnsCredentialProperties object: Description of a NotificationHub MpnsCredential.
  • certificateKey string: The certificate key for this credential.
  • mpnsCertificate string: The MPNS certificate.
  • thumbprint string: The MPNS certificate Thumbprint

NamespaceCreateOrUpdateParameters

• NamespaceCreateOrUpdateParameters object: Parameters supplied to the CreateOrUpdate Namespace operation.
  • properties NamespaceProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

NamespaceListResult

• NamespaceListResult object: The response of the List Namespace operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces
  • value array: Result of the List Namespace operation.
    • items NamespaceResource

NamespacePatchParameters

• NamespacePatchParameters object: Parameters supplied to the Patch Namespace operation.
  • sku Sku
  • tags object: Resource tags

NamespaceProperties

• NamespaceProperties object: Namespace properties.
  • createdAt string: The time the namespace was created.
  • critical boolean: Whether or not the namespace is set as Critical.
  • dataCenter string: Data center for the namespace
  • enabled boolean: Whether or not the namespace is currently enabled.
  • metricId string: Identifier for Azure Insights metrics
  • name string: The name of the namespace.
  • namespaceType string (values: Messaging, NotificationHub): The namespace type.
  • provisioningState string: Provisioning state of the Namespace.
  • region string: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe
  • scaleUnit string: ScaleUnit where the namespace gets created
  • serviceBusEndpoint string: Endpoint you can use to perform NotificationHub operations.
  • status string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting
  • subscriptionId string: The Id of the Azure subscription associated with the namespace.
  • updatedAt string: The time the namespace was updated.

NamespaceResource

• NamespaceResource object: Description of a Namespace resource.
  • properties NamespaceProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

NotificationHubCreateOrUpdateParameters

• NotificationHubCreateOrUpdateParameters object: Parameters supplied to the CreateOrUpdate NotificationHub operation.
  • properties required NotificationHubProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

NotificationHubListResult

• NotificationHubListResult object: The response of the List NotificationHub operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub
  • value array: Result of the List NotificationHub operation.
    • items NotificationHubResource

NotificationHubPatchParameters

• NotificationHubPatchParameters object: Parameters supplied to the patch NotificationHub operation.
  • properties NotificationHubProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

NotificationHubProperties

• NotificationHubProperties object: NotificationHub properties.
  • admCredential AdmCredential
  • apnsCredential ApnsCredential
  • authorizationRules array: The AuthorizationRules of the created NotificationHub
    • items SharedAccessAuthorizationRuleProperties
  • baiduCredential BaiduCredential
  • gcmCredential GcmCredential
  • mpnsCredential MpnsCredential
  • name string: The NotificationHub name.
  • registrationTtl string: The RegistrationTtl of the created NotificationHub
  • wnsCredential WnsCredential

NotificationHubResource

• NotificationHubResource object: Description of a NotificationHub Resource.
  • properties NotificationHubProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

Operation

• Operation object: A NotificationHubs REST API operation
  • display object: The object that represents the operation.
    • operation string: Operation type: Read, write, delete, etc.
    • provider string: Service provider: Microsoft.NotificationHubs
    • resource string: Resource on which the operation is performed: Invoice, etc.
  • name string: Operation name: {provider}/{resource}/{operation}

OperationListResult

• OperationListResult object: Result of the request to list NotificationHubs operations. It contains a list of operations and a URL link to get the next set of results.
  • nextLink string: URL to get the next set of operation list results if there are any.
  • value array: List of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider.
    • items Operation

PnsCredentialsProperties

• PnsCredentialsProperties object: Description of a NotificationHub PNS Credentials.
  • admCredential AdmCredential
  • apnsCredential ApnsCredential
  • baiduCredential BaiduCredential
  • gcmCredential GcmCredential
  • mpnsCredential MpnsCredential
  • wnsCredential WnsCredential

PnsCredentialsResource

• PnsCredentialsResource object: Description of a NotificationHub PNS Credentials.
  • properties PnsCredentialsProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

PolicykeyResource

• PolicykeyResource object: Namespace/NotificationHub Regenerate Keys
  • policyKey string: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key.

Resource

• Resource object
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

ResourceListKeys

• ResourceListKeys object: Namespace/NotificationHub Connection String
  • keyName string: KeyName of the created AuthorizationRule
  • primaryConnectionString string: PrimaryConnectionString of the AuthorizationRule.
  • primaryKey string: PrimaryKey of the created AuthorizationRule.
  • secondaryConnectionString string: SecondaryConnectionString of the created AuthorizationRule
  • secondaryKey string: SecondaryKey of the created AuthorizationRule

SharedAccessAuthorizationRuleCreateOrUpdateParameters

• SharedAccessAuthorizationRuleCreateOrUpdateParameters object: Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.
  • properties required SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRuleListResult

• SharedAccessAuthorizationRuleListResult object: The response of the List Namespace operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules
  • value array: Result of the List AuthorizationRules operation.
    • items SharedAccessAuthorizationRuleResource

SharedAccessAuthorizationRuleProperties

• SharedAccessAuthorizationRuleProperties object: SharedAccessAuthorizationRule properties.
  • claimType string: A string that describes the claim type
  • claimValue string: A string that describes the claim value
  • createdTime string: The created time for this rule
  • keyName string: A string that describes the authorization rule.
  • modifiedTime string: The last modified time for this rule
  • primaryKey string: A base64-encoded 256-bit primary key for signing and validating the SAS token.
  • revision integer: The revision number for the rule
  • rights array: The rights associated with the rule.
    • items string (values: Manage, Send, Listen)
  • secondaryKey string: A base64-encoded 256-bit primary key for signing and validating the SAS token.

SharedAccessAuthorizationRuleResource

• SharedAccessAuthorizationRuleResource object: Description of a Namespace AuthorizationRules.
  • properties SharedAccessAuthorizationRuleProperties
  • id string: Resource Id
  • location string: Resource location
  • name string: Resource name
  • sku Sku
  • tags object: Resource tags
  • type string: Resource type

Sku

• Sku object: The Sku description for a namespace
  • capacity integer: The capacity of the resource
  • family string: The Sku Family
  • name required string (values: Free, Basic, Standard): Name of the notification hub sku
  • size string: The Sku size
  • tier string: The tier of particular sku

SubResource

• SubResource object
  • id string: Resource Id

WnsCredential

• WnsCredential object: Description of a NotificationHub WnsCredential.
  • properties WnsCredentialProperties

WnsCredentialProperties

• WnsCredentialProperties object: Description of a NotificationHub WnsCredential.
  • packageSid string: The package ID for this credential.
  • secretKey string: The secret key.
  • windowsLiveEndpoint string: The Windows Live endpoint.