Notification Hubs - Create Or Update

Service:

Notification Hubs

API Version:

2023-10-01-preview

Crea/aggiorna un oggetto NotificationHub in uno spazio dei nomi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string	Nome spazio dei nomi Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
notificationHubName	path	True	string	Nome hub di notifica Regex pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
properties.admCredential		AdmCredential	Descrizione di un oggetto NotificationHub AdmCredential.
properties.apnsCredential		ApnsCredential	Descrizione di un ApnsCredential di NotificationHub.
properties.baiduCredential		BaiduCredential	Descrizione di NotificationHub BaiduCredential.
properties.browserCredential		BrowserCredential	Descrizione di un browser NotificationHubCredential.
properties.fcmV1Credential		FcmV1Credential	Descrizione di un oggetto NotificationHub FcmV1Credential.
properties.gcmCredential		GcmCredential	Descrizione di un oggetto NotificationHub GcmCredential.
properties.mpnsCredential		MpnsCredential	Descrizione di notificationHub MpnsCredential.
properties.name		string	Ottiene o imposta il nome di NotificationHub.
properties.registrationTtl		string	Ottiene o imposta registrationTtl dell'oggetto NotificationHub creato
properties.wnsCredential		WnsCredential	Descrizione di un oggetto NotificationHub WnsCredential.
properties.xiaomiCredential		XiaomiCredential	Descrizione di NotificationHubCredential.
sku		Sku	Descrizione sku per uno spazio dei nomi
tags		object	Tag delle risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	NotificationHubResource	Aggiornato
201 Created	NotificationHubResource	Data di creazione
Other Status Codes	ErrorResponse	Codice di errore con motivo.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AccessRights	Definisce i valori per AccessRights.
AdmCredential	Descrizione di un oggetto NotificationHub AdmCredential.
ApnsCredential	Descrizione di un ApnsCredential di NotificationHub.
BaiduCredential	Descrizione di NotificationHub BaiduCredential.
BrowserCredential	Descrizione di un browser NotificationHubCredential.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FcmV1Credential	Descrizione di un oggetto NotificationHub FcmV1Credential.
GcmCredential	Descrizione di un oggetto NotificationHub GcmCredential.
MpnsCredential	Descrizione di notificationHub MpnsCredential.
NotificationHubResource	Risorsa hub di notifica.
SharedAccessAuthorizationRuleProperties	Proprietà SharedAccessAuthorizationRule.
Sku	Descrizione sku per uno spazio dei nomi
SkuName	Nome SKU dello spazio dei nomi.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
WnsCredential	Descrizione di un oggetto NotificationHub WnsCredential.
XiaomiCredential	Descrizione di NotificationHubCredential.

AccessRights

Definisce i valori per AccessRights.

Nome	Tipo	Descrizione
Listen	string
Manage	string
Send	string

AdmCredential

Descrizione di un oggetto NotificationHub AdmCredential.

Nome	Tipo	Descrizione
properties.authTokenUrl	string	Ottiene o imposta l'URL del token di autorizzazione.
properties.clientId	string	Ottiene o imposta l'identificatore client.
properties.clientSecret	string	Ottiene o imposta la chiave di accesso al segreto delle credenziali.

ApnsCredential

Descrizione di un ApnsCredential di NotificationHub.

Nome	Tipo	Descrizione
properties.apnsCertificate	string	Ottiene o imposta il certificato APNS.
properties.appId	string	Ottiene o imposta la chiave dell'attestazione registrata (iss), il cui valore è l'ID team di 10 caratteri ottenuto dall'account sviluppatore
properties.appName	string	Ottiene o imposta il nome dell'applicazione
properties.certificateKey	string	Ottiene o imposta la chiave del certificato.
properties.endpoint	string	Ottiene o imposta l'endpoint di questa credenziale.
properties.keyId	string	Ottiene o imposta una chiave di 10 caratteri (kid), ottenuta dall'account sviluppatore
properties.thumbprint	string	Ottiene o imposta l'identificazione personale del certificato APNS
properties.token	string	Ottiene o imposta il token di autenticazione del provider ottenuto tramite l'account per sviluppatore

BaiduCredential

Descrizione di NotificationHub BaiduCredential.

Nome	Tipo	Descrizione
properties.baiduApiKey	string	Ottiene o imposta la chiave API baidu.
properties.baiduEndPoint	string	Ottiene o imposta l'endpoint baidu.
properties.baiduSecretKey	string	Ottiene o imposta la chiave privata baidu

BrowserCredential

Descrizione di un browser NotificationHubCredential.

Nome	Tipo	Descrizione
properties.subject	string	Ottiene o imposta l'oggetto push Web.
properties.vapidPrivateKey	string	Ottiene o imposta la chiave privata VAPID.
properties.vapidPublicKey	string	Ottiene o imposta la chiave pubblica VAPID.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FcmV1Credential

Descrizione di un oggetto NotificationHub FcmV1Credential.

Nome	Tipo	Descrizione
properties.clientEmail	string	Ottiene o imposta la posta elettronica client.
properties.privateKey	string	Ottiene o imposta la chiave privata.
properties.projectId	string	Ottiene o imposta l'ID progetto.

GcmCredential

Descrizione di un oggetto NotificationHub GcmCredential.

Nome	Tipo	Descrizione
properties.gcmEndpoint	string	Ottiene o imposta l'endpoint GCM.
properties.googleApiKey	string	Ottiene o imposta la chiave API Google.

MpnsCredential

Descrizione di notificationHub MpnsCredential.

Nome	Tipo	Descrizione
properties.certificateKey	string	Ottiene o imposta la chiave del certificato per questa credenziale.
properties.mpnsCertificate	string	Ottiene o imposta il certificato MPNS.
properties.thumbprint	string	Ottiene o imposta l'identificazione personale del certificato MPNS

NotificationHubResource

Risorsa hub di notifica.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties.admCredential	AdmCredential	Descrizione di un oggetto NotificationHub AdmCredential.
properties.apnsCredential	ApnsCredential	Descrizione di un ApnsCredential di NotificationHub.
properties.authorizationRules	SharedAccessAuthorizationRuleProperties[]	Ottiene o imposta le regole AuthorizationRules dell'oggetto NotificationHub creato
properties.baiduCredential	BaiduCredential	Descrizione di NotificationHub BaiduCredential.
properties.browserCredential	BrowserCredential	Descrizione di un browser NotificationHubCredential.
properties.dailyMaxActiveDevices	integer
properties.fcmV1Credential	FcmV1Credential	Descrizione di un oggetto NotificationHub FcmV1Credential.
properties.gcmCredential	GcmCredential	Descrizione di un oggetto NotificationHub GcmCredential.
properties.mpnsCredential	MpnsCredential	Descrizione di notificationHub MpnsCredential.
properties.name	string	Ottiene o imposta il nome di NotificationHub.
properties.registrationTtl	string	Ottiene o imposta registrationTtl dell'oggetto NotificationHub creato
properties.wnsCredential	WnsCredential	Descrizione di un oggetto NotificationHub WnsCredential.
properties.xiaomiCredential	XiaomiCredential	Descrizione di NotificationHubCredential.
sku	Sku	Descrizione sku per uno spazio dei nomi
systemData	systemData	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Proprietà SharedAccessAuthorizationRule.

Nome	Tipo	Descrizione
claimType	string	Ottiene una stringa che descrive il tipo di attestazione
claimValue	string	Ottiene una stringa che descrive il valore dell'attestazione
createdTime	string	Ottiene l'ora di creazione per questa regola
keyName	string	Ottiene una stringa che descrive la regola di autorizzazione.
modifiedTime	string	Ottiene l'ora dell'ultima modifica per questa regola
primaryKey	string	Ottiene una chiave primaria con codifica Base64 a 256 bit per la firma e la convalida del token di firma di accesso condiviso.
revision	integer	Ottiene il numero di revisione per la regola
rights	AccessRights[]	Ottiene o imposta i diritti associati alla regola.
secondaryKey	string	Ottiene una chiave primaria con codifica Base64 a 256 bit per la firma e la convalida del token di firma di accesso condiviso.

Sku

Descrizione sku per uno spazio dei nomi

Nome	Tipo	Descrizione
capacity	integer	Ottiene o imposta la capacità della risorsa
family	string	Ottiene o imposta la famiglia di SKU
name	SkuName	Nome SKU dello spazio dei nomi.
size	string	Ottiene o imposta le dimensioni dello SKU
tier	string	Ottiene o imposta il livello di uno SKU specifico

SkuName

Nome SKU dello spazio dei nomi.

Nome	Tipo	Descrizione
Basic	string
Free	string
Standard	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

WnsCredential

Descrizione di un oggetto NotificationHub WnsCredential.

Nome	Tipo	Descrizione
properties.certificateKey	string	Ges o imposta la chiave del certificato WNS.
properties.packageSid	string	Ottiene o imposta l'ID pacchetto per questa credenziale.
properties.secretKey	string	Ottiene o imposta la chiave privata.
properties.windowsLiveEndpoint	string	Ottiene o imposta l'endpoint Windows Live.
properties.wnsCertificate	string	Ottiene o imposta il certificato WNS.

XiaomiCredential

Descrizione di NotificationHubCredential.

Nome	Tipo	Descrizione
properties.appSecret	string	Ottiene o imposta il segreto dell'app.
properties.endpoint	string	Ottiene o imposta l'endpoint del servizio Dip.