Descrizione per Analizzare un nome host personalizzato.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?api-version=2024-04-01
Con parametri facoltativi:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?hostName={hostName}&api-version=2024-04-01
Parametri dell'URI
| Nome |
In |
Necessario |
Tipo |
Descrizione |
|
name
|
path |
True
|
string
|
Nome dell'app Web.
|
|
resourceGroupName
|
path |
True
|
string
minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$
|
Nome del gruppo di risorse a cui appartiene la risorsa.
|
|
subscriptionId
|
path |
True
|
string
|
ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-000000000000000).
|
|
api-version
|
query |
True
|
string
|
Versione API
|
|
hostName
|
query |
|
string
|
Nome host personalizzato.
|
Risposte
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome |
Descrizione |
|
user_impersonation
|
rappresentare l'account utente
|
Esempio
Analyze custom hostname for webapp.
Esempio di richiesta
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/analyzeCustomHostname?api-version=2024-04-01
/**
* Samples for WebApps AnalyzeCustomHostname.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2024-04-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/2024-04-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/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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");
require("dotenv/config");
/**
* 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/2024-04-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/2024-04-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
Risposta di esempio
{
"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"
]
}
}
Definizioni
CustomHostnameAnalysisResult
Object
Analisi del dominio personalizzata.
| Nome |
Tipo |
Descrizione |
|
id
|
string
|
ID risorsa.
|
|
kind
|
string
|
Tipo di risorsa.
|
|
name
|
string
|
Nome risorsa.
|
|
properties.aRecords
|
string[]
|
Un controller di record può vedere per questo nome host.
|
|
properties.alternateCNameRecords
|
string[]
|
Il controller di record CName alternativo può vedere per questo nome host.
|
|
properties.alternateTxtRecords
|
string[]
|
Il controller di record TXT alternativo può vedere per questo nome host.
|
|
properties.cNameRecords
|
string[]
|
Il controller dei record CName può vedere per questo nome host.
|
|
properties.conflictingAppResourceId
|
string
|
Nome dell'app in conflitto nell'unità di scala se si trovano all'interno della stessa sottoscrizione.
|
|
properties.customDomainVerificationFailureInfo
|
ErrorEntity
|
Informazioni sull'errore non elaborato se la verifica DNS ha esito negativo.
|
|
properties.customDomainVerificationTest
|
DnsVerificationTestResult
|
Risultato del test di verifica DNS.
|
|
properties.hasConflictAcrossSubscription
|
boolean
|
true in caso di conflitto tra sottoscrizioni; in caso contrario, false.
|
|
properties.hasConflictOnScaleUnit
|
boolean
|
true se si verifica un conflitto in un'unità di scala; in caso contrario, false.
|
|
properties.isHostnameAlreadyVerified
|
boolean
|
true se il nome host è già verificato; in caso contrario, false.
|
|
properties.txtRecords
|
string[]
|
Il controller di record TXT può vedere per questo nome host.
|
|
type
|
string
|
Tipo di risorsa.
|
DefaultErrorResponse
Object
Risposta di errore del servizio app.
| Nome |
Tipo |
Descrizione |
|
error
|
Error
|
Modello di errore.
|
Details
Object
| Nome |
Tipo |
Descrizione |
|
code
|
string
|
Stringa standardizzata per identificare l'errore a livello di codice.
|
|
message
|
string
|
Descrizione dettagliata dell'errore e informazioni di debug.
|
|
target
|
string
|
Descrizione dettagliata dell'errore e informazioni di debug.
|
DnsVerificationTestResult
Enumerazione
Risultato del test di verifica DNS.
| Valore |
Descrizione |
|
Failed
|
|
|
Passed
|
|
|
Skipped
|
|
Error
Object
Modello di errore.
| Nome |
Tipo |
Descrizione |
|
code
|
string
|
Stringa standardizzata per identificare l'errore a livello di codice.
|
|
details
|
Details[]
|
Errori dettagliati.
|
|
innererror
|
string
|
Altre informazioni per eseguire il debug dell'errore.
|
|
message
|
string
|
Descrizione dettagliata dell'errore e informazioni di debug.
|
|
target
|
string
|
Descrizione dettagliata dell'errore e informazioni di debug.
|
ErrorEntity
Object
Corpo della risposta di errore restituita dall'API.
| Nome |
Tipo |
Descrizione |
|
code
|
string
|
Codice di errore di base.
|
|
details
|
ErrorEntity[]
|
Dettagli errore.
|
|
extendedCode
|
string
|
Tipo di errore.
|
|
innerErrors
|
ErrorEntity[]
|
Errori interni.
|
|
message
|
string
|
Qualsiasi dettaglio dell'errore.
|
|
messageTemplate
|
string
|
Modello di messaggio.
|
|
parameters
|
string[]
|
Parametri per il modello.
|
|
target
|
string
|
Destinazione dell'errore.
|