Gateway - Get

Obtém os detalhes do Gateway especificado por seu identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2020-12-01

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.

Respostas

Name Type Description
200 OK

O corpo da resposta contém a entidade de Gateway especificada.

Headers

  • ETag: string
Other Status Codes

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

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

ApiManagementGetGateway

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Definições

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

GatewayContract

Detalhes do gateway.

ResourceLocationDataContract

Propriedades de dados do local do recurso.

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.

GatewayContract

Detalhes do gateway.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.description
  • string

Descrição do gateway

properties.locationData

Local do gateway.

type
  • string

Tipo de recurso para API Management recurso.

ResourceLocationDataContract

Propriedades de dados do local do recurso.

Name Type Description
city
  • string

A cidade ou a localidade em que o recurso está localizado.

countryOrRegion
  • string

O país ou a região em que o recurso está localizado.

district
  • string

O distrito, o estado ou a província em que o recurso está localizado.

name
  • string

Um nome canônico para a localização geográfica ou física.