Gateway Hostname Configuration - Create Or Update

Služba:

API Management

Verze rozhraní API:

2024-05-01

Vytvoří konfiguraci názvu hostitele aktualizací pro bránu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identifikátor entity brány. V aktuální instanci služby API Management musí být jedinečné. Nesmí mít hodnotu managed.
hcId	path	True	string minLength: 1 maxLength: 80	Identifikátor konfigurace názvu hostitele brány. Musí být jedinečný v oboru nadřazené entity brány.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Typ	Description
properties.certificateId	string	Identifikátor entity certifikátu, která se použije pro vytvoření připojení TLS
properties.hostname	string	Hodnota názvu hostitele. Podporuje platný název domény, částečný nebo úplný zástupný znak.
properties.http2Enabled	boolean	Určuje, jestli je podporováno HTTP/2.0.
properties.negotiateClientCertificate	boolean	Určuje, jestli brána požaduje klientský certifikát.
properties.tls10Enabled	boolean	Určuje, jestli se podporuje protokol TLS 1.0.
properties.tls11Enabled	boolean	Určuje, jestli je podporován protokol TLS 1.1.

Odpovědi

Name	Typ	Description
200 OK	GatewayHostnameConfigurationContract	Podrobnosti o konfiguraci názvu hostitele brány byly úspěšně aktualizovány. Hlavičky ETag: string
201 Created	GatewayHostnameConfigurationContract	Nová konfigurace názvu hostitele brány byla úspěšně vytvořena. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementCreateGatewayHostnameConfiguration

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
GatewayHostnameConfigurationContract	Podrobnosti konfigurace názvu hostitele brány

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GatewayHostnameConfigurationContract

Objekt

Podrobnosti konfigurace názvu hostitele brány

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.certificateId	string	Identifikátor entity certifikátu, která se použije pro vytvoření připojení TLS
properties.hostname	string	Hodnota názvu hostitele. Podporuje platný název domény, částečný nebo úplný zástupný znak.
properties.http2Enabled	boolean	Určuje, jestli je podporováno HTTP/2.0.
properties.negotiateClientCertificate	boolean	Určuje, jestli brána požaduje klientský certifikát.
properties.tls10Enabled	boolean	Určuje, jestli se podporuje protokol TLS 1.0.
properties.tls11Enabled	boolean	Určuje, jestli je podporován protokol TLS 1.1.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts