Compartilhar via


Gateway Hostname Configuration - Get

Obter detalhes de uma configuração de nome de host

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
gatewayId
path True

string

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

hcId
path True

string

Identificador de configuração do nome do host do gateway. Deve ser exclusivo no escopo da entidade de Gateway pai.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

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

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

GatewayHostnameConfigurationContract

O corpo da resposta contém a entidade gateway especificada.

Cabeçalhos

ETag: string

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

ApiManagementGetGatewayHostnameConfiguration

Solicitação de exemplo

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

Resposta de exemplo

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false
  }
}

Definições

Nome Description
ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

GatewayHostnameConfigurationContract

Detalhes da configuração do nome do host do gateway.

ErrorFieldContract

Contrato de Campo de Erro.

Nome Tipo Description
code

string

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

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo 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

ErrorFieldContract[]

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

error.message

string

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

GatewayHostnameConfigurationContract

Detalhes da configuração do nome do host do gateway.

Nome Tipo Description
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.certificateId

string

Identificador da entidade Certificate que será usada para o estabelecimento da conexão TLS

properties.hostname

string

Valor do nome do host. Dá suporte ao nome de domínio válido, curinga parcial ou completo

properties.http2Enabled

boolean

Especifica se há suporte para HTTP/2.0

properties.negotiateClientCertificate

boolean

Determina se o gateway solicita o certificado do cliente

properties.tls10Enabled

boolean

Especifica se o TLS 1.0 tem suporte

properties.tls11Enabled

boolean

Especifica se o TLS 1.1 tem suporte

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"