Container Apps - List Custom Host Name Analysis

Ссылка

Service:: Azure Container Apps

API Version:: 2023-08-01-preview

Анализирует пользовательское имя узла для приложения-контейнера

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
containerAppName	path	True	string	Имя приложения-контейнера.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.
customHostname	query		string	Пользовательское имя узла.

Ответы

Имя	Тип	Описание
200 OK	CustomHostnameAnalysisResult	ОК
Other Status Codes	DefaultErrorResponse	Распространенные ответы об ошибках.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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=2023-08-01-preview

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

Определения

Имя	Описание
CustomDomainVerificationFailureInfo	Необработанные сведения о сбое при сбое проверки DNS.
CustomHostnameAnalysisResult	Анализ личного домена.
DefaultErrorResponse	Служба приложений ответ об ошибке.
Details	Сведения или ошибка
DnsVerificationTestResult	Результат проверки DNS.
Error	Модель ошибок.

CustomDomainVerificationFailureInfo

Необработанные сведения о сбое при сбое проверки DNS.

Имя	Тип	Описание
code	string	Стандартизированная строка для программного определения ошибки.
details	Details[]	Сведения или ошибка
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

CustomHostnameAnalysisResult

Анализ личного домена.

Имя	Тип	Описание
aRecords	string[]	Записи, видимые для этого имени узла.
alternateCNameRecords	string[]	Альтернативные записи CName, видимые для этого имени узла.
alternateTxtRecords	string[]	Альтернативные записи ТИПА TXT, видимые для этого имени узла.
cNameRecords	string[]	Записи CName, видимые для этого имени узла.
conflictWithEnvironmentCustomDomain	boolean	`true` при наличии конфликта в пользовательском домене уровня управляемой среды приложения-контейнера; в противном случае — `false`.
conflictingContainerAppResourceId	string	Имя конфликтующего приложения-контейнера в управляемой среде, если оно находится в той же подписке.
customDomainVerificationFailureInfo	CustomDomainVerificationFailureInfo	Необработанные сведения о сбое при сбое проверки DNS.
customDomainVerificationTest	DnsVerificationTestResult	Результат проверки DNS.
hasConflictOnManagedEnvironment	boolean	`true` при наличии конфликта в управляемой среде приложения-контейнера; в противном случае — `false`.
hostName	string	Имя узла, которое было проанализировано
isHostnameAlreadyVerified	boolean	`true` Значение , если имя узла уже проверено; в противном случае — `false`.
txtRecords	string[]	Записи TXT, видимые для этого имени узла.

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Сведения или ошибка

Имя	Тип	Описание
code	string	Стандартизированная строка для программного определения ошибки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

DnsVerificationTestResult

Результат проверки DNS.

Имя	Тип	Описание
Failed	string
Passed	string
Skipped	string

Error

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизированная строка для программного определения ошибки.
details	Details[]	Сведения или ошибка
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

Поделиться через