Gateway - Generate Token

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=2020-06-01-preview

Parâmetros de URI

Name In Required Type Description
gatewayId
path True
  • string

Identificador de entidade de gateway. Deve ser exclusivo na instância de serviço API Management atual. Não deve ter o valor 'managed'

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço API Management serviço.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Name Required Type Description
expiry True
  • string

A hora 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 pelo padrão ISO 8601.

keyType True

A Chave a ser usada para gerar o token de gateway.

Respostas

Name Type Description
200 OK

O corpo da resposta contém o token de autorização para o gateway.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory fluxo OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementGatewayGenerateToken

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2020-06-01-preview
{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Sample Response

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

Definições

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

GatewayTokenContract

Token de acesso do gateway.

GatewayTokenRequestContract

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

KeyType

A Chave a ser usada para gerar o token de gateway.

ErrorFieldContract

Contrato de campo de erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação acessível por humanos de erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviado na solicitação, no caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

GatewayTokenContract

Token de acesso do gateway.

Name Type Description
value
  • string

Valor do token de Autenticação de Acesso Compartilhado para o Gateway.

GatewayTokenRequestContract

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

Name Type Description
expiry
  • string

A hora 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 pelo padrão ISO 8601.

keyType

A Chave a ser usada para gerar o token de gateway.

KeyType

A Chave a ser usada para gerar o token de gateway.

Name Type Description
primary
  • string
secondary
  • string