Partilhar via

Gateway Hostname Configuration - Create Or Update

Serviço:
API Management
Versão da API:
2024-05-01

Cria a configuração do nome do 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 do URI

Name Em Necessário Tipo Description
gatewayId
 path True

string

minLength: 1
maxLength: 80

Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter 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 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 um UUID.
api-version
 query True

string

minLength: 1

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

Cabeçalho do Pedido

Name Necessá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 do Pedido

Name Tipo Description
properties.certificateId

string

Identificador da entidade de certificado que será usada para o estabelecimento da conexão TLS
properties.hostname

string

Valor do nome do host. Suporta nome de domínio válido, curinga parcial ou total
properties.http2Enabled

boolean

Especifica se HTTP/2.0 é suportado
properties.negotiateClientCertificate

boolean

Determina se o gateway solicita certificado de cliente
properties.tls10Enabled

boolean

Especifica se o TLS 1.0 é suportado
properties.tls11Enabled

boolean

Especifica se o TLS 1.1 é suportado

Respostas

Name Tipo Description
200 OK

GatewayHostnameConfigurationContract

Os detalhes de configuração do nome de 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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementCreateGatewayHostnameConfiguration

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
GatewayHostnameConfigurationContract

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GatewayHostnameConfigurationContract

Object

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

Name Tipo Description
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.certificateId

string

Identificador da entidade de certificado que será usada para o estabelecimento da conexão TLS
properties.hostname

string

Valor do nome do host. Suporta nome de domínio válido, curinga parcial ou total
properties.http2Enabled

boolean

Especifica se HTTP/2.0 é suportado
properties.negotiateClientCertificate

boolean

Determina se o gateway solicita certificado de cliente
properties.tls10Enabled

boolean

Especifica se o TLS 1.0 é suportado
properties.tls11Enabled

boolean

Especifica se o TLS 1.1 é suportado
type

string

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