Gateway Hostname Configuration - List By Service

Dienst:

API Management

API-Version:

2024-05-01

Listet die Sammlung von Hostnamenkonfigurationen für das angegebene Gateway auf.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?$filter={$filter}&$top={$top}&$skip={$skip}&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
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.
$filter	query		string	| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen | |-------------|-------------|-------------|-------------| | Name | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith | | Hostname | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith |
$skip	query		integer (int32) minimum: 0	Anzahl der zu überspringenden Datensätze.
$top	query		integer (int32) minimum: 1	Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	GatewayHostnameConfigurationCollection	Sammlung von Hostnamenkonfigurationsentitäten.
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

ApiManagementListGatewayHostnameConfigurations

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "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
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1",
      "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
      "name": "default",
      "properties": {
        "hostname": "foo.bar.com",
        "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2",
        "negotiateClientCertificate": true
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GatewayHostnameConfigurationCollection	Darstellung der Konfigurationsliste des Paged Gateway-Gateways.
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.

GatewayHostnameConfigurationCollection

Objekt

Darstellung der Konfigurationsliste des Paged Gateway-Gateways.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	GatewayHostnameConfigurationContract[]	Seitenwerte.

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"