Web Apps - Analyze Custom Hostname

서비스:

App Service

API 버전:

2023-12-01

사용자 지정 호스트 이름 분석에 대한 설명입니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	웹앱의 이름입니다.
resourceGroupName	path	True	string	리소스가 속한 리소스 그룹의 이름입니다. regex 패턴: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 구독 ID. GUID 형식 문자열입니다(예: 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	API 버전
hostName	query		string	사용자 지정 호스트 이름입니다.

응답

Name	형식	Description
200 OK	CustomHostnameAnalysisResult	정상
Other Status Codes	DefaultErrorResponse	오류 응답을 App Service.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Analyze custom hostname for webapp.

샘플 요청

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

샘플 응답

상태 코드:

200

{
  "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"
    ]
  }
}

정의

Name	Description
CustomHostnameAnalysisResult	사용자 지정 도메인 분석.
DefaultErrorResponse	오류 응답을 App Service.
Details
DnsVerificationTestResult	DNS 확인 테스트 결과입니다.
Error	오류 모델.
ErrorEntity	API에서 반환된 오류 응답의 본문입니다.

CustomHostnameAnalysisResult

사용자 지정 도메인 분석.

Name	형식	Description
id	string	리소스 ID입니다.
kind	string	리소스 종류입니다.
name	string	리소스 이름입니다.
properties.aRecords	string[]	레코드 컨트롤러는 이 호스트 이름을 볼 수 있습니다.
properties.alternateCNameRecords	string[]	대체 CName 레코드 컨트롤러는 이 호스트 이름을 볼 수 있습니다.
properties.alternateTxtRecords	string[]	대체 TXT 레코드 컨트롤러는 이 호스트 이름에 대해 볼 수 있습니다.
properties.cNameRecords	string[]	CName 레코드 컨트롤러는 이 호스트 이름을 볼 수 있습니다.
properties.conflictingAppResourceId	string	동일한 구독 내에 있는 경우 배율 단위에서 충돌하는 앱의 이름입니다.
properties.customDomainVerificationFailureInfo	ErrorEntity	DNS 확인이 실패하는 경우 원시 오류 정보입니다.
properties.customDomainVerificationTest	DnsVerificationTestResult	DNS 확인 테스트 결과입니다.
properties.hasConflictAcrossSubscription	boolean	true 구독 간에 충돌이 있는 경우 그렇지 않으면 입니다 false.
properties.hasConflictOnScaleUnit	boolean	true 배율 단위에 충돌이 있으면 이고, 그렇지 않으면 입니다 false.
properties.isHostnameAlreadyVerified	boolean	true 호스트 이름이 이미 확인되었으면 이고, 그렇지 않으면 입니다 false.
properties.txtRecords	string[]	TXT 레코드 컨트롤러는 이 호스트 이름을 볼 수 있습니다.
type	string	리소스 종류.

DefaultErrorResponse

오류 응답을 App Service.

Name	형식	Description
error	Error	오류 모델.

Details

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

DnsVerificationTestResult

DNS 확인 테스트 결과입니다.

Name	형식	Description
Failed	string
Passed	string
Skipped	string

Error

오류 모델.

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details	Details[]	자세한 오류입니다.
innererror	string	디버그 오류에 대한 자세한 정보입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

ErrorEntity

API에서 반환된 오류 응답의 본문입니다.

Name	형식	Description
code	string	기본 오류 코드입니다.
details	ErrorEntity[]	오류 세부 정보.
extendedCode	string	오류 유형입니다.
innerErrors	ErrorEntity[]	내부 오류.
message	string	오류에 대한 세부 정보입니다.
messageTemplate	string	메시지 템플릿.
parameters	string[]	템플릿에 대한 매개 변수입니다.
target	string	오류 대상입니다.