Gateway Hostname Configuration - Get
Abrufen von Details einer Hostnamenkonfiguration
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
gateway
|
path | True |
string |
Gatewayentitätsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Darf nicht über den Wert "verwaltet" verfügen |
hc
|
path | True |
string |
Konfigurationsbezeichner für Gatewayhostname. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Antworttext enthält die angegebene Gatewayentität. Header ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementGetGatewayHostnameConfiguration
Beispielanforderung
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
Beispiel für eine Antwort
{
"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
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Gateway |
Details zur Konfiguration des Gatewayhosthosts. |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
GatewayHostnameConfigurationContract
Details zur Konfiguration des Gatewayhosthosts.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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-Verbindungsherstellung verwendet wird |
properties.hostname |
string |
Hostnamenwert. Unterstützt gültigen Domänennamen, teilweise oder vollständigen Feldhalter |
properties.http2Enabled |
boolean |
Gibt an, ob HTTP/2.0 unterstützt wird. |
properties.negotiateClientCertificate |
boolean |
Bestimmt, ob das Gateway ein Clientzertifikat anfordet |
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" |