Opis analizy niestandardowej nazwy hosta.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?api-version=2024-04-01
Z parametrami opcjonalnymi:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname?hostName={hostName}&api-version=2024-04-01
Parametry identyfikatora URI
| Nazwa |
W |
Wymagane |
Typ |
Opis |
|
name
|
path |
True
|
string
|
Nazwa aplikacji internetowej.
|
|
resourceGroupName
|
path |
True
|
string
minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$
|
Nazwa grupy zasobów, do której należy zasób.
|
|
subscriptionId
|
path |
True
|
string
|
Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
|
|
api-version
|
query |
True
|
string
|
Wersja interfejsu API
|
|
hostName
|
query |
|
string
|
Niestandardowa nazwa hosta.
|
Odpowiedzi
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa |
Opis |
|
user_impersonation
|
personifikacja konta użytkownika
|
Przykłady
Analyze custom hostname for webapp.
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"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"
]
}
}
Definicje
CustomHostnameAnalysisResult
Objekt
Analiza domeny niestandardowej.
| Nazwa |
Typ |
Opis |
|
id
|
string
|
Identyfikator zasobu.
|
|
kind
|
string
|
Rodzaj zasobu.
|
|
name
|
string
|
Nazwa zasobu.
|
|
properties.aRecords
|
string[]
|
Kontroler rekordów może zobaczyć dla tej nazwy hosta.
|
|
properties.alternateCNameRecords
|
string[]
|
Alternatywny kontroler rekordów CName może zobaczyć dla tej nazwy hosta.
|
|
properties.alternateTxtRecords
|
string[]
|
Alternatywny kontroler rekordów TXT może zobaczyć dla tej nazwy hosta.
|
|
properties.cNameRecords
|
string[]
|
Kontroler rekordów CName może zobaczyć dla tej nazwy hosta.
|
|
properties.conflictingAppResourceId
|
string
|
Nazwa aplikacji powodującej konflikt w jednostce skalowania, jeśli znajduje się ona w tej samej subskrypcji.
|
|
properties.customDomainVerificationFailureInfo
|
ErrorEntity
|
Nieprzetworzone informacje o niepowodzeniu, jeśli weryfikacja DNS nie powiedzie się.
|
|
properties.customDomainVerificationTest
|
DnsVerificationTestResult
|
Wynik testu weryfikacji DNS.
|
|
properties.hasConflictAcrossSubscription
|
boolean
|
true, jeśli występuje konflikt między subskrypcjami; w przeciwnym razie false.
|
|
properties.hasConflictOnScaleUnit
|
boolean
|
true w przypadku konfliktu w jednostce skalowania; w przeciwnym razie false.
|
|
properties.isHostnameAlreadyVerified
|
boolean
|
true, jeśli nazwa hosta jest już zweryfikowana; w przeciwnym razie false.
|
|
properties.txtRecords
|
string[]
|
Kontroler rekordów TXT może zobaczyć dla tej nazwy hosta.
|
|
type
|
string
|
Typ zasobu.
|
DefaultErrorResponse
Objekt
Odpowiedź na błąd usługi App Service.
| Nazwa |
Typ |
Opis |
|
error
|
Error
|
Model błędu.
|
Details
Objekt
| Nazwa |
Typ |
Opis |
|
code
|
string
|
Ustandaryzowany ciąg do programowego identyfikowania błędu.
|
|
message
|
string
|
Szczegółowy opis błędu i informacje o debugowaniu.
|
|
target
|
string
|
Szczegółowy opis błędu i informacje o debugowaniu.
|
DnsVerificationTestResult
Wyliczanie
Wynik testu weryfikacji DNS.
| Wartość |
Opis |
|
Failed
|
|
|
Passed
|
|
|
Skipped
|
|
Error
Objekt
Model błędu.
| Nazwa |
Typ |
Opis |
|
code
|
string
|
Ustandaryzowany ciąg do programowego identyfikowania błędu.
|
|
details
|
Details[]
|
Szczegółowe błędy.
|
|
innererror
|
string
|
Więcej informacji na temat debugowania błędu.
|
|
message
|
string
|
Szczegółowy opis błędu i informacje o debugowaniu.
|
|
target
|
string
|
Szczegółowy opis błędu i informacje o debugowaniu.
|
ErrorEntity
Objekt
Treść odpowiedzi o błędzie zwróconej z interfejsu API.
| Nazwa |
Typ |
Opis |
|
code
|
string
|
Podstawowy kod błędu.
|
|
details
|
ErrorEntity[]
|
Szczegóły błędu.
|
|
extendedCode
|
string
|
Typ błędu.
|
|
innerErrors
|
ErrorEntity[]
|
Błędy wewnętrzne.
|
|
message
|
string
|
Wszelkie szczegóły błędu.
|
|
messageTemplate
|
string
|
Szablon wiadomości.
|
|
parameters
|
string[]
|
Parametry szablonu.
|
|
target
|
string
|
Element docelowy błędu.
|