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
Avec des paramètres facultatifs:
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
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
/**
* Samples for WebApps AnalyzeCustomHostname.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostName.json
*/
/**
* Sample code: Analyze custom hostname for webapp.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void analyzeCustomHostnameForWebapp(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getWebApps().analyzeCustomHostnameWithResponse("testrg123",
"sitef6141", null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-web
# USAGE
python analyze_custom_host_name.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = WebSiteManagementClient(
credential=DefaultAzureCredential(),
subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
)
response = client.web_apps.analyze_custom_hostname(
resource_group_name="testrg123",
name="sitef6141",
)
print(response)
# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostName.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armappservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostName.json
func ExampleWebAppsClient_AnalyzeCustomHostname() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWebAppsClient().AnalyzeCustomHostname(ctx, "testrg123", "sitef6141", &armappservice.WebAppsClientAnalyzeCustomHostnameOptions{HostName: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CustomHostnameAnalysisResult = armappservice.CustomHostnameAnalysisResult{
// Name: to.Ptr("sitef6141"),
// Type: to.Ptr("Microsoft.Web/sites"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141"),
// Properties: &armappservice.CustomHostnameAnalysisResultProperties{
// CNameRecords: []*string{
// to.Ptr("siteog.azurewebsites.net")},
// ConflictingAppResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog"),
// CustomDomainVerificationFailureInfo: &armappservice.ErrorEntity{
// Code: to.Ptr("07198"),
// Message: to.Ptr("Custom domain verification failed on conflicting CNAMEs."),
// },
// CustomDomainVerificationTest: to.Ptr(armappservice.DNSVerificationTestResultPassed),
// HasConflictAcrossSubscription: to.Ptr(true),
// HasConflictOnScaleUnit: to.Ptr(false),
// IsHostnameAlreadyVerified: to.Ptr(true),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Description for Analyze a custom hostname.
*
* @summary Description for Analyze a custom hostname.
* x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostName.json
*/
async function analyzeCustomHostnameForWebapp() {
const subscriptionId =
process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
const name = "sitef6141";
const credential = new DefaultAzureCredential();
const client = new WebSiteManagementClient(credential, subscriptionId);
const result = await client.webApps.analyzeCustomHostname(resourceGroupName, name);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;
// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostName.json
// this example is just showing the usage of "WebApps_AnalyzeCustomHostname" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);
// invoke the operation
CustomHostnameAnalysisResult result = await webSite.AnalyzeCustomHostnameAsync();
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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
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.
|