Web Apps - Analyze Custom Hostname Slot

リファレンス

Service:: App Service

API Version:: 2023-12-01

「カスタムホスト名を分析する」の説明。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	Web アプリの名前。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Web アプリスロットの名前。指定しない場合、既定では運用スロットになります。
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-00000000000000)。
api-version	query	True	string	API バージョン
hostName	query		string	カスタムホスト名。

応答

名前	型	説明
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Analyze custom hostname for slot

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging",
  "name": "sitef6141/staging",
  "type": "Microsoft.Web/sites/stagings",
  "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/slots/qa",
    "cNameRecords": [
      "siteog.azurewebsites.net"
    ]
  }
}

定義

名前	説明
CustomHostnameAnalysisResult	カスタムドメイン分析。
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
DnsVerificationTestResult	DNS 検証テストの結果。
Error	エラーモデル。
ErrorEntity	API から返されるエラー応答の本文。

CustomHostnameAnalysisResult

カスタムドメイン分析。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.aRecords	string[]	レコードコントローラーは、このホスト名を確認できます。
properties.alternateCNameRecords	string[]	代替 CName レコードコントローラーは、このホスト名を確認できます。
properties.alternateTxtRecords	string[]	代替 TXT レコードコントローラーは、このホスト名を確認できます。
properties.cNameRecords	string[]	CName レコードコントローラーは、このホスト名を確認できます。
properties.conflictingAppResourceId	string	スケールユニットで競合しているアプリの名前 (同じサブスクリプション内にある場合)。
properties.customDomainVerificationFailureInfo	ErrorEntity	DNS 検証が失敗した場合の未加工のエラー情報。
properties.customDomainVerificationTest	DnsVerificationTestResult	DNS 検証テストの結果。
properties.hasConflictAcrossSubscription	boolean	`true` サブスクリプション間で競合がある場合。それ以外の場合は `false`。
properties.hasConflictOnScaleUnit	boolean	`true` スケールユニットで競合がある場合。それ以外の場合は `false`。
properties.isHostnameAlreadyVerified	boolean	`true` ホスト名が既に検証されている場合は。それ以外の場合は `false`。
properties.txtRecords	string[]	TXT レコードコントローラーは、このホスト名を確認できます。
type	string	リソースの種類。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
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	エラーの詳細な説明とデバッグ情報。

ErrorEntity

API から返されるエラー応答の本文。

名前	型	説明
code	string	基本的なエラーコード。
details	ErrorEntity[]	エラーの詳細。
extendedCode	string	エラーの種類。
innerErrors	ErrorEntity[]	内部エラー。
message	string	エラーの詳細。
messageTemplate	string	メッセージテンプレート。
parameters	string[]	テンプレートのパラメーター。
target	string	エラーのターゲット。