OpenId Connect Provider - Update

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Actualiza el proveedor de OpenID Connect específico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
opid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador del proveedor de OpenID Connect.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.clientId	string	Id. de cliente de la consola de desarrollador, que es la aplicación cliente.
properties.clientSecret	string	Secreto de cliente de la consola del desarrollador, que es la aplicación cliente.
properties.description	string	Descripción fácil de usar del proveedor openID Connect.
properties.displayName	string maxLength: 50	Nombre del proveedor de OpenID Connect descriptivo.
properties.metadataEndpoint	string	URI del punto de conexión de metadatos.
properties.useInApiDocumentation	boolean	Si es true, el proveedor open ID Connect se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor.
properties.useInTestConsole	boolean	Si es true, el proveedor open ID Connect se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor.

Respuestas

Nombre	Tipo	Description
200 OK	OpenidConnectProviderContract	OpenIdConnect Provider se actualizó correctamente. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

OpenidConnectProviderContract

OpenIdConnect Provider se actualizó correctamente.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementUpdateOpenIdConnectProvider

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2?api-version=2024-05-01


{
  "properties": {
    "clientSecret": "updatedsecret",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
OpenidConnectProviderContract	Detalles del proveedor de OpenId Connect.
OpenidConnectProviderUpdateContract	Parámetros proporcionados a la operación Actualizar proveedor de OpenID Connect.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

OpenidConnectProviderContract

Object

Detalles del proveedor de OpenId Connect.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.clientId	string	Id. de cliente de la consola de desarrollador, que es la aplicación cliente.
properties.clientSecret	string	Secreto de cliente de la consola del desarrollador, que es la aplicación cliente.
properties.description	string	Descripción fácil de usar del proveedor openID Connect.
properties.displayName	string maxLength: 50	Nombre del proveedor de OpenID Connect descriptivo.
properties.metadataEndpoint	string	URI del punto de conexión de metadatos.
properties.useInApiDocumentation	boolean	Si es true, el proveedor open ID Connect se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor.
properties.useInTestConsole	boolean	Si es true, el proveedor open ID Connect se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"