Gateway Hostname Configuration - Create Or Update

Dienst:

API Management

API-Version:

2024-05-01

Erstellt die Konfiguration des Updates hostnamen für ein Gateway.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayId	path	True	string minLength: 1 maxLength: 80	Gatewayentitätsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Darf keinen Wert 'verwaltet' haben
hcId	path	True	string minLength: 1 maxLength: 80	Konfigurationsbezeichner für Gatewayhosts. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name	Typ	Beschreibung
properties.certificateId	string	Bezeichner der Zertifikatentität, die für die TLS-Verbindungseinrichtung verwendet wird
properties.hostname	string	Hostnamenwert. Unterstützt gültigen Domänennamen, teilweise oder vollständige Wildcards
properties.http2Enabled	boolean	Gibt an, ob HTTP/2.0 unterstützt wird.
properties.negotiateClientCertificate	boolean	Bestimmt, ob das Clientzertifikat des Gateways anfordert
properties.tls10Enabled	boolean	Gibt an, ob TLS 1.0 unterstützt wird.
properties.tls11Enabled	boolean	Gibt an, ob TLS 1.1 unterstützt wird.

Antworten

Name	Typ	Beschreibung
200 OK	GatewayHostnameConfigurationContract	Die Konfigurationsdetails des Gatewayhosts wurden erfolgreich aktualisiert. Header ETag: string
201 Created	GatewayHostnameConfigurationContract	Die neue Konfiguration des Gatewayhosts wurde erfolgreich erstellt. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreateGatewayHostnameConfiguration

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GatewayHostnameConfigurationContract	Konfigurationsdetails für Gatewayhosts.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GatewayHostnameConfigurationContract

Objekt

Konfigurationsdetails für Gatewayhosts.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.certificateId	string	Bezeichner der Zertifikatentität, die für die TLS-Verbindungseinrichtung verwendet wird
properties.hostname	string	Hostnamenwert. Unterstützt gültigen Domänennamen, teilweise oder vollständige Wildcards
properties.http2Enabled	boolean	Gibt an, ob HTTP/2.0 unterstützt wird.
properties.negotiateClientCertificate	boolean	Bestimmt, ob das Clientzertifikat des Gateways anfordert
properties.tls10Enabled	boolean	Gibt an, ob TLS 1.0 unterstützt wird.
properties.tls11Enabled	boolean	Gibt an, ob TLS 1.1 unterstützt wird.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"