Notification Hubs - Create Or Update

Odwołanie

Usługa:: Notification Hubs

Wersja interfejsu API:: 2023-09-01

Tworzy/aktualizuje usługę NotificationHub w przestrzeni nazw.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string	Nazwa przestrzeni nazw Wzorzec wyrażenia regularnego: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Nazwa centrum powiadomień Wzorzec wyrażenia regularnego: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
properties		NotificationHubProperties	Właściwości usługi NotificationHub.
sku		Sku	Opis jednostki SKU dla przestrzeni nazw
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NotificationHubResource	Po aktualizacji
201 Created	NotificationHubResource	Utworzone
Other Status Codes	ErrorResponse	Kod błędu z przyczyną.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

NotificationHubs_CreateOrUpdate

Przykładowe żądanie

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-09-01

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
AccessRights	Definiuje wartości accessRights.
AdmCredential	Opis obiektu NotificationHub AdmCredential.
AdmCredentialProperties	Opis obiektu NotificationHub AdmCredential.
ApnsCredential	Opis obiektu NotificationHub ApnsCredential.
ApnsCredentialProperties	Opis obiektu NotificationHub ApnsCredential.
BaiduCredential	Opis obiektu NotificationHub BaiduCredential.
BaiduCredentialProperties	Opis obiektu NotificationHub BaiduCredential.
BrowserCredential	Opis obiektu NotificationHub BrowserCredential.
BrowserCredentialProperties	Opis obiektu NotificationHub BrowserCredential.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GcmCredential	Opis obiektu NotificationHub GcmCredential.
GcmCredentialProperties	Opis obiektu NotificationHub GcmCredential.
MpnsCredential	Opis obiektu NotificationHub MpnsCredential.
MpnsCredentialProperties	Opis obiektu NotificationHub MpnsCredential.
NotificationHubProperties	Właściwości usługi NotificationHub.
NotificationHubResource	Zasób centrum powiadomień.
SharedAccessAuthorizationRuleProperties	Właściwości SharedAccessAuthorizationRule.
Sku	Opis jednostki SKU dla przestrzeni nazw
SkuName	Nazwa jednostki SKU przestrzeni nazw.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
WnsCredential	Opis obiektu NotificationHub WnsCredential.
WnsCredentialProperties	Opis obiektu NotificationHub WnsCredential.
XiaomiCredential	Opis powiadomienia XiaomiCredential.
XiaomiCredentialProperties	Opis właściwości PowiadomieniaHub XiaomiCredentialProperties.

AccessRights

Definiuje wartości accessRights.

Nazwa	Typ	Opis
Listen	string
Manage	string
Send	string

AdmCredential

Opis obiektu NotificationHub AdmCredential.

Nazwa	Typ	Opis
properties	AdmCredentialProperties	Opis obiektu NotificationHub AdmCredential.

AdmCredentialProperties

Opis obiektu NotificationHub AdmCredential.

Nazwa	Typ	Opis
authTokenUrl	string	Pobiera lub ustawia adres URL tokenu autoryzacji.
clientId	string	Pobiera lub ustawia identyfikator klienta.
clientSecret	string	Pobiera lub ustawia klucz dostępu wpisu tajnego poświadczeń.

ApnsCredential

Opis obiektu NotificationHub ApnsCredential.

Nazwa	Typ	Opis
properties	ApnsCredentialProperties	Opis obiektu NotificationHub ApnsCredential.

ApnsCredentialProperties

Opis obiektu NotificationHub ApnsCredential.

Nazwa	Typ	Opis
apnsCertificate	string	Pobiera lub ustawia certyfikat usługi APNS.
appId	string	Pobiera lub ustawia wystawcę (iss) zarejestrowany klucz oświadczenia, którego wartość to 10-znakowy identyfikator zespołu uzyskany z konta dewelopera
appName	string	Pobiera lub ustawia nazwę aplikacji
certificateKey	string	Pobiera lub ustawia klucz certyfikatu.
endpoint	string	Pobiera lub ustawia punkt końcowy tego poświadczenia.
keyId	string	Pobiera lub ustawia 10-znakowy klucz klucza (dziecko) uzyskany z konta dewelopera
thumbprint	string	Pobiera lub ustawia odcisk palca certyfikatu usługi APNS
token	string	Pobiera lub ustawia token uwierzytelniania dostawcy uzyskany za pośrednictwem konta dewelopera

BaiduCredential

Opis obiektu NotificationHub BaiduCredential.

Nazwa	Typ	Opis
properties	BaiduCredentialProperties	Opis obiektu NotificationHub BaiduCredential.

BaiduCredentialProperties

Opis obiektu NotificationHub BaiduCredential.

Nazwa	Typ	Opis
baiduApiKey	string	Pobiera lub ustawia klucz interfejsu API baidu.
baiduEndPoint	string	Pobiera lub ustawia punkt końcowy baidu.
baiduSecretKey	string	Pobiera lub ustawia klucz tajny baidu

BrowserCredential

Opis obiektu NotificationHub BrowserCredential.

Nazwa	Typ	Opis
properties	BrowserCredentialProperties	Opis obiektu NotificationHub BrowserCredential.

BrowserCredentialProperties

Opis obiektu NotificationHub BrowserCredential.

Nazwa	Typ	Opis
subject	string	Pobiera lub ustawia temat wypychania internetowego.
vapidPrivateKey	string	Pobiera lub ustawia klucz prywatny VAPID.
vapidPublicKey	string	Pobiera lub ustawia klucz publiczny VAPID.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

GcmCredential

Opis obiektu NotificationHub GcmCredential.

Nazwa	Typ	Opis
properties	GcmCredentialProperties	Opis obiektu NotificationHub GcmCredential.

GcmCredentialProperties

Opis obiektu NotificationHub GcmCredential.

Nazwa	Typ	Opis
gcmEndpoint	string	Pobiera lub ustawia punkt końcowy usługi GCM.
googleApiKey	string	Pobiera lub ustawia klucz interfejsu API Google.

MpnsCredential

Opis obiektu NotificationHub MpnsCredential.

Nazwa	Typ	Opis
properties	MpnsCredentialProperties	Opis obiektu NotificationHub MpnsCredential.

MpnsCredentialProperties

Opis obiektu NotificationHub MpnsCredential.

Nazwa	Typ	Opis
certificateKey	string	Pobiera lub ustawia klucz certyfikatu dla tego poświadczenia.
mpnsCertificate	string	Pobiera lub ustawia certyfikat MPNS.
thumbprint	string	Pobiera lub ustawia odcisk palca certyfikatu MPNS

NotificationHubProperties

Właściwości usługi NotificationHub.

Nazwa	Typ	Opis
admCredential	AdmCredential	Opis obiektu NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Opis obiektu NotificationHub ApnsCredential.
authorizationRules	SharedAccessAuthorizationRuleProperties[]	Pobiera lub ustawia reguły autoryzacji utworzonego elementu NotificationHub
baiduCredential	BaiduCredential	Opis obiektu NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Opis obiektu NotificationHub BrowserCredential.
dailyMaxActiveDevices	integer
gcmCredential	GcmCredential	Opis obiektu NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Opis obiektu NotificationHub MpnsCredential.
name	string	Pobiera lub ustawia nazwę usługi NotificationHub.
registrationTtl	string	Pobiera lub ustawia wartość RegistrationTtl utworzonej usługi NotificationHub
wnsCredential	WnsCredential	Opis obiektu NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Opis powiadomienia XiaomiCredential.

NotificationHubResource

Zasób centrum powiadomień.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties	NotificationHubProperties	Właściwości usługi NotificationHub.
sku	Sku	Opis jednostki SKU dla przestrzeni nazw
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Właściwości SharedAccessAuthorizationRule.

Nazwa	Typ	Opis
claimType	string	Pobiera ciąg opisujący typ oświadczenia
claimValue	string	Pobiera ciąg opisujący wartość oświadczenia
createdTime	string	Pobiera czas utworzenia dla tej reguły
keyName	string	Pobiera ciąg opisujący regułę autoryzacji.
modifiedTime	string	Pobiera czas ostatniej modyfikacji dla tej reguły
primaryKey	string	Pobiera 256-bitowy klucz podstawowy zakodowany w formacie Base64 na potrzeby podpisywania i weryfikowania tokenu SAS.
revision	integer	Pobiera numer poprawki dla reguły
rights	AccessRights[]	Pobiera lub ustawia prawa skojarzone z regułą.
secondaryKey	string	Pobiera 256-bitowy klucz podstawowy zakodowany w formacie Base64 na potrzeby podpisywania i weryfikowania tokenu SAS.

Sku

Opis jednostki SKU dla przestrzeni nazw

Nazwa	Typ	Opis
capacity	integer	Pobiera lub ustawia pojemność zasobu
family	string	Pobiera lub ustawia rodzinę jednostek SKU
name	SkuName	Nazwa jednostki SKU przestrzeni nazw.
size	string	Pobiera lub ustawia rozmiar jednostki SKU
tier	string	Pobiera lub ustawia warstwę konkretnej jednostki SKU

SkuName

Nazwa jednostki SKU przestrzeni nazw.

Nazwa	Typ	Opis
Basic	string
Free	string
Standard	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

WnsCredential

Opis obiektu NotificationHub WnsCredential.

Nazwa	Typ	Opis
properties	WnsCredentialProperties	Opis obiektu NotificationHub WnsCredential.

WnsCredentialProperties