Gateway - Generate Token

Servicio:

API Management

Versión de la API:

2024-05-01

Obtiene el token de autorización de acceso compartido para la puerta de enlace.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
expiry	True	string (date-time)	Hora de expiración del token. El tiempo máximo de expiración del token se establece en 30 días. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
keyType	True	KeyType	Clave que se va a usar para generar el token de puerta de enlace.

Respuestas

Nombre	Tipo	Description
200 OK	GatewayTokenContract	El cuerpo de la respuesta contiene el token de autorización de la puerta de enlace.
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

ApiManagementGatewayGenerateToken

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2024-05-01

{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Respuesta de muestra

status code:

200

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GatewayTokenContract	Token de acceso de puerta de enlace.
GatewayTokenRequestContract	Propiedades del contrato de solicitud de token de puerta de enlace.
KeyType	Clave que se está regenerando.

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.

GatewayTokenContract

Object

Token de acceso de puerta de enlace.

Nombre	Tipo	Description
value	string	Valor del token de autenticación de acceso compartido para la puerta de enlace.

GatewayTokenRequestContract

Object

Propiedades del contrato de solicitud de token de puerta de enlace.

Nombre	Tipo	Valor predeterminado	Description
expiry	string (date-time)		Hora de expiración del token. El tiempo máximo de expiración del token se establece en 30 días. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
keyType	KeyType	primary	Clave que se va a usar para generar el token de puerta de enlace.

KeyType

Enumeración

Clave que se está regenerando.

Valor	Description
primary
secondary