Partager via


OpenId Connect Provider - Update

Mises à jour le fournisseur OpenID Connect spécifique.

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

Paramètres URI

Nom Dans Obligatoire Type Description
opid
path True

string

Identificateur du fournisseur OpenID Connect.

Modèle d’expression régulière: ^[^*#&+:<>?]+$

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

En-tête de la demande

Nom Obligatoire Type Description
If-Match True

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir 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.clientId

string

ID client de la console du développeur, qui est l’application cliente.

properties.clientSecret

string

Clé secrète client de la console du développeur, qui est l’application cliente.

properties.description

string

Description conviviale du fournisseur OpenID Connect.

properties.displayName

string

Nom du fournisseur OpenID Connect convivial.

properties.metadataEndpoint

string

URI du point de terminaison de métadonnées.

Réponses

Nom Type Description
200 OK

OpenidConnectProviderContract

Le fournisseur OpenIdConnect a été correctement mis à jour.

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

ApiManagementUpdateOpenIdConnectProvider

Exemple de requête

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


{
  "properties": {
    "clientSecret": "updatedsecret"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect2",
  "properties": {
    "displayName": "templateoidprovider2",
    "description": "open id provider template2",
    "metadataEndpoint": "https://oidprovider-template2.net",
    "clientId": "oidprovidertemplate2"
  }
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

OpenidConnectProviderContract

Détails du fournisseur OpenId Connect.

OpenidConnectProviderUpdateContract

Paramètres fournis à l’opération Mettre à jour le fournisseur OpenID Connect.

ErrorFieldContract

Contrat de 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 des propriétés.

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.

OpenidConnectProviderContract

Détails du fournisseur OpenId Connect.

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

string

ID client de la console du développeur, qui est l’application cliente.

properties.clientSecret

string

Clé secrète client de la console du développeur, qui est l’application cliente.

properties.description

string

Description conviviale du fournisseur OpenID Connect.

properties.displayName

string

Nom du fournisseur OpenID Connect convivial.

properties.metadataEndpoint

string

URI du point de terminaison de métadonnées.

type

string

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

OpenidConnectProviderUpdateContract

Paramètres fournis à l’opération Mettre à jour le fournisseur OpenID Connect.

Nom Type Description
properties.clientId

string

ID client de la console du développeur, qui est l’application cliente.

properties.clientSecret

string

Clé secrète client de la console du développeur, qui est l’application cliente.

properties.description

string

Description conviviale du fournisseur OpenID Connect.

properties.displayName

string

Nom du fournisseur OpenID Connect convivial.

properties.metadataEndpoint

string

URI du point de terminaison de métadonnées.