Gateway Hostname Configuration - Create Or Update

Référence

Service:: API Management

Version d'API:: 2024-05-01

Crée des mises à jour de la configuration du nom d’hôte pour une passerelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificateur d’entité de passerelle. Doit être unique dans l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'
hcId	path	True	string minLength: 1 maxLength: 80	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 minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	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é 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

Nom	Type	Description
200 OK	GatewayHostnameConfigurationContract	Les détails de la configuration du nom d’hôte de la passerelle ont été correctement mis à jour. En-têtes ETag: string
201 Created	GatewayHostnameConfigurationContract	La configuration du nom d’hôte de la passerelle a été créée avec succès. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

GatewayHostnameConfigurationContract

Les détails de la configuration du nom d’hôte de la passerelle ont été correctement mis à jour.

En-têtes

ETag: string

201 Created

GatewayHostnameConfigurationContract

La configuration du nom d’hôte de la passerelle a été créée avec succès.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementCreateGatewayHostnameConfiguration

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2024-05-01

{
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Exemple de réponse

Code d’état:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GatewayHostnameConfigurationContract	Détails de configuration du nom d’hôte de la passerelle.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GatewayHostnameConfigurationContract

Object

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é 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.Storage/storageAccounts »

Partager via

Gateway Hostname Configuration - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementCreateGatewayHostnameConfiguration

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayHostnameConfigurationContract

Ressources supplémentaires