Namespaces - Get Pns Credentials

Service:

Notification Hubs

API Version:

2023-09-01

Lists the PNS credentials associated with a namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	Namespace name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	PnsCredentialsResource	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

Namespaces_GetPnsCredentials

Sample request

HTTP

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

Sample response

Status code:

200

{
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-hub",
  "type": "Microsoft.NotificationHubs/namespaces/pnsCredentials",
  "properties": {
    "mpnsCredential": {
      "properties": {
        "thumbprint": "#################################"
      }
    }
  }
}

Definitions

Name	Description
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.
PnsCredentials	Collection of Notification Hub or Notification Hub Namespace PNS credentials.
PnsCredentialsResource	Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs PNS credentials.
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.

AdmCredential

Object

Description of a NotificationHub AdmCredential.

Name	Type	Description
properties	AdmCredentialProperties	Description of a NotificationHub AdmCredential.

AdmCredentialProperties

Object

Description of a NotificationHub AdmCredential.

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

ApnsCredential

Object

Description of a NotificationHub ApnsCredential.

Name	Type	Description
properties	ApnsCredentialProperties	Description of a NotificationHub ApnsCredential.

ApnsCredentialProperties

Object

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 minLength: 1	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

Object

Description of a NotificationHub BaiduCredential.

Name	Type	Description
properties	BaiduCredentialProperties	Description of a NotificationHub BaiduCredential.

BaiduCredentialProperties

Object

Description of a NotificationHub BaiduCredential.

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

BrowserCredential

Object

Description of a NotificationHub BrowserCredential.

Name	Type	Description
properties	BrowserCredentialProperties	Description of a NotificationHub BrowserCredential.

BrowserCredentialProperties

Object

Description of a NotificationHub BrowserCredential.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GcmCredential

Object

Description of a NotificationHub GcmCredential.

Name	Type	Description
properties	GcmCredentialProperties	Description of a NotificationHub GcmCredential.

GcmCredentialProperties

Object

Description of a NotificationHub GcmCredential.

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

MpnsCredential

Object

Description of a NotificationHub MpnsCredential.

Name	Type	Description
properties	MpnsCredentialProperties	Description of a NotificationHub MpnsCredential.

MpnsCredentialProperties

Object

Description of a NotificationHub MpnsCredential.

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

PnsCredentials

Object

Collection of Notification Hub or Notification Hub Namespace PNS credentials.

Name	Type	Description
admCredential	AdmCredential	Description of a NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Description of a NotificationHub ApnsCredential.
baiduCredential	BaiduCredential	Description of a NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Description of a NotificationHub BrowserCredential.
gcmCredential	GcmCredential	Description of a NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Description of a NotificationHub MpnsCredential.
wnsCredential	WnsCredential	Description of a NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Description of a NotificationHub XiaomiCredential.

PnsCredentialsResource

Object

Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs PNS credentials.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Deprecated - only for compatibility.
name	string	The name of the resource
properties	PnsCredentials	Collection of Notification Hub or Notification Hub Namespace PNS credentials.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Deprecated - only for compatibility.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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

Object

Description of a NotificationHub WnsCredential.

Name	Type	Description
properties	WnsCredentialProperties	Description of a NotificationHub WnsCredential.

WnsCredentialProperties

Object

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

Object

Description of a NotificationHub XiaomiCredential.

Name	Type	Description
properties	XiaomiCredentialProperties	Description of a NotificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Object

Description of a NotificationHub XiaomiCredentialProperties.

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