Web Apps - Analyze Custom Hostname Slot

Referentie

Service:: App Service

API-versie:: 2023-12-01

Beschrijving voor Een aangepaste hostnaam analyseren.

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

Met optionele 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-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van web-app.
resourceGroupName	path	True	string	Naam van de resourcegroep waartoe de resource behoort. Regex-patroon: `^[-\w\._]+[^\.]$`
slot	path	True	string	Naam van web-app-site. Als dit niet is opgegeven, wordt standaard de productiesite gebruikt.
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-versie
hostName	query		string	Aangepaste hostnaam.

Antwoorden

Name	Type	Description
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	App Service foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Analyze custom hostname for slot

Voorbeeldaanvraag

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


/**
 * Samples for WebApps AnalyzeCustomHostnameSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostNameSlot.json
     */
    /**
     * Sample code: Analyze custom hostname for slot.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void analyzeCustomHostnameForSlot(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().analyzeCustomHostnameSlotWithResponse("testrg123",
            "sitef6141", "staging", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python analyze_custom_host_name_slot.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.analyze_custom_hostname_slot(
        resource_group_name="testrg123",
        name="sitef6141",
        slot="staging",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostNameSlot.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostNameSlot.json
func ExampleWebAppsClient_AnalyzeCustomHostnameSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().AnalyzeCustomHostnameSlot(ctx, "testrg123", "sitef6141", "staging", &armappservice.WebAppsClientAnalyzeCustomHostnameSlotOptions{HostName: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomHostnameAnalysisResult = armappservice.CustomHostnameAnalysisResult{
	// 	Name: to.Ptr("sitef6141/staging"),
	// 	Type: to.Ptr("Microsoft.Web/sites/stagings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging"),
	// 	Properties: &armappservice.CustomHostnameAnalysisResultProperties{
	// 		CNameRecords: []*string{
	// 			to.Ptr("siteog.azurewebsites.net")},
	// 			ConflictingAppResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog/slots/qa"),
	// 			CustomDomainVerificationFailureInfo: &armappservice.ErrorEntity{
	// 				Code: to.Ptr("07198"),
	// 				Message: to.Ptr("Custom domain verification failed on conflicting CNAMEs."),
	// 			},
	// 			CustomDomainVerificationTest: to.Ptr(armappservice.DNSVerificationTestResultPassed),
	// 			HasConflictAcrossSubscription: to.Ptr(true),
	// 			HasConflictOnScaleUnit: to.Ptr(false),
	// 			IsHostnameAlreadyVerified: to.Ptr(true),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Analyze a custom hostname.
 *
 * @summary Description for Analyze a custom hostname.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/AnalyzeCustomHostNameSlot.json
 */
async function analyzeCustomHostnameForSlot() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const slot = "staging";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.analyzeCustomHostnameSlot(resourceGroupName, name, slot);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

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

Definities

Name	Description
CustomHostnameAnalysisResult	Analyse van aangepaste domeinen.
DefaultErrorResponse	App Service foutreactie.
Details
DnsVerificationTestResult	Testresultaat voor DNS-verificatie.
Error	Foutmodel.
ErrorEntity	Hoofdtekst van het foutbericht dat is geretourneerd door de API.

CustomHostnameAnalysisResult

Analyse van aangepaste domeinen.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.aRecords	string[]	Een recordcontroller kan deze hostnaam zien.
properties.alternateCNameRecords	string[]	Alternatieve CName-recordcontroller kan zien voor deze hostnaam.
properties.alternateTxtRecords	string[]	Alternatieve TXT-recordcontroller kan zien voor deze hostnaam.
properties.cNameRecords	string[]	CName-recordcontroller kan zien voor deze hostnaam.
properties.conflictingAppResourceId	string	Naam van de conflicterende app op schaaleenheid als deze zich binnen hetzelfde abonnement bevindt.
properties.customDomainVerificationFailureInfo	ErrorEntity	Onbewerkte foutinformatie als DNS-verificatie mislukt.
properties.customDomainVerificationTest	DnsVerificationTestResult	Testresultaat voor DNS-verificatie.
properties.hasConflictAcrossSubscription	boolean	`true` als er een conflict is tussen abonnementen; anders, `false`.
properties.hasConflictOnScaleUnit	boolean	`true` als er een conflict is op een schaaleenheid; anders, `false`.
properties.isHostnameAlreadyVerified	boolean	`true` als hostnaam al is geverifieerd; anders, `false`.
properties.txtRecords	string[]	De TXT-recordcontroller kan deze hostnaam zien.
type	string	Resourcetype.

DefaultErrorResponse

App Service foutreactie.

Name	Type	Description
error	Error	Foutmodel.

Details

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

DnsVerificationTestResult

Testresultaat voor DNS-verificatie.

Name	Type	Description
Failed	string
Passed	string
Skipped	string

Error

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

ErrorEntity

Hoofdtekst van het foutbericht dat is geretourneerd door de API.

Name	Type	Description
code	string	Basisfoutcode.
details	ErrorEntity[]	Foutdetails.
extendedCode	string	Type fout.
innerErrors	ErrorEntity[]	Interne fouten.
message	string	Eventuele details van de fout.
messageTemplate	string	Berichtsjabloon.
parameters	string[]	Parameters voor de sjabloon.
target	string	Het foutdoel.

Delen via

Web Apps - Analyze Custom Hostname Slot

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Analyze custom hostname for slot

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CustomHostnameAnalysisResult

DefaultErrorResponse

Details

DnsVerificationTestResult

Error

ErrorEntity

Aanvullende resources