Gateway - Generate Token

Serviço:

API Management

Versão da API:

2024-05-01

Obtém o Token de Autorização de Acesso Compartilhado para o gateway.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
expiry	True	string (date-time)	O tempo de expiração do token. O tempo máximo de expiração do token é definido como 30 dias. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
keyType	True	KeyType	A chave a ser usada para gerar token de gateway.

Respostas

Name	Tipo	Description
200 OK	GatewayTokenContract	O corpo da resposta contém o token de autorização para o gateway.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementGatewayGenerateToken

Pedido de amostra

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"
}

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GatewayTokenContract	Token de acesso ao gateway.
GatewayTokenRequestContract	Propriedades do contrato de solicitação de token de gateway.
KeyType	A chave sendo regenerada.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GatewayTokenContract

Object

Token de acesso ao gateway.

Name	Tipo	Description
value	string	Valor do token de Autenticação de Acesso Compartilhado para o Gateway.

GatewayTokenRequestContract

Object

Propriedades do contrato de solicitação de token de gateway.

Name	Tipo	Default value	Description
expiry	string (date-time)		O tempo de expiração do token. O tempo máximo de expiração do token é definido como 30 dias. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
keyType	KeyType	primary	A chave a ser usada para gerar token de gateway.

KeyType

Enumeração

A chave sendo regenerada.

Valor	Description
primary
secondary