Namespaces - Create Or Update Authorization Rule

Dienst:

Notification Hubs

API-Version:

2023-09-01

Erstellt eine Autorisierungsregel für einen Namespace

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationRuleName	path	True	string minLength: 1 maxLength: 256 pattern: ^[a-zA-Z0-9!()*-._]+$	Name der Autorisierungsregel
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
location	string	Veraltet – nur aus Kompatibilitätsgründen.
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule-Eigenschaften.
tags	object	Veraltet – nur aus Kompatibilitätsgründen.

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-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Namespaces_CreateOrUpdateAuthorizationRule

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

201

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

Definitionen

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

AccessRights

Enumeration

Definiert Werte für AccessRights.

Wert	Beschreibung
Manage
Send
Listen

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SharedAccessAuthorizationRuleProperties

Objekt

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 (date-time)	Ruft die erstellungszeit für diese Regel ab.
keyName	string	Ruft eine Zeichenfolge ab, die die Autorisierungsregel beschreibt.
modifiedTime	string (date-time)	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 Validieren des SAS-Tokens ab.
revision	integer (int32)	Ruft die Revisionsnummer für die Regel ab.
rights	AccessRights[]	Ruft die Rechte ab, die der Regel zugeordnet sind, oder legt diese fest.
secondaryKey	string	Ruft einen base64-codierten 256-Bit-Primärschlüssel zum Signieren und Validieren des SAS-Tokens ab.

SharedAccessAuthorizationRuleResource

Objekt

Antwort für POST-Anforderungen, die einzelne SharedAccessAuthorizationRule zurückgeben.

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

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.