Gateway Hostname Configuration - Get
Ottenere i dettagli di una configurazione del nome host
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificatore di entità gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere valore 'managed' |
hc
|
path | True |
string |
Identificatore di configurazione del nome host del gateway. Deve essere univoco nell'ambito dell'entità gateway padre. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il corpo della risposta contiene l'entità Gateway specificata. Headers ETag: string |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
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
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Gateway |
Dettagli sulla configurazione del nome host del gateway. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
GatewayHostnameConfigurationContract
Dettagli sulla configurazione del nome host del gateway.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.certificateId |
string |
Identificatore dell'entità Certificato che verrà usata per l'istituzione della connessione TLS |
properties.hostname |
string |
Valore hostname. Supporta il nome di dominio valido, il carattere jolly parziale o completo |
properties.http2Enabled |
boolean |
Specifica se HTTP/2.0 è supportato |
properties.negotiateClientCertificate |
boolean |
Determina se il certificato client richiede il gateway |
properties.tls10Enabled |
boolean |
Specifica se TLS 1.0 è supportato |
properties.tls11Enabled |
boolean |
Specifica se TLS 1.1 è supportato |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |