Gateway Hostname Configuration - Create Or Update

Crea di aggiornamenti della configurazione del nome host per un 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

Parametri dell'URI

Name In Required Type Description
gatewayId
path True
  • string

Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'

hcId
path True
  • string

Identificatore di configurazione del nome host del gateway. Deve essere univoco nell'ambito dell'entità gateway padre.

resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio di Gestione API.

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

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

Intestazione della richiesta

Name Required Type Description
If-Match
  • string

ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Name Type Description
properties.certificateId
  • string

Identificatore dell'entità Certificato che verrà usata per la creazione della connessione TLS

properties.hostname
  • string

Valore del nome host. Supporta il nome di dominio valido, il carattere jolly parziale o completo

properties.http2Enabled
  • boolean

Specifica se è supportato HTTP/2.0

properties.negotiateClientCertificate
  • boolean

Determina se il gateway richiede il certificato client

properties.tls10Enabled
  • boolean

Specifica se TLS 1.0 è supportato

properties.tls11Enabled
  • boolean

Specifica se TLS 1.1 è supportato

Risposte

Name Type Description
200 OK

I dettagli di configurazione del nome host del gateway sono stati aggiornati correttamente.

Headers

  • ETag: string
201 Created

La nuova configurazione del nome host del gateway è stata creata correttamente.

Headers

  • ETag: string
Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

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 rappresentare l'account utente

Esempio

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
  }
}

Definizioni

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

GatewayHostnameConfigurationContract

Dettagli di configurazione del nome host del gateway.

ErrorFieldContract

Contratto campo di errore.

Name Type Description
code
  • string

Codice di errore a livello di proprietà.

message
  • string

Rappresentazione leggibile dell'errore a livello di proprietà.

target
  • string

Nome della proprietà.

ErrorResponse

Risposta errore.

Name Type Description
error.code
  • string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message
  • string

Rappresentazione leggibile dell'errore.

GatewayHostnameConfigurationContract

Dettagli di configurazione del nome host del gateway.

Name Type Description
id
  • string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nome della risorsa.

properties.certificateId
  • string

Identificatore dell'entità Certificato che verrà usata per la creazione della connessione TLS

properties.hostname
  • string

Valore del nome host. Supporta il nome di dominio valido, il carattere jolly parziale o completo

properties.http2Enabled
  • boolean

Specifica se è supportato HTTP/2.0

properties.negotiateClientCertificate
  • boolean

Determina se il gateway richiede il certificato client

properties.tls10Enabled
  • boolean

Specifica se TLS 1.0 è supportato

properties.tls11Enabled
  • boolean

Specifica se TLS 1.1 è supportato

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"