Gateway Hostname Configuration - Get
Hämta information om en värdnamnskonfiguration
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterad" |
hc
|
path | True |
string |
Konfigurationsidentifierare för gatewayvärdnamn. Måste vara unikt i omfånget för den överordnade gatewayentiteten. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Svarstexten innehåller den angivna gatewayentiteten. Headers ETag: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementGetGatewayHostnameConfiguration
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
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
}
}
Definitioner
Name | Description |
---|---|
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Gateway |
Konfigurationsinformation för gatewayens värdnamn. |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
GatewayHostnameConfigurationContract
Konfigurationsinformation för gatewayens värdnamn.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.certificateId |
string |
Identifierare för certifikatentitet som ska användas för TLS-anslutningsetablering |
properties.hostname |
string |
Värdnamnsvärde. Stöder giltigt domännamn, partiellt eller fullständigt jokertecken |
properties.http2Enabled |
boolean |
Anger om HTTP/2.0 stöds |
properties.negotiateClientCertificate |
boolean |
Avgör om gatewayen begär klientcertifikat |
properties.tls10Enabled |
boolean |
Anger om TLS 1.0 stöds |
properties.tls11Enabled |
boolean |
Anger om TLS 1.1 stöds |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |