Tenant Access - Get

Dienst:

API Management

API-Version:

2024-05-01

Rufen Sie Details zum Mandantenzugriff ohne geheime Schlüssel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accessName	path	True	AccessIdName	Der Bezeichner der Access-Konfiguration.
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	AccessInformationContract	Informationen zum Mandantenzugriff. 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

ApiManagementGetTenantAccess

ApiManagementGetTenantGitAccess

ApiManagementGetTenantAccess

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access?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/tenant/access",
  "type": "Microsoft.ApiManagement/service/tenant",
  "name": "access",
  "properties": {
    "enabled": true
  }
}

ApiManagementGetTenantGitAccess

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess?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/tenant/gitAccess",
  "type": "Microsoft.ApiManagement/service/tenant",
  "name": "gitAccess",
  "properties": {
    "principalId": "git",
    "enabled": true
  }
}

Definitionen

Name	Beschreibung
AccessIdName	Der Bezeichner der Access-Konfiguration.
AccessInformationContract	Mandanteneinstellungen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AccessIdName

Enumeration

Der Bezeichner der Access-Konfiguration.

Wert	Beschreibung
access
gitAccess

AccessInformationContract

Objekt

Mandanteneinstellungen.

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.enabled	boolean	Bestimmt, ob der direkte Zugriff aktiviert ist.
properties.id	string	Access Information type ('access' or 'gitAccess')
properties.principalId	string	Prinzipalbezeichner (Benutzer).
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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.