Notification Hubs - List

Service:

Notification Hubs

API Version:

2023-09-01

Lists the notification hubs associated with a namespace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?api-version=2023-09-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?$skipToken={$skipToken}&$top={$top}&api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	Namespace name Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$skipToken	query		string	Continuation token.
$top	query		integer int32	Page size.

Responses

Name	Type	Description
200 OK	NotificationHubListResult	Success
Other Status Codes	ErrorResponse	Error code with reason.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

NotificationHubs_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs?api-version=2023-09-01

Sample response

Status code:

200

{
  "value": [
    {
      "location": "East US",
      "properties": {
        "name": "test",
        "registrationTtl": "10675199.02:48:05.4775807",
        "dailyMaxActiveDevices": 0
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
      "name": "test",
      "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
      "tags": {
        "hubTag1": "hubTagValue1",
        "hubTag2": "hubTagValue2"
      }
    }
  ]
}

Definitions

Name	Description
AccessRights	Defines values for AccessRights.
AdmCredential	Description of a NotificationHub AdmCredential.
AdmCredentialProperties	Description of a NotificationHub AdmCredential.
ApnsCredential	Description of a NotificationHub ApnsCredential.
ApnsCredentialProperties	Description of a NotificationHub ApnsCredential.
BaiduCredential	Description of a NotificationHub BaiduCredential.
BaiduCredentialProperties	Description of a NotificationHub BaiduCredential.
BrowserCredential	Description of a NotificationHub BrowserCredential.
BrowserCredentialProperties	Description of a NotificationHub BrowserCredential.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GcmCredential	Description of a NotificationHub GcmCredential.
GcmCredentialProperties	Description of a NotificationHub GcmCredential.
MpnsCredential	Description of a NotificationHub MpnsCredential.
MpnsCredentialProperties	Description of a NotificationHub MpnsCredential.
NotificationHubListResult	The response of the List NotificationHub operation.
NotificationHubProperties	NotificationHub properties.
NotificationHubResource	Notification Hub Resource.
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule properties.
Sku	The Sku description for a namespace
SkuName	Namespace SKU name.
systemData	Metadata pertaining to creation and last modification of the resource.
WnsCredential	Description of a NotificationHub WnsCredential.
WnsCredentialProperties	Description of a NotificationHub WnsCredential.
XiaomiCredential	Description of a NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Description of a NotificationHub XiaomiCredentialProperties.

AccessRights

Defines values for AccessRights.

Name	Type	Description
Listen	string
Manage	string
Send	string

AdmCredential

Description of a NotificationHub AdmCredential.

Name	Type	Description
properties	AdmCredentialProperties	Description of a NotificationHub AdmCredential.

AdmCredentialProperties

Description of a NotificationHub AdmCredential.

Name	Type	Description
authTokenUrl	string	Gets or sets the URL of the authorization token.
clientId	string	Gets or sets the client identifier.
clientSecret	string	Gets or sets the credential secret access key.

ApnsCredential

Description of a NotificationHub ApnsCredential.

Name	Type	Description
properties	ApnsCredentialProperties	Description of a NotificationHub ApnsCredential.

ApnsCredentialProperties

Description of a NotificationHub ApnsCredential.

Name	Type	Description
apnsCertificate	string	Gets or sets the APNS certificate.
appId	string	Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account
appName	string	Gets or sets the name of the application
certificateKey	string	Gets or sets the certificate key.
endpoint	string	Gets or sets the endpoint of this credential.
keyId	string	Gets or sets a 10-character key identifier (kid) key, obtained from your developer account
thumbprint	string	Gets or sets the APNS certificate Thumbprint
token	string	Gets or sets provider Authentication Token, obtained through your developer account

BaiduCredential

Description of a NotificationHub BaiduCredential.

Name	Type	Description
properties	BaiduCredentialProperties	Description of a NotificationHub BaiduCredential.

BaiduCredentialProperties

Description of a NotificationHub BaiduCredential.

Name	Type	Description
baiduApiKey	string	Gets or sets baidu Api Key.
baiduEndPoint	string	Gets or sets baidu Endpoint.
baiduSecretKey	string	Gets or sets baidu Secret Key

BrowserCredential

Description of a NotificationHub BrowserCredential.

Name	Type	Description
properties	BrowserCredentialProperties	Description of a NotificationHub BrowserCredential.

BrowserCredentialProperties

Description of a NotificationHub BrowserCredential.

Name	Type	Description
subject	string	Gets or sets web push subject.
vapidPrivateKey	string	Gets or sets VAPID private key.
vapidPublicKey	string	Gets or sets VAPID public key.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GcmCredential

Description of a NotificationHub GcmCredential.

Name	Type	Description
properties	GcmCredentialProperties	Description of a NotificationHub GcmCredential.

GcmCredentialProperties

Description of a NotificationHub GcmCredential.

Name	Type	Description
gcmEndpoint	string	Gets or sets the GCM endpoint.
googleApiKey	string	Gets or sets the Google API key.

MpnsCredential

Description of a NotificationHub MpnsCredential.

Name	Type	Description
properties	MpnsCredentialProperties	Description of a NotificationHub MpnsCredential.

MpnsCredentialProperties

Description of a NotificationHub MpnsCredential.

Name	Type	Description
certificateKey	string	Gets or sets the certificate key for this credential.
mpnsCertificate	string	Gets or sets the MPNS certificate.
thumbprint	string	Gets or sets the MPNS certificate Thumbprint

NotificationHubListResult

The response of the List NotificationHub operation.

Name	Type	Description
nextLink	string	Gets or sets link to the next set of results.
value	NotificationHubResource[]	Gets or sets result of the List AuthorizationRules operation.

NotificationHubProperties

NotificationHub properties.

Name	Type	Description
admCredential	AdmCredential	Description of a NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Description of a NotificationHub ApnsCredential.
authorizationRules	SharedAccessAuthorizationRuleProperties[]	Gets or sets the AuthorizationRules of the created NotificationHub
baiduCredential	BaiduCredential	Description of a NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Description of a NotificationHub BrowserCredential.
dailyMaxActiveDevices	integer
gcmCredential	GcmCredential	Description of a NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Description of a NotificationHub MpnsCredential.
name	string	Gets or sets the NotificationHub name.
registrationTtl	string	Gets or sets the RegistrationTtl of the created NotificationHub
wnsCredential	WnsCredential	Description of a NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Description of a NotificationHub XiaomiCredential.

NotificationHubResource

Notification Hub Resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	NotificationHubProperties	NotificationHub properties.
sku	Sku	The Sku description for a namespace
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule properties.

Name	Type	Description
claimType	string	Gets a string that describes the claim type
claimValue	string	Gets a string that describes the claim value
createdTime	string	Gets the created time for this rule
keyName	string	Gets a string that describes the authorization rule.
modifiedTime	string	Gets the last modified time for this rule
primaryKey	string	Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
revision	integer	Gets the revision number for the rule
rights	AccessRights[]	Gets or sets the rights associated with the rule.
secondaryKey	string	Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.

Sku

The Sku description for a namespace

Name	Type	Description
capacity	integer	Gets or sets the capacity of the resource
family	string	Gets or sets the Sku Family
name	SkuName	Namespace SKU name.
size	string	Gets or sets the Sku size
tier	string	Gets or sets the tier of particular sku

SkuName

Namespace SKU name.

Name	Type	Description
Basic	string
Free	string
Standard	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

WnsCredential

Description of a NotificationHub WnsCredential.

Name	Type	Description
properties	WnsCredentialProperties	Description of a NotificationHub WnsCredential.

WnsCredentialProperties

Description of a NotificationHub WnsCredential.

Name	Type	Description
certificateKey	string	Ges or sets the WNS Certificate Key.
packageSid	string	Gets or sets the package ID for this credential.
secretKey	string	Gets or sets the secret key.
windowsLiveEndpoint	string	Gets or sets the Windows Live endpoint.
wnsCertificate	string	Gets or sets the WNS Certificate.

XiaomiCredential

Description of a NotificationHub XiaomiCredential.

Name	Type	Description
properties	XiaomiCredentialProperties	Description of a NotificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Description of a NotificationHub XiaomiCredentialProperties.

Name	Type	Description
appSecret	string	Gets or sets app secret.
endpoint	string	Gets or sets xiaomi service endpoint.