Gateway Hostname Configuration - List By Service
Répertorie la collection de configurations de nom d’hôte pour la passerelle spécifiée.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?api-version=2021-08-01
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=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed' |
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande du client. |
$filter
|
query |
string |
| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge | |
|
$skip
|
query |
integer int32 |
Nombre d'enregistrements à ignorer. |
|
$top
|
query |
integer int32 |
Nombre d’enregistrements à renvoyer. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Collection d’entités de configuration de nom d’hôte. |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
ApiManagementListGatewayHostnameConfigurations
Exemple de requête
Exemple de réponse
{
"value": [
{
"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
}
},
{
"id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2",
"negotiateClientCertificate": true
}
}
],
"nextLink": ""
}
Définitions
Nom | Description |
---|---|
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
Gateway |
Représentation de la liste de configuration du nom d’hôte de passerelle paginée. |
Gateway |
Détails de configuration du nom d’hôte de la passerelle. |
ErrorFieldContract
Contrat de champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur de niveau propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau des propriétés. |
target |
string |
Nom de propriété. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error.code |
string |
Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse. |
error.details |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation contrôlable de visu de l’erreur. |
GatewayHostnameConfigurationCollection
Représentation de la liste de configuration du nom d’hôte de passerelle paginée.
Nom | Type | Description |
---|---|---|
nextLink |
string |
Lien de la page suivante, le cas échéant. |
value |
Valeurs de page. |
GatewayHostnameConfigurationContract
Détails de configuration du nom d’hôte de la passerelle.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nom de la ressource. |
properties.certificateId |
string |
Identificateur de l’entité Certificate qui sera utilisée pour l’établissement de la connexion TLS |
properties.hostname |
string |
Valeur de nom d’hôte. Prend en charge un nom de domaine valide, un caractère générique partiel ou complet |
properties.http2Enabled |
boolean |
Spécifie si HTTP/2.0 est pris en charge |
properties.negotiateClientCertificate |
boolean |
Détermine si la passerelle demande un certificat client |
properties.tls10Enabled |
boolean |
Spécifie si TLS 1.0 est pris en charge |
properties.tls11Enabled |
boolean |
Spécifie si TLS 1.1 est pris en charge |
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |