Namespaces - Create Or Update

Referenz

Dienst:: Notification Hubs

API-Version:: 2023-09-01

Erstellt /Updates einen Notification Hub-Namespace. Dieser Vorgang ist idempotent.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string	Namespacename RegEx-Muster: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
sku	True	Sku	Die Sku-Beschreibung für einen Namespace
properties		NamespaceProperties	Stellt Namespaceeigenschaften dar.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	NamespaceResource	Aktualisiert
201 Created	NamespaceResource	Erstellt
Other Status Codes	ErrorResponse	Fehlercode mit Grund.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Namespaces_CreateOrUpdate

Beispielanforderung

HTTP

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

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "name": "nh-sdk-ns",
    "provisioningState": "Succeeded",
    "status": "Created",
    "enabled": true,
    "critical": false,
    "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40",
    "createdAt": "2023-04-26T06:10:44.01+00:00",
    "updatedAt": "2023-04-26T06:16:17.697+00:00",
    "namespaceType": "NotificationHub",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    },
    "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/",
    "privateEndpointConnections": []
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Statuscode:: 201

{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "InProgress",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    }
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definitionen

Name	Beschreibung
AccessRights	Definiert Werte für AccessRights.
AdmCredential	Beschreibung eines NotificationHub AdmCredential.
AdmCredentialProperties	Beschreibung eines NotificationHub AdmCredential.
ApnsCredential	Beschreibung eines NotificationHub-ApnsCredential.
ApnsCredentialProperties	Beschreibung eines NotificationHub-ApnsCredential.
BaiduCredential	Beschreibung eines NotificationHub BaiduCredential.
BaiduCredentialProperties	Beschreibung eines NotificationHub BaiduCredential.
BrowserCredential	Beschreibung einer NotificationHub-Browserinformation.
BrowserCredentialProperties	Beschreibung einer NotificationHub-Browserinformation.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GcmCredential	Beschreibung eines NotificationHub GcmCredential.
GcmCredentialProperties	Beschreibung eines NotificationHub GcmCredential.
IpRule	Eine Netzwerkautorisierungsregel, die den Datenverkehr basierend auf der IP-Adresse filtert.
MpnsCredential	Beschreibung eines NotificationHub MpnsCredential.
MpnsCredentialProperties	Beschreibung eines NotificationHub MpnsCredential.
NamespaceProperties	Stellt Namespaceeigenschaften dar.
NamespaceResource	Notification Hubs-Namespaceressource.
NamespaceStatus	Namespace status.
NamespaceType	Definiert Werte für NamespaceType.
NetworkAcls	Eine Sammlung von Netzwerkautorisierungsregeln.
OperationProvisioningState	Definiert Werte für OperationProvisioningState.
PnsCredentials	Sammlung von Notification Hub- oder Notification Hub-Namespace-PNS-Anmeldeinformationen.
PrivateEndpointConnectionProperties	Verbindungseigenschaften des privaten Endpunkts.
PrivateEndpointConnectionProvisioningState	Zustand der Verbindung mit privatem Endpunkt.
PrivateEndpointConnectionResource	Stellt eine ARM-Ressource für private Endpunktverbindung dar – eine Unterressource des Notification Hubs-Namespace.
PrivateLinkConnectionStatus	Status der Private Link Verbindung.
PublicInternetAuthorizationRule	Eine Standard-Netzwerkautorisierungsregel (öffentliches Internet), die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt.
PublicNetworkAccess	Art des Öffentlichen Netzwerkzugriffs.
RemotePrivateEndpointConnection	Stellt einen privaten Endpunkt dar, der mit dem Notification Hubs-Namespace über private Endpunktverbindung verbunden ist.
RemotePrivateLinkServiceConnectionState	Status der Private Link Dienstverbindung.
ReplicationRegion	Zulässige Replikationsregion
Sku	Die Sku-Beschreibung für einen Namespace
SkuName	Name der Namespace-SKU.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
WnsCredential	Beschreibung eines NotificationHub WnsCredential.
WnsCredentialProperties	Beschreibung eines NotificationHub WnsCredential.
XiaomiCredential	Beschreibung eines NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Beschreibung eines NotificationHub XiaomiCredentialProperties.
ZoneRedundancyPreference	Name der Namespace-SKU.

AccessRights

Definiert Werte für AccessRights.

Name	Typ	Beschreibung
Listen	string
Manage	string
Send	string

AdmCredential

Beschreibung eines NotificationHub AdmCredential.

Name	Typ	Beschreibung
properties	AdmCredentialProperties	Beschreibung eines NotificationHub AdmCredential.

AdmCredentialProperties

Beschreibung eines NotificationHub AdmCredential.

Name	Typ	Beschreibung
authTokenUrl	string	Ruft die URL des Autorisierungstokens ab oder legt sie fest.
clientId	string	Ruft den Clientbezeichner ab oder legt diese fest.
clientSecret	string	Ruft den geheimen Zugriffsschlüssel für Anmeldeinformationen ab oder legt diese fest.

ApnsCredential

Beschreibung eines NotificationHub-ApnsCredential.

Name	Typ	Beschreibung
properties	ApnsCredentialProperties	Beschreibung eines NotificationHub-ApnsCredential.

ApnsCredentialProperties

Beschreibung eines NotificationHub-ApnsCredential.

Name	Typ	Beschreibung
apnsCertificate	string	Ruft das APNS-Zertifikat ab oder legt es fest.
appId	string	Ruft den vom Aussteller (iss) registrierten Anspruchsschlüssel ab, dessen Wert Ihre 10-stellige Team-ID ist, die aus Ihrem Entwicklerkonto abgerufen wurde, oder legt den registrierten Anspruchsschlüssel fest.
appName	string	Ruft den Namen der Anwendung ab oder legt den Namen fest.
certificateKey	string	Ruft den Zertifikatschlüssel ab oder legt den Zertifikatschlüssel fest.
endpoint	string	Ruft den Endpunkt dieser Anmeldeinformationen ab oder legt diesen fest.
keyId	string	Ruft einen 10-stelligen Schlüssel(Kid)-Schlüssel ab, der von Ihrem Entwicklerkonto abgerufen wurde, oder legt diesen fest.
thumbprint	string	Ruft den APNS-Zertifikatfingerabdruck ab oder legt diesen fest.
token	string	Ruft das Anbieterauthentifizierungstoken ab, das über Ihr Entwicklerkonto abgerufen wird, oder legt es fest.

BaiduCredential

Beschreibung eines NotificationHub BaiduCredential.

Name	Typ	Beschreibung
properties	BaiduCredentialProperties	Beschreibung eines NotificationHub BaiduCredential.

BaiduCredentialProperties

Beschreibung eines NotificationHub BaiduCredential.

Name	Typ	Beschreibung
baiduApiKey	string	Ruft den baidu-Api-Schlüssel ab oder legt diese fest.
baiduEndPoint	string	Ruft baidu-Endpunkt ab oder legt diese fest.
baiduSecretKey	string	Ruft den geheimen Baidu-Schlüssel ab oder legt diese fest.

BrowserCredential

Beschreibung einer NotificationHub-Browserinformation.

Name	Typ	Beschreibung
properties	BrowserCredentialProperties	Beschreibung einer NotificationHub-Browserinformation.

BrowserCredentialProperties

Beschreibung einer NotificationHub-Browserinformation.

Name	Typ	Beschreibung
subject	string	Ruft den Webpush-Betreff ab oder legt ihn fest.
vapidPrivateKey	string	Ruft den privaten VAPID-Schlüssel ab oder legt diese fest.
vapidPublicKey	string	Ruft den öffentlichen VAPID-Schlüssel ab oder legt diese fest.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GcmCredential

Beschreibung eines NotificationHub GcmCredential.

Name	Typ	Beschreibung
properties	GcmCredentialProperties	Beschreibung eines NotificationHub GcmCredential.

GcmCredentialProperties

Beschreibung eines NotificationHub GcmCredential.

Name	Typ	Beschreibung
gcmEndpoint	string	Ruft den GCM-Endpunkt ab oder legt diese fest.
googleApiKey	string	Ruft den Google-API-Schlüssel ab oder legt diese fest.

IpRule

Eine Netzwerkautorisierungsregel, die den Datenverkehr basierend auf der IP-Adresse filtert.

Name	Typ	Beschreibung
ipMask	string	IP-Maske.
rights	AccessRights[]	Liste der Zugriffsrechte.

MpnsCredential

Beschreibung eines NotificationHub MpnsCredential.

Name	Typ	Beschreibung
properties	MpnsCredentialProperties	Beschreibung eines NotificationHub MpnsCredential.

MpnsCredentialProperties

Beschreibung eines NotificationHub MpnsCredential.

Name	Typ	Beschreibung
certificateKey	string	Ruft den Zertifikatschlüssel für diese Anmeldeinformationen ab oder legt diesen fest.
mpnsCertificate	string	Ruft das MPNS-Zertifikat ab oder legt es fest.
thumbprint	string	Ruft den MPNS-Zertifikatfingerabdruck ab oder legt diesen fest.

NamespaceProperties

Stellt Namespaceeigenschaften dar.

Name	Typ	Standardwert	Beschreibung
createdAt	string		Zeitpunkt, zu dem der Namespace erstellt wurde.
critical	boolean		Ruft ab oder legt fest, ob der Namespace als Kritisch festgelegt ist.
dataCenter	string		Veraltet.
enabled	boolean		Ruft ab oder legt fest, ob der Namespace derzeit aktiviert ist.
metricId	string		Id für Azure Insights-Metriken.
name	string		Name des Notification Hubs-Namespaces. Dies ist eine unveränderliche Eigenschaft, die automatisch vom Dienst festgelegt wird, wenn der Namespace erstellt wird.
namespaceType	NamespaceType		Definiert Werte für NamespaceType.
networkAcls	NetworkAcls		Eine Sammlung von Netzwerkautorisierungsregeln.
pnsCredentials	PnsCredentials		Sammlung von Notification Hub- oder Notification Hub-Namespace-PNS-Anmeldeinformationen.
privateEndpointConnections	PrivateEndpointConnectionResource[]		Private Endpunkt-Connections für Namespace
provisioningState	OperationProvisioningState		Definiert Werte für OperationProvisioningState.
publicNetworkAccess	PublicNetworkAccess	Enabled	Art des Öffentlichen Netzwerkzugriffs.
region	string		Region Der Wert wird immer auf denselben Wert wie Namespace.Location festgelegt, sodass diese Eigenschaft veraltet ist.
replicationRegion	ReplicationRegion		Zulässige Replikationsregion
scaleUnit	string		Ruft scaleUnit ab, an dem der Namespace erstellt wird, oder legt diese fest.
serviceBusEndpoint	string		Ruft den Endpunkt ab, den Sie zum Ausführen von NotificationHub-Vorgängen verwenden können, oder legt diesen fest.
status	NamespaceStatus		Namespace status.
subscriptionId	string		Namespaceabonnement-ID.
updatedAt	string		Zeitpunkt, zu dem der Namespace aktualisiert wurde.
zoneRedundancy	ZoneRedundancyPreference	Disabled	Name der Namespace-SKU.

NamespaceResource

Notification Hubs-Namespaceressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties	NamespaceProperties	Stellt Namespaceeigenschaften dar.
sku	Sku	Die Sku-Beschreibung für einen Namespace
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NamespaceStatus

Namespace status.

Name	Typ	Beschreibung
Created	string
Creating	string
Deleting	string
Suspended	string

NamespaceType

Definiert Werte für NamespaceType.

Name	Typ	Beschreibung
Messaging	string
NotificationHub	string

NetworkAcls

Eine Sammlung von Netzwerkautorisierungsregeln.

Name	Typ	Beschreibung
ipRules	IpRule[]	Liste der IP-Regeln.
publicNetworkRule	PublicInternetAuthorizationRule	Eine Standard-Netzwerkautorisierungsregel (öffentliches Internet), die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt.

OperationProvisioningState

Definiert Werte für OperationProvisioningState.

Name	Typ	Beschreibung
Canceled	string
Disabled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string
Unknown	string

PnsCredentials

Sammlung von Notification Hub- oder Notification Hub-Namespace-PNS-Anmeldeinformationen.

Name	Typ	Beschreibung
admCredential	AdmCredential	Beschreibung eines NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Beschreibung eines NotificationHub-ApnsCredential.
baiduCredential	BaiduCredential	Beschreibung eines NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Beschreibung einer NotificationHub-Browserinformation.
gcmCredential	GcmCredential	Beschreibung eines NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Beschreibung eines NotificationHub MpnsCredential.
wnsCredential	WnsCredential	Beschreibung eines NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Beschreibung eines NotificationHub XiaomiCredential.

PrivateEndpointConnectionProperties

Verbindungseigenschaften des privaten Endpunkts.

Name	Typ	Beschreibung
groupIds	string[]	Liste der Gruppen-IDs. Für Notification Hubs enthält es immer ein einzelnes "namespace"-Element.
privateEndpoint	RemotePrivateEndpointConnection	Stellt einen privaten Endpunkt dar, der mit dem Notification Hubs-Namespace über private Endpunktverbindung verbunden ist.
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	Status der Private Link Dienstverbindung.
provisioningState	PrivateEndpointConnectionProvisioningState	Zustand der Verbindung mit privatem Endpunkt.

PrivateEndpointConnectionProvisioningState

Zustand der Verbindung mit privatem Endpunkt.

Name	Typ	Beschreibung
Creating	string
Deleted	string
Deleting	string
DeletingByProxy	string
Succeeded	string
Unknown	string
Updating	string
UpdatingByProxy	string

PrivateEndpointConnectionResource

Stellt eine ARM-Ressource für private Endpunktverbindung dar – eine Unterressource des Notification Hubs-Namespace.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	PrivateEndpointConnectionProperties	Verbindungseigenschaften des privaten Endpunkts.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Status der Private Link Verbindung.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicInternetAuthorizationRule

Eine Standard-Netzwerkautorisierungsregel (öffentliches Internet), die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt.

Name	Typ	Beschreibung
rights	AccessRights[]	Liste der Zugriffsrechte.

PublicNetworkAccess

Art des Öffentlichen Netzwerkzugriffs.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

RemotePrivateEndpointConnection

Stellt einen privaten Endpunkt dar, der mit dem Notification Hubs-Namespace über private Endpunktverbindung verbunden ist.

Name	Typ	Beschreibung
id	string	ARM-Ressourcen-ID des privaten Endpunkts. Dies kann zu einem anderen Abonnement und einer anderen Ressourcengruppe gehören als ein Notification Hubs-Namespace.

RemotePrivateLinkServiceConnectionState

Status der Private Link Dienstverbindung.

Name	Typ	Beschreibung
actionsRequired	string	Menschenfreundliche Beschreibung erforderlicher Aktionen.
description	string	Menschenfreundliche Beschreibung.
status	PrivateLinkConnectionStatus	Status der Private Link Verbindung.

ReplicationRegion

Zulässige Replikationsregion

Name	Typ	Beschreibung
AustraliaEast	string
BrazilSouth	string
Default	string
None	string
NorthEurope	string
SouthAfricaNorth	string
SouthEastAsia	string
WestUs2	string

Sku

Die Sku-Beschreibung für einen Namespace

Name	Typ	Beschreibung
capacity	integer	Ruft die Kapazität der Ressource ab oder legt sie fest.
family	string	Ruft die Sku-Familie ab oder legt sie fest.
name	SkuName	Name der Namespace-SKU.
size	string	Ruft die SKU-Größe ab oder legt sie fest.
tier	string	Ruft die Ebene einer bestimmten SKU ab oder legt sie fest.

SkuName

Name der Namespace-SKU.

Name	Typ	Beschreibung
Basic	string
Free	string
Standard	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

WnsCredential

Beschreibung eines NotificationHub WnsCredential.

Name	Typ	Beschreibung
properties	WnsCredentialProperties	Beschreibung eines NotificationHub WnsCredential.

WnsCredentialProperties