Partager via


Tenant Access - Update

Mettre à jour les détails des informations d’accès du locataire.

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

Paramètres URI

Nom Dans Obligatoire Type Description
accessName
path True

AccessIdName

Identificateur de la configuration Access.

resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. 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.

En-tête de la demande

Nom Obligatoire Type Description
If-Match True

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom Type Description
properties.enabled

boolean

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

Réponses

Nom Type Description
200 OK

AccessInformationContract

Les informations d’accès au locataire ont été mises à jour avec succès.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

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

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementUpdateTenantAccess

Exemple de requête

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


{
  "properties": {
    "enabled": true
  }
}

Exemple de réponse

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

Définitions

Nom Description
AccessIdName

Identificateur de la configuration Access.

AccessInformationContract

Paramètres du locataire.

AccessInformationUpdateParameters

Paramètres de mise à jour des informations d’accès client.

ErrorFieldContract

Contrat champ d’erreur.

ErrorResponse

Réponse d’erreur.

AccessIdName

Identificateur de la configuration Access.

Nom Type Description
access

string

gitAccess

string

AccessInformationContract

Paramètres du locataire.

Nom 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.Storage/storageAccounts »

AccessInformationUpdateParameters

Paramètres de mise à jour des informations d’accès client.

Nom Type Description
properties.enabled

boolean

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

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

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

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom 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

ErrorFieldContract[]

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.