Gateway Hostname Configuration - Create Or Update

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Cria uma configuração de nome de host de atualizações para um Gateway.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidade de gateway. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Não deve ter o valor 'gerenciado'
hcId	path	True	string minLength: 1 maxLength: 80	Identificador de configuração do nome do host do gateway. Deve ser exclusivo no escopo da entidade de Gateway pai.
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 uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome	Tipo	Description
properties.certificateId	string	Identificador da entidade Certificate que será usada para o estabelecimento de 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

Respostas

Nome	Tipo	Description
200 OK	GatewayHostnameConfigurationContract	Os detalhes da configuração do nome do host do Gateway foram atualizados com êxito. Cabeçalhos ETag: string
201 Created	GatewayHostnameConfigurationContract	A nova configuração de nome de host do Gateway foi criada com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

GatewayHostnameConfigurationContract

Os detalhes da configuração do nome do host do Gateway foram atualizados com êxito.

Cabeçalhos

ETag: string

201 Created

GatewayHostnameConfigurationContract

A nova configuração de nome de host do Gateway foi criada com êxito.

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

ApiManagementCreateGatewayHostnameConfiguration

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2024-05-01

{
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Resposta de exemplo

Código de status:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GatewayHostnameConfigurationContract	Detalhes da configuração do nome do host do gateway.

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.

GatewayHostnameConfigurationContract

Objeto

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 de 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	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Compartilhar via

Gateway Hostname Configuration - Create Or Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementCreateGatewayHostnameConfiguration

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayHostnameConfigurationContract

Recursos adicionais