Tenant Access - Get

Obtenez les détails de l’accès au locataire sans secrets.

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

Paramètres URI

Name In Required Type Description
accessName
path True

Identificateur de la configuration Access.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service Gestion des API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Informations d’identification de l’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande cliente.

Réponses

Name Type Description
200 OK

Informations d’accès au locataire.

Headers

  • ETag: string
Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunt d’identité de votre compte d’utilisateur

Exemples

ApiManagementGetTenantAccess
ApiManagementGetTenantGitAccess

ApiManagementGetTenantAccess

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access",
  "type": "Microsoft.ApiManagement/service/tenant",
  "name": "access",
  "properties": {
    "enabled": true
  }
}

ApiManagementGetTenantGitAccess

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess",
  "type": "Microsoft.ApiManagement/service/tenant",
  "name": "gitAccess",
  "properties": {
    "principalId": "git",
    "enabled": true
  }
}

Définitions

AccessIdName

Identificateur de la configuration Access.

AccessInformationContract

Paramètres de locataire.

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

AccessIdName

Identificateur de la configuration Access.

Name Type Description
access
  • string
gitAccess
  • string

AccessInformationContract

Paramètres de locataire.

Name Type Description
id
  • string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nom de la ressource.

properties.enabled
  • boolean

Détermine si l’accès direct est activé.

properties.id
  • string

Type d’informations d’accès ('access' ou 'gitAccess')

properties.principalId
  • string

Identificateur principal (utilisateur).

type
  • string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft ». Stockage/storageAccounts »

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible humaine de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.