Notification Hubs - Get Pns Credentials

Referens

Tjänst:: Notification Hubs

API-version:: 2023-09-01

Visar en lista över PNS-autentiseringsuppgifter som är associerade med en meddelandehubb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	Namnområdesnamn
notificationHubName	path	True	string minLength: 1 maxLength: 265 pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$	Namn på meddelandehubb
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	PnsCredentialsResource	Framgång
Other Status Codes	ErrorResponse	Felkod med orsak.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

NotificationHubs_GetPnsCredentials

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "properties": {
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "https://fcm.googleapis.com/fcm/send",
        "googleApiKey": "###################################"
      }
    }
  },
  "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/pnsCredentials"
}

Definitioner

Name	Description
AdmCredential	Beskrivning av en NotificationHub AdmCredential.
AdmCredentialProperties	Beskrivning av en NotificationHub AdmCredential.
ApnsCredential	Beskrivning av en NotificationHub ApnsCredential.
ApnsCredentialProperties	Beskrivning av en NotificationHub ApnsCredential.
BaiduCredential	Beskrivning av en NotificationHub BaiduCredential.
BaiduCredentialProperties	Beskrivning av en NotificationHub BaiduCredential.
BrowserCredential	Beskrivning av en NotificationHub BrowserCredential.
BrowserCredentialProperties	Beskrivning av en NotificationHub BrowserCredential.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GcmCredential	Beskrivning av en NotificationHub GcmCredential.
GcmCredentialProperties	Beskrivning av en NotificationHub GcmCredential.
MpnsCredential	Beskrivning av en NotificationHub MpnsCredential.
MpnsCredentialProperties	Beskrivning av en NotificationHub MpnsCredential.
PnsCredentials	Samling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub.
PnsCredentialsResource	Beskrivning av en NotificationHub PNS-autentiseringsuppgifter. Det här är ett svar på POST-begäranden som returnerar namnrymden eller hubbarnas PNS-autentiseringsuppgifter.
systemData	Metadata som rör skapande och senaste ändring av resursen.
WnsCredential	Beskrivning av en NotificationHub WnsCredential.
WnsCredentialProperties	Beskrivning av en NotificationHub WnsCredential.
XiaomiCredential	Beskrivning av en NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Beskrivning av en NotificationHub XiaomiCredentialProperties.

AdmCredential

Objekt

Beskrivning av en NotificationHub AdmCredential.

Name	Typ	Description
properties	AdmCredentialProperties	Beskrivning av en NotificationHub AdmCredential.

AdmCredentialProperties

Objekt

Beskrivning av en NotificationHub AdmCredential.

Name	Typ	Description
authTokenUrl	string minLength: 1	Hämtar eller anger URL:en för auktoriseringstoken.
clientId	string minLength: 1	Hämtar eller anger klientidentifieraren.
clientSecret	string minLength: 1	Hämtar eller anger autentiseringsuppgifternas hemliga åtkomstnyckel.

ApnsCredential

Objekt

Beskrivning av en NotificationHub ApnsCredential.

Name	Typ	Description
properties	ApnsCredentialProperties	Beskrivning av en NotificationHub ApnsCredential.

ApnsCredentialProperties

Objekt

Beskrivning av en NotificationHub ApnsCredential.

Name	Typ	Description
apnsCertificate	string	Hämtar eller anger APNS-certifikatet.
appId	string	Hämtar eller anger utfärdarens (iss) registrerade anspråksnyckel, vars värde är ditt team-ID på 10 tecken, som hämtats från ditt utvecklarkonto
appName	string	Hämtar eller anger namnet på programmet
certificateKey	string	Hämtar eller anger certifikatnyckeln.
endpoint	string minLength: 1	Hämtar eller anger slutpunkten för den här autentiseringsuppgiften.
keyId	string	Hämtar eller anger en nyckelidentifierare på 10 tecken (barn) som hämtas från ditt utvecklarkonto
thumbprint	string	Hämtar eller anger APNS-certifikatets tumavtryck
token	string	Hämtar eller anger providerautentiseringstoken som hämtas via ditt utvecklarkonto

BaiduCredential

Objekt

Beskrivning av en NotificationHub BaiduCredential.

Name	Typ	Description
properties	BaiduCredentialProperties	Beskrivning av en NotificationHub BaiduCredential.

BaiduCredentialProperties

Objekt

Beskrivning av en NotificationHub BaiduCredential.

Name	Typ	Description
baiduApiKey	string minLength: 1	Hämtar eller anger baidu Api Key.
baiduEndPoint	string minLength: 1	Hämtar eller anger baidu-slutpunkt.
baiduSecretKey	string minLength: 1	Hämtar eller ställer in hemlig baidu-nyckel

BrowserCredential

Objekt

Beskrivning av en NotificationHub BrowserCredential.

Name	Typ	Description
properties	BrowserCredentialProperties	Beskrivning av en NotificationHub BrowserCredential.

BrowserCredentialProperties

Objekt

Beskrivning av en NotificationHub BrowserCredential.

Name	Typ	Description
subject	string minLength: 1	Hämtar eller anger webb push-ämne.
vapidPrivateKey	string minLength: 1	Hämtar eller anger en privat VAPID-nyckel.
vapidPublicKey	string minLength: 1	Hämtar eller anger en offentlig VAPID-nyckel.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GcmCredential

Objekt

Beskrivning av en NotificationHub GcmCredential.

Name	Typ	Description
properties	GcmCredentialProperties	Beskrivning av en NotificationHub GcmCredential.

GcmCredentialProperties

Objekt

Beskrivning av en NotificationHub GcmCredential.

Name	Typ	Description
gcmEndpoint	string	Hämtar eller anger GCM-slutpunkten.
googleApiKey	string minLength: 1	Hämtar eller anger Google API-nyckeln.

MpnsCredential

Objekt

Beskrivning av en NotificationHub MpnsCredential.

Name	Typ	Description
properties	MpnsCredentialProperties	Beskrivning av en NotificationHub MpnsCredential.

MpnsCredentialProperties

Objekt

Beskrivning av en NotificationHub MpnsCredential.

Name	Typ	Description
certificateKey	string minLength: 1	Hämtar eller anger certifikatnyckeln för den här autentiseringsuppgiften.
mpnsCertificate	string minLength: 1	Hämtar eller anger MPNS-certifikatet.
thumbprint	string minLength: 1	Hämtar eller anger MPNS-certifikatets tumavtryck

PnsCredentials

Objekt

Samling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub.

Name	Typ	Description
admCredential	AdmCredential	Beskrivning av en NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Beskrivning av en NotificationHub ApnsCredential.
baiduCredential	BaiduCredential	Beskrivning av en NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Beskrivning av en NotificationHub BrowserCredential.
gcmCredential	GcmCredential	Beskrivning av en NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Beskrivning av en NotificationHub MpnsCredential.
wnsCredential	WnsCredential	Beskrivning av en NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Beskrivning av en NotificationHub XiaomiCredential.

PnsCredentialsResource

Objekt

Beskrivning av en NotificationHub PNS-autentiseringsuppgifter. Det här är ett svar på POST-begäranden som returnerar namnrymden eller hubbarnas PNS-autentiseringsuppgifter.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Inaktuell – endast för kompatibilitet.
name	string	Namnet på resursen
properties	PnsCredentials	Samling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Inaktuell – endast för kompatibilitet.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

WnsCredential

Objekt

Beskrivning av en NotificationHub WnsCredential.

Name	Typ	Description
properties	WnsCredentialProperties	Beskrivning av en NotificationHub WnsCredential.

WnsCredentialProperties

Objekt

Beskrivning av en NotificationHub WnsCredential.

Name	Typ	Description
certificateKey	string	Ges eller anger WNS-certifikatnyckeln.
packageSid	string	Hämtar eller anger paket-ID för den här autentiseringsuppgiften.
secretKey	string	Hämtar eller anger den hemliga nyckeln.
windowsLiveEndpoint	string	Hämtar eller anger Windows Live-slutpunkten.
wnsCertificate	string	Hämtar eller anger WNS-certifikatet.

XiaomiCredential

Objekt

Beskrivning av en NotificationHub XiaomiCredential.

Name	Typ	Description
properties	XiaomiCredentialProperties	Beskrivning av en NotificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Objekt

Beskrivning av en NotificationHub XiaomiCredentialProperties.

Name	Typ	Description
appSecret	string	Hämtar eller anger apphemlighet.
endpoint	string	Hämtar eller anger tjänstslutpunkten för Xiaomi.

Dela via

Notification Hubs - Get Pns Credentials

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

NotificationHubs_GetPnsCredentials

Exempelbegäran

Exempelsvar

Definitioner

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

BaiduCredential

BaiduCredentialProperties

BrowserCredential

BrowserCredentialProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GcmCredential

GcmCredentialProperties

MpnsCredential

MpnsCredentialProperties

PnsCredentials

PnsCredentialsResource

systemData

WnsCredential

WnsCredentialProperties

XiaomiCredential

XiaomiCredentialProperties