Notification Hubs - Create Or Update Authorization Rule

Referenz

Dienst:: Notification Hubs

API-Version:: 2023-09-01

Erstellt/Updates einer Autorisierungsregel für einen NotificationHub

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationRuleName	path	True	string	Name der Autorisierungsregel RegEx-Muster: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Namespacename RegEx-Muster: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Name des Benachrichtigungs-Hubs 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	Typ	Beschreibung
location	string	Veraltet – nur aus Gründen der Kompatibilität.
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule-Eigenschaften.
tags	object	Veraltet – nur aus Gründen der Kompatibilität.

Antworten

Name	Typ	Beschreibung
200 OK	SharedAccessAuthorizationRuleResource	Aktualisiert
201 Created	SharedAccessAuthorizationRuleResource	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

NotificationHubs_CreateOrUpdateAuthorizationRule

Beispielanforderung

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/authorizationRules/MyManageSharedAccessKey?api-version=2023-09-01

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T12:24:40.5863818+00:00",
    "createdTime": "2023-04-26T12:24:40.5863818+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey",
  "name": "MyManageSharedAccessKey",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules"
}

Statuscode:: 201

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T12:24:40.5863818+00:00",
    "createdTime": "2023-04-26T12:24:40.5863818+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey",
  "name": "MyManageSharedAccessKey",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules"
}

Definitionen

Name	Beschreibung
AccessRights	Definiert Werte für AccessRights.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule-Eigenschaften.
SharedAccessAuthorizationRuleResource	Antwort auf POST-Anforderungen, die eine einzelne SharedAccessAuthorizationRule zurückgeben.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AccessRights

Definiert Werte für AccessRights.

Name	Typ	Beschreibung
Listen	string
Manage	string
Send	string

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.

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule-Eigenschaften.

Name	Typ	Beschreibung
claimType	string	Ruft eine Zeichenfolge ab, die den Anspruchstyp beschreibt
claimValue	string	Ruft eine Zeichenfolge ab, die den Anspruchswert beschreibt
createdTime	string	Ruft die Erstellungszeit für diese Regel ab.
keyName	string	Ruft eine Zeichenfolge ab, die die Autorisierungsregel beschreibt.
modifiedTime	string	Ruft den Zeitpunkt der letzten Änderung für diese Regel ab.
primaryKey	string	Ruft einen Base64-codierten 256-Bit-Primärschlüssel zum Signieren und Überprüfen des SAS-Tokens ab.
revision	integer	Ruft die Revisionsnummer für die Regel ab.
rights	AccessRights[]	Ruft die rechte ab, die der Regel zugeordnet sind, oder legt sie fest.
secondaryKey	string	Ruft einen Base64-codierten 256-Bit-Primärschlüssel zum Signieren und Überprüfen des SAS-Tokens ab.

SharedAccessAuthorizationRuleResource

Antwort auf POST-Anforderungen, die eine einzelne SharedAccessAuthorizationRule zurückgeben.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Veraltet – nur aus Gründen der Kompatibilität.
name	string	Der Name der Ressource
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule-Eigenschaften.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Veraltet – nur aus Gründen der Kompatibilität.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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.

Freigeben über