Notification Hubs - Create Or Update

Referens

Service:: Notification Hubs

API Version:: 2023-10-01-preview

Skapar/uppdaterar en NotificationHub i ett namnområde.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
namespaceName	path	True	string	Namn på namnområde Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Namn på meddelandehubb Regex pattern: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	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	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
properties.admCredential		AdmCredential	Beskrivning av en NotificationHub AdmCredential.
properties.apnsCredential		ApnsCredential	Beskrivning av en NotificationHub ApnsCredential.
properties.baiduCredential		BaiduCredential	Beskrivning av en NotificationHub BaiduCredential.
properties.browserCredential		BrowserCredential	Beskrivning av en NotificationHub BrowserCredential.
properties.fcmV1Credential		FcmV1Credential	Beskrivning av en NotificationHub FcmV1Credential.
properties.gcmCredential		GcmCredential	Beskrivning av en NotificationHub GcmCredential.
properties.mpnsCredential		MpnsCredential	Beskrivning av en NotificationHub MpnsCredential.
properties.name		string	Hämtar eller anger NotificationHub-namnet.
properties.registrationTtl		string	Hämtar eller anger RegistrationTtl för den skapade NotificationHub
properties.wnsCredential		WnsCredential	Beskrivning av en NotificationHub WnsCredential.
properties.xiaomiCredential		XiaomiCredential	Beskrivning av en NotificationHub XiaomiCredential.
sku		Sku	SKU-beskrivningen för ett namnområde
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	NotificationHubResource	Uppdaterad
201 Created	NotificationHubResource	Skapad
Other Status Codes	ErrorResponse	Felkod med orsak.

Säkerhet

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	personifiera ditt användarkonto

Exempel

NotificationHubs_CreateOrUpdate

Sample Request

HTTP

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

{
  "location": "eastus",
  "properties": {}
}

Sample Response

Status code:: 200

{
  "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"
  }
}

Status code:: 201

{
  "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"
  }
}

Definitioner

Name	Description
AccessRights	Definierar värden för AccessRights.
AdmCredential	Beskrivning av en NotificationHub AdmCredential.
ApnsCredential	Beskrivning av en NotificationHub ApnsCredential.
BaiduCredential	Beskrivning av en NotificationHub BaiduCredential.
BrowserCredential	Beskrivning av en NotificationHub BrowserCredential.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FcmV1Credential	Beskrivning av en NotificationHub FcmV1Credential.
GcmCredential	Beskrivning av en NotificationHub GcmCredential.
MpnsCredential	Beskrivning av en NotificationHub MpnsCredential.
NotificationHubResource	Notification Hub-resurs.
SharedAccessAuthorizationRuleProperties	Egenskaper för SharedAccessAuthorizationRule.
Sku	Sku-beskrivningen för ett namnområde
SkuName	Namnområdes-SKU-namn.
systemData	Metadata som rör skapande och senaste ändring av resursen.
WnsCredential	Beskrivning av en NotificationHub WnsCredential.
XiaomiCredential	Beskrivning av en NotificationHub XiaomiCredential.

AccessRights

Definierar värden för AccessRights.

Name	Typ	Description
Listen	string
Manage	string
Send	string

AdmCredential

Beskrivning av en NotificationHub AdmCredential.

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

ApnsCredential

Beskrivning av en NotificationHub ApnsCredential.

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

BaiduCredential

Beskrivning av en NotificationHub BaiduCredential.

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

BrowserCredential

Beskrivning av en NotificationHub BrowserCredential.

Name	Typ	Description
properties.subject	string	Hämtar eller ställer in webb-push-ämne.
properties.vapidPrivateKey	string	Hämtar eller anger en privat VAPID-nyckel.
properties.vapidPublicKey	string	Hämtar eller anger offentlig VAPID-nyckel.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

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

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FcmV1Credential

Beskrivning av en NotificationHub FcmV1Credential.

Name	Typ	Description
properties.clientEmail	string	Hämtar eller anger klient-e-post.
properties.privateKey	string	Hämtar eller anger privat nyckel.
properties.projectId	string	Hämtar eller anger projekt-ID.

GcmCredential

Beskrivning av en NotificationHub GcmCredential.

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

MpnsCredential

Beskrivning av en NotificationHub MpnsCredential.

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

NotificationHubResource

Notification Hub-resurs.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.admCredential	AdmCredential	Beskrivning av en NotificationHub AdmCredential.
properties.apnsCredential	ApnsCredential	Beskrivning av en NotificationHub ApnsCredential.
properties.authorizationRules	SharedAccessAuthorizationRuleProperties[]	Hämtar eller anger AuthorizationRules för den skapade NotificationHub
properties.baiduCredential	BaiduCredential	Beskrivning av en NotificationHub BaiduCredential.
properties.browserCredential	BrowserCredential	Beskrivning av en NotificationHub BrowserCredential.
properties.dailyMaxActiveDevices	integer
properties.fcmV1Credential	FcmV1Credential	Beskrivning av en NotificationHub FcmV1Credential.
properties.gcmCredential	GcmCredential	Beskrivning av en NotificationHub GcmCredential.
properties.mpnsCredential	MpnsCredential	Beskrivning av en NotificationHub MpnsCredential.
properties.name	string	Hämtar eller anger NotificationHub-namnet.
properties.registrationTtl	string	Hämtar eller anger RegistrationTtl för den skapade NotificationHub
properties.wnsCredential	WnsCredential	Beskrivning av en NotificationHub WnsCredential.
properties.xiaomiCredential	XiaomiCredential	Beskrivning av en NotificationHub XiaomiCredential.
sku	Sku	Sku-beskrivningen för ett namnområde
systemData	systemData	Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Egenskaper för SharedAccessAuthorizationRule.

Name	Typ	Description
claimType	string	Hämtar en sträng som beskriver anspråkstypen
claimValue	string	Hämtar en sträng som beskriver anspråksvärdet
createdTime	string	Hämtar den skapade tiden för den här regeln
keyName	string	Hämtar en sträng som beskriver auktoriseringsregeln.
modifiedTime	string	Hämtar den senaste ändrade tiden för den här regeln
primaryKey	string	Hämtar en base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.
revision	integer	Hämtar revisionsnumret för regeln
rights	AccessRights[]	Hämtar eller anger de rättigheter som är associerade med regeln.
secondaryKey	string	Hämtar en base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.

Sku

Sku-beskrivningen för ett namnområde

Name	Typ	Description
capacity	integer	Hämtar eller anger resursens kapacitet
family	string	Hämtar eller ställer in SKU-familjen
name	SkuName	Namnområdes-SKU-namn.
size	string	Hämtar eller anger SKU-storleken
tier	string	Hämtar eller anger nivån för en viss sku

SkuName

Namnområdes-SKU-namn.

Name	Typ	Description
Basic	string
Free	string
Standard	string

systemData

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

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	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

Beskrivning av en NotificationHub WnsCredential.

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

XiaomiCredential

Beskrivning av en NotificationHub XiaomiCredential.

Name	Typ	Description
properties.appSecret	string	Hämtar eller anger apphemlighet.
properties.endpoint	string	Hämtar eller anger xiaomi-tjänstslutpunkten.

Dela via