Authorization - Get

Dienst:

API Management

API-Version:

2024-05-01

Ruft die Details der durch den Bezeichner angegebenen Autorisierung ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Bezeichner der Autorisierung.
authorizationProviderId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Bezeichner des Autorisierungsanbieters.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
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.

Antworten

Name	Typ	Beschreibung
200 OK	AuthorizationContract	Der Antworttext enthält die angegebene Autorisierungsentität. Keine geheimen Schlüssel enthalten Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

ApiManagementGetAuthorization

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1",
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
  "name": "authz1",
  "properties": {
    "authorizationType": "OAuth2",
    "oauth2grantType": "AuthorizationCode",
    "status": "Connected"
  }
}

Definitionen

Name	Beschreibung
AuthorizationContract	Autorisierungsvertrag.
AuthorizationError	Details zu Autorisierungsfehlern.
AuthorizationType	Autorisierungstypoptionen
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
OAuth2GrantType	OAuth2-Erteilungstypoptionen

AuthorizationContract

Objekt

Autorisierungsvertrag.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.authorizationType	AuthorizationType	Autorisierungstypoptionen
properties.error	AuthorizationError
properties.oauth2grantType	OAuth2GrantType	OAuth2-Erteilungstypoptionen
properties.parameters	object	Autorisierungsparameter
properties.status	string	Status der Autorisierung
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AuthorizationError

Objekt

Details zu Autorisierungsfehlern.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung

AuthorizationType

Enumeration

Autorisierungstypoptionen

Wert	Beschreibung
OAuth2	OAuth2-Autorisierungstyp

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.

OAuth2GrantType

Enumeration

OAuth2-Erteilungstypoptionen

Wert	Beschreibung
AuthorizationCode	Autorisierungscode-Erteilung
ClientCredentials	Clientanmeldeinformationserteilung