Web Apps - Analyze Custom Hostname Slot

Service:: App Service

API Version:: 2025-05-01

Description for Analyze a custom hostname.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname?api-version=2025-05-01

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the app.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
slot	path	True	string	Name of the deployment slot. By default, this API returns the production slot.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
hostName	query		string	Custom hostname.

Responses

Name	Type	Description
200 OK	CustomHostnameAnalysisResult	Azure operation completed successfully.
Other Status Codes	DefaultErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Analyze custom hostname for slot

Sample request

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


/**
 * Samples for WebApps AnalyzeCustomHostnameSlot.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/AnalyzeCustomHostNameSlot.json
     */
    /**
     * Sample code: Analyze custom hostname for slot.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void analyzeCustomHostnameForSlot(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().analyzeCustomHostnameSlotWithResponse("testrg123", "sitef6141", "staging",
            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

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/v6"
)

// Generated from example definition: 2025-05-01/AnalyzeCustomHostNameSlot.json
func ExampleWebAppsClient_AnalyzeCustomHostnameSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().AnalyzeCustomHostnameSlot(ctx, "testrg123", "sitef6141", "staging", 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 = armappservice.WebAppsClientAnalyzeCustomHostnameSlotResponse{
	// 	CustomHostnameAnalysisResult: &armappservice.CustomHostnameAnalysisResult{
	// 		Name: to.Ptr("sitef6141/staging"),
	// 		Type: to.Ptr("Microsoft.Web/sites/stagings"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging"),
	// 		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/slots/qa"),
	// 			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

Sample response

Status code:: 200

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

Definitions

Name	Description
CustomHostnameAnalysisResult	Custom domain analysis.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
DnsVerificationTestResult	DNS verification test result.
ErrorEntity	Body of the error response returned from the API.

CustomHostnameAnalysisResult

Object

Custom domain analysis.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.aRecords	string[]	A records controller can see for this hostname.
properties.alternateCNameRecords	string[]	Alternate CName records controller can see for this hostname.
properties.alternateTxtRecords	string[]	Alternate TXT records controller can see for this hostname.
properties.cNameRecords	string[]	CName records controller can see for this hostname.
properties.conflictingAppResourceId	string	Name of the conflicting app on scale unit if it's within the same subscription.
properties.customDomainVerificationFailureInfo	ErrorEntity	Raw failure information if DNS verification fails.
properties.customDomainVerificationTest	DnsVerificationTestResult	DNS verification test result.
properties.hasConflictAcrossSubscription	boolean	`true` if there is a conflict across subscriptions; otherwise, `false`.
properties.hasConflictOnScaleUnit	boolean	`true` if there is a conflict on a scale unit; otherwise, `false`.
properties.isHostnameAlreadyVerified	boolean	`true` if hostname is already verified; otherwise, `false`.
properties.txtRecords	string[]	TXT records controller can see for this hostname.
type	string	Resource type.

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	DefaultErrorResponseError	Error model.

DefaultErrorResponseError

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	DefaultErrorResponseErrorDetailsItem[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DnsVerificationTestResult

Enumeration

DNS verification test result.

Value	Description
Passed
Failed
Skipped

ErrorEntity

Object

Body of the error response returned from the API.

Name	Type	Description
code	string	Basic error code.
details	ErrorEntity[]	Error Details.
extendedCode	string	Type of error.
innerErrors	ErrorEntity[]	Inner errors.
message	string	Any details of the error.
messageTemplate	string	Message template.
parameters	string[]	Parameters for the template.
target	string	The error target.

Share via

Web Apps - Analyze Custom Hostname Slot

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Analyze custom hostname for slot

Sample request

Sample response

Definitions

CustomHostnameAnalysisResult

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

DnsVerificationTestResult

ErrorEntity