Api Gateway Config Connection - Get

Serviço:

API Management

Versão da API:

2024-05-01

Obtém uma descrição do recurso de conexão de configuração do gateway de Gerenciamento de API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
configConnectionName	path	True	string minLength: 1 maxLength: 30 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome da conexão de configuração do gateway de Gerenciamento de API.
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do gateway de Gerenciamento de API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApiManagementGatewayConfigConnectionResource	Obtive com êxito o recurso de conexão de configuração do gateway de Gerenciamento de API.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementGetGatewayConfigConnection

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-01/configConnections/gcc-01?api-version=2024-05-01

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
  "name": "gcc-1",
  "type": "Microsoft.ApiManagement/gateways/configConnections",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "provisioningState": "Succeeded",
    "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
    "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net"
  }
}

Definições

Nome	Description
ApiManagementGatewayConfigConnectionResource	Um único recurso de gateway de Gerenciamento de API em Lista ou Obter resposta.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

ApiManagementGatewayConfigConnectionResource

Objeto

Um único recurso de gateway de Gerenciamento de API em Lista ou Obter resposta.

Nome	Tipo	Description
etag	string	ETag do recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.defaultHostname	string	O nome do host padrão do gateway de plano de dados.
properties.hostnames	string[]	Os nomes de host do gateway de plano de dados para os quais as solicitações podem ser enviadas.
properties.provisioningState	string	O estado de provisionamento atual da conexão de configuração do gateway de Gerenciamento de API
properties.sourceId	string (arm-id)	O link para o workspace do serviço gerenciamento de API.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.