Gateway Hostname Configuration - Create Or Update

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=2021-12-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 do Gerenciamento de API atual. Não deve ter valor 'gerenciado'

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.

serviceName
path True
  • string

O nome do serviço Gerenciamento de API.

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.

Cabeçalho da solicitação

Name Required Type 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

Name Type Description
properties.certificateId
  • string

Identificador da entidade certificado que será usado 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 há suporte para TLS 1.0

properties.tls11Enabled
  • boolean

Especifica se o TLS 1.1 tem suporte

Respostas

Name Type Description
200 OK

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

Headers

  • ETag: string
201 Created

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

Headers

  • ETag: string
Other Status Codes

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

Segurança

azure_auth

Azure Active Directory Flow 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

ApiManagementCreateGatewayHostnameConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2021-12-01-preview

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

Sample Response

{
  "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,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}
{
  "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,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Definições

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

GatewayHostnameConfigurationContract

Detalhes de configuração do nome do host do 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 legí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 enviada na solicitação, em caso de erro de validação.

error.message
  • string

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

GatewayHostnameConfigurationContract

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

Name Type 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 certificado que será usado 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 há suporte para TLS 1.0

properties.tls11Enabled
  • boolean

Especifica se o TLS 1.1 tem suporte

type
  • string

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