你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Container Apps - List Custom Host Name Analysis

Reference

Service:: Azure Container Apps

API Version:: 2024-03-01

Analyzes a custom hostname for a Container App

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis?api-version=2024-03-01

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis?customHostname={customHostname}&api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
containerAppName	path	True	string	Name of the Container App.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.
customHostname	query		string	Custom hostname.

Responses

Name	Type	Description
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	Common 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

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0/listCustomHostNameAnalysis?customHostname=my.name.corp&api-version=2024-03-01

Sample Response

Status code:: 200

{
  "hostName": "my.name.corp",
  "isHostnameAlreadyVerified": true,
  "customDomainVerificationTest": "Passed",
  "customDomainVerificationFailureInfo": {},
  "hasConflictOnManagedEnvironment": false,
  "conflictingContainerAppResourceId": "",
  "cNameRecords": [
    "cNameRecord1",
    "cNameRecord2"
  ],
  "txtRecords": [
    "txtRecord1",
    "txtRecord2"
  ],
  "aRecords": [
    "aRecord1",
    "aRecord2"
  ],
  "alternateCNameRecords": [
    "cNameRecord1",
    "cNameRecord2"
  ],
  "alternateTxtRecords": [
    "txtRecord1",
    "txtRecord2"
  ]
}

Definitions

Name	Description
CustomDomainVerificationFailureInfo	Raw failure information if DNS verification fails.
CustomHostnameAnalysisResult	Custom domain analysis.
DefaultErrorResponse	App Service error response.
Details	Details or the error
DnsVerificationTestResult	DNS verification test result.
Error	Error model.

CustomDomainVerificationFailureInfo

Raw failure information if DNS verification fails.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Details or the error
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

CustomHostnameAnalysisResult

Custom domain analysis.

Name	Type	Description
aRecords	string[]	A records visible for this hostname.
alternateCNameRecords	string[]	Alternate CName records visible for this hostname.
alternateTxtRecords	string[]	Alternate TXT records visible for this hostname.
cNameRecords	string[]	CName records visible for this hostname.
conflictWithEnvironmentCustomDomain	boolean	`true` if there is a conflict on the Container App's managed environment level custom domain; otherwise, `false`.
conflictingContainerAppResourceId	string	Name of the conflicting Container App on the Managed Environment if it's within the same subscription.
customDomainVerificationFailureInfo	CustomDomainVerificationFailureInfo	Raw failure information if DNS verification fails.
customDomainVerificationTest	DnsVerificationTestResult	DNS verification test result.
hasConflictOnManagedEnvironment	boolean	`true` if there is a conflict on the Container App's managed environment; otherwise, `false`.
hostName	string	Host name that was analyzed
isHostnameAlreadyVerified	boolean	`true` if hostname is already verified; otherwise, `false`.
txtRecords	string[]	TXT records visible for this hostname.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Details or the error

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[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.