Gateway Hostname Configuration - Create Or Update
Crée la configuration du nom d’hôte des mises à jour pour une passerelle.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-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' |
hc
|
path | True |
string |
Identificateur de configuration du nom d’hôte de la passerelle. Doit être unique dans l’étendue de l’entité de passerelle parente. |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
service
|
path | True |
string |
Nom du service Gestion des API. Regex pattern: |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
If-Match |
string |
ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité. |
Corps de la demande
Nom | Type | Description |
---|---|---|
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 |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Les détails de configuration du nom d’hôte de la passerelle ont été correctement mis à jour. Headers ETag: string |
|
201 Created |
La nouvelle configuration du nom d’hôte de la passerelle a été créée avec succès. Headers ETag: string |
|
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
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
ApiManagementCreateGatewayHostnameConfiguration
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
{
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
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,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
{
"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,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Définitions
Nom | Description |
---|---|
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
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. |
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 » |