Partager via


Web Apps - Analyze Custom Hostname

Description de l’analyse d’un nom d’hôte personnalisé.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?api-version=2023-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?hostName={hostName}&api-version=2023-12-01

Paramètres URI

Nom Dans Obligatoire Type Description
name
path True

string

Nom de l’application web.

resourceGroupName
path True

string

Nom du groupe de ressources auquel appartient la ressource.

Modèle d’expression régulière: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000).

api-version
query True

string

Version d'API

hostName
query

string

Nom d’hôte personnalisé.

Réponses

Nom Type Description
200 OK

CustomHostnameAnalysisResult

Ok

Other Status Codes

DefaultErrorResponse

App Service réponse d’erreur.

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

Analyze custom hostname for webapp.

Exemple de requête

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/analyzeCustomHostname?api-version=2023-12-01

Exemple de réponse

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141",
  "name": "sitef6141",
  "type": "Microsoft.Web/sites",
  "properties": {
    "isHostnameAlreadyVerified": true,
    "customDomainVerificationTest": "Passed",
    "customDomainVerificationFailureInfo": {
      "code": "07198",
      "message": "Custom domain verification failed on conflicting CNAMEs."
    },
    "hasConflictOnScaleUnit": false,
    "hasConflictAcrossSubscription": true,
    "conflictingAppResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog",
    "cNameRecords": [
      "siteog.azurewebsites.net"
    ]
  }
}

Définitions

Nom Description
CustomHostnameAnalysisResult

Analyse de domaine personnalisée.

DefaultErrorResponse

App Service réponse d’erreur.

Details
DnsVerificationTestResult

Résultat du test de vérification DNS.

Error

Modèle d’erreur.

ErrorEntity

Corps de la réponse d’erreur retournée par l’API.

CustomHostnameAnalysisResult

Analyse de domaine personnalisée.

Nom Type Description
id

string

ID de ressource.

kind

string

Type de ressource.

name

string

Nom de la ressource.

properties.aRecords

string[]

Un contrôleur d’enregistrements peut voir pour ce nom d’hôte.

properties.alternateCNameRecords

string[]

Un autre contrôleur d’enregistrements CName peut voir pour ce nom d’hôte.

properties.alternateTxtRecords

string[]

Un autre contrôleur d’enregistrements TXT peut voir pour ce nom d’hôte.

properties.cNameRecords

string[]

Le contrôleur d’enregistrements CName peut voir pour ce nom d’hôte.

properties.conflictingAppResourceId

string

Nom de l’application en conflit sur l’unité d’échelle si elle se trouve dans le même abonnement.

properties.customDomainVerificationFailureInfo

ErrorEntity

Informations brutes sur les échecs en cas d’échec de la vérification DNS.

properties.customDomainVerificationTest

DnsVerificationTestResult

Résultat du test de vérification DNS.

properties.hasConflictAcrossSubscription

boolean

true en cas de conflit entre les abonnements ; sinon, false.

properties.hasConflictOnScaleUnit

boolean

true en cas de conflit sur une unité d’échelle ; sinon, false.

properties.isHostnameAlreadyVerified

boolean

true si le nom d’hôte est déjà vérifié ; sinon, false.

properties.txtRecords

string[]

Le contrôleur d’enregistrements TXT peut voir pour ce nom d’hôte.

type

string

Type de ressource.

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.

DnsVerificationTestResult

Résultat du test de vérification DNS.

Nom Type Description
Failed

string

Passed

string

Skipped

string

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

Informations supplémentaires pour déboguer l’erreur.

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.

ErrorEntity

Corps de la réponse d’erreur retournée par l’API.

Nom Type Description
code

string

Code d’erreur de base.

details

ErrorEntity[]

Détails de l’erreur.

extendedCode

string

Type d'erreur

innerErrors

ErrorEntity[]

Erreurs internes.

message

string

Tous les détails de l’erreur.

messageTemplate

string

Modèle de message.

parameters

string[]

Paramètres du modèle.

target

string

Cible d’erreur.