App Service Environments - Update Ase Custom Dns Suffix Configuration

Référence

Service:: App Service

API Version:: 2023-12-01

Mettre à jour la configuration du suffixe DNS personnalisé d’un App Service Environment

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix?api-version=2023-12-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom du App Service Environment.
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient la ressource. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Version d'API

Corps de la demande

Nom	Type	Description
kind	string	Type de ressource.
properties.certificateUrl	string	URL référençant le secret de certificat Azure Key Vault qui doit être utilisé comme certificat SSL/TLS par défaut pour les sites avec le suffixe de domaine personnalisé.
properties.dnsSuffix	string	Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE.
properties.keyVaultReferenceIdentity	string	Identité affectée par l’utilisateur à utiliser pour résoudre la référence de certificat de coffre de clés. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible.

Réponses

Nom	Type	Description
200 OK	CustomDnsSuffixConfiguration	OK.
Other Status Codes	DefaultErrorResponse	App Service réponse d’erreur.

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

Update ASE custom DNS suffix configuration

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix?api-version=2023-12-01

{
  "properties": {
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix",
  "name": "customDnsSuffix",
  "type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix",
  "properties": {
    "provisioningState": "Succeeded",
    "provisioningDetails": null,
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

Définitions

Nom	Description
CustomDnsSuffixConfiguration	Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service réponse d’erreur.
Details
Error	Modèle d’erreur.

CustomDnsSuffixConfiguration

Vue d’ensemble de la configuration du suffixe de domaine personnalisé pour ASEv3.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.certificateUrl	string	URL référençant le secret de certificat Azure Key Vault qui doit être utilisé comme certificat SSL/TLS par défaut pour les sites avec le suffixe de domaine personnalisé.
properties.dnsSuffix	string	Suffixe de domaine personnalisé par défaut à utiliser pour tous les sites déployés sur l’ASE.
properties.keyVaultReferenceIdentity	string	Identité affectée par l’utilisateur à utiliser pour résoudre la référence de certificat de coffre de clés. Si elle n’est pas spécifiée, l’identité ASE affectée par le système est utilisée si disponible.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Type de ressource.

CustomDnsSuffixProvisioningState

Nom	Type	Description
Degraded	string
Failed	string
InProgress	string
Succeeded	string

DefaultErrorResponse

App Service réponse d’erreur.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

Error

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Erreurs détaillées.
innererror	string	Plus d’informations sur l’erreur de débogage.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

Share via