Notification Hubs - Create Or Update Authorization Rule

Odwołanie

Usługa:: Notification Hubs

Wersja interfejsu API:: 2023-09-01

Tworzy/Aktualizacje regułę autoryzacji dla usługi NotificationHub

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
authorizationRuleName	path	True	string	Nazwa reguły autoryzacji Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9!()*-._]+$`
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	Typ	Opis
location	string	Przestarzałe — tylko w przypadku zgodności.
properties	SharedAccessAuthorizationRuleProperties	Właściwości SharedAccessAuthorizationRule.
tags	object	Przestarzałe — tylko w przypadku zgodności.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SharedAccessAuthorizationRuleResource	Po aktualizacji
201 Created	SharedAccessAuthorizationRuleResource	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_CreateOrUpdateAuthorizationRule

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

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

Przykładowa odpowiedź

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

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

Definicje

Nazwa	Opis
AccessRights	Definiuje wartości dla programu AccessRights.
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
SharedAccessAuthorizationRuleProperties	Właściwości SharedAccessAuthorizationRule.
SharedAccessAuthorizationRuleResource	Odpowiedź na żądania POST zwracające pojedynczą regułę SharedAccessAuthorizationRule.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AccessRights

Definiuje wartości dla programu AccessRights.

Nazwa	Typ	Opis
Listen	string
Manage	string
Send	string

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 błędu.

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

SharedAccessAuthorizationRuleResource

Odpowiedź na żądania POST zwracające pojedynczą regułę SharedAccessAuthorizationRule.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Przestarzałe — tylko w przypadku zgodności.
name	string	Nazwa zasobu
properties	SharedAccessAuthorizationRuleProperties	Właściwości SharedAccessAuthorizationRule.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Przestarzałe — tylko w przypadku zgodności.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (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.

Udostępnij za pośrednictwem