Gateway Hostname Configuration - Create Or Update

Crée une configuration de nom d’hôte de mise à jour pour une passerelle.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2021-12-01-preview

Paramètres URI

Name In Required Type Description
gatewayId
path True
  • string

Identificateur d’entité de passerelle. Doit être unique dans l’instance de service Gestion des API actuelle. Ne doit pas avoir de valeur « managée »

hcId
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.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service Gestion des API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Informations d’identification de l’abonnement qui identifient de manière unique Microsoft Azure abonnement. 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 cliente.

En-tête de la demande

Name Required 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

Name Type Description
properties.certificateId
  • string

Identificateur de l’entité de certificat qui sera utilisée pour l’établissement de la connexion TLS

properties.hostname
  • string

Valeur du nom d’hôte. Prend en charge le nom de domaine valide, le 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

Name 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 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

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunt d’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=2021-12-01-preview

{
  "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

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GatewayHostnameConfigurationContract

Détails de configuration du nom d’hôte de la passerelle.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible humaine de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name 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.

Name 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é de certificat qui sera utilisée pour l’établissement de la connexion TLS

properties.hostname
  • string

Valeur du nom d’hôte. Prend en charge le nom de domaine valide, le 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 ». Stockage/storageAccounts »