Web Apps - Analyze Custom Hostname

Reference

Service:: App Service

API Version:: 2024-04-01

Description for Analyze a custom hostname.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of web app.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version
hostName	query		string	Custom hostname.

Responses

Name	Type	Description
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	App Service 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 webapp.

Sample request

HTTP

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

Sample response

Status code:: 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"
    ]
  }
}

Definitions

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

CustomHostnameAnalysisResult

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

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

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

DNS verification test result.

Name	Type	Description
Failed	string
Passed	string
Skipped	string

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	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.

ErrorEntity

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