Container Apps - List Custom Host Name Analysis
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
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 |
---|---|---|---|---|
container
|
path | True |
string |
Name of the Container App. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
custom
|
query |
string |
Custom hostname. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
Sample response
{
"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 |
---|---|
Custom |
Raw failure information if DNS verification fails. |
Custom |
Custom domain analysis. |
Default |
App Service error response. |
Details |
Details or the error |
Dns |
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 |
|
conflictingContainerAppResourceId |
string |
Name of the conflicting Container App on the Managed Environment if it's within the same subscription. |
customDomainVerificationFailureInfo |
Raw failure information if DNS verification fails. |
|
customDomainVerificationTest |
DNS verification test result. |
|
hasConflictOnManagedEnvironment |
boolean |
|
hostName |
string |
Host name that was analyzed |
isHostnameAlreadyVerified |
boolean |
|
txtRecords |
string[] |
TXT records visible for this hostname. |
DefaultErrorResponse
App Service error response.
Name | Type | Description |
---|---|---|
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. |