Web Apps - Analyze Custom Hostname Slot

Referenz

Service:: App Service

API Version:: 2023-12-01

Beschreibung für Analysieren eines benutzerdefinierten Hostnamens.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der Web-App.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Name des Web-App-Slots. Wenn nicht angegeben, wird standardmäßig der Produktionsslot verwendet.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version
hostName	query		string	Benutzerdefinierter Hostname.

Antworten

Name	Typ	Beschreibung
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
CustomHostnameAnalysisResult	Benutzerdefinierte Domänenanalyse.
DefaultErrorResponse	App Service Fehlerantwort.
Details
DnsVerificationTestResult	Testergebnis der DNS-Überprüfung.
Error	Fehlermodell.
ErrorEntity	Text der von der API zurückgegebenen Fehlerantwort.

CustomHostnameAnalysisResult

Benutzerdefinierte Domänenanalyse.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.aRecords	string[]	Ein Datensatzcontroller kann für diesen Hostnamen angezeigt werden.
properties.alternateCNameRecords	string[]	Alternativer CName-Datensatzcontroller kann für diesen Hostnamen angezeigt werden.
properties.alternateTxtRecords	string[]	Der Controller für alternative TXT-Datensätze kann für diesen Hostnamen angezeigt werden.
properties.cNameRecords	string[]	Der CName-Datensatzcontroller kann für diesen Hostnamen angezeigt werden.
properties.conflictingAppResourceId	string	Name der in Konflikt stehenden App in der Skalierungseinheit, wenn sie sich innerhalb desselben Abonnements befindet.
properties.customDomainVerificationFailureInfo	ErrorEntity	Unformatierte Fehlerinformationen, wenn die DNS-Überprüfung fehlschlägt.
properties.customDomainVerificationTest	DnsVerificationTestResult	Testergebnis der DNS-Überprüfung.
properties.hasConflictAcrossSubscription	boolean	`true` wenn ein abonnementübergreifender Konflikt besteht; `false`andernfalls .
properties.hasConflictOnScaleUnit	boolean	`true` , wenn ein Konflikt auf einer Skalierungseinheit vorliegt; `false`andernfalls .
properties.isHostnameAlreadyVerified	boolean	`true` , wenn der Hostname bereits überprüft wurde; `false`andernfalls .
properties.txtRecords	string[]	Txt-Datensatzcontroller kann für diesen Hostnamen angezeigt werden.
type	string	Der Ressourcentyp.

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

DnsVerificationTestResult

Testergebnis der DNS-Überprüfung.

Name	Typ	Beschreibung
Failed	string
Passed	string
Skipped	string

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

ErrorEntity

Text der von der API zurückgegebenen Fehlerantwort.

Name	Typ	Beschreibung
code	string	Einfacher Fehlercode.
details	ErrorEntity[]	Fehlerdetails.
extendedCode	string	Fehlertyp.
innerErrors	ErrorEntity[]	Innere Fehler.
message	string	Alle Details des Fehlers.
messageTemplate	string	Nachrichtenvorlage.
parameters	string[]	Parameter für die Vorlage.
target	string	Das Fehlerziel.

Share via