List Custom Host Name Sites - List Custom Host Name Sites

Service:: App Service

API-versie:: 2024-11-01

Aangepaste hostnamen ophalen onder dit abonnement

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites?api-version=2024-11-01

Met optionele parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites?hostname={hostname}&api-version=2024-11-01

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	API-versie
hostname	query		string	Specifieke hostnaam

Antwoorden

Name	Type	Description
200 OK	CustomHostnameSitesCollection	OK
Other Status Codes	DefaultErrorResponse	Foutreactie van App Service.

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

Get custom hostnames under subscription

Get specific custom hostname under subscription

Get custom hostnames under subscription

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites?api-version=2024-11-01


/**
 * Samples for ResourceProvider ListCustomHostnameSites.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomHostNameSites.json
     */
    /**
     * Sample code: Get custom hostnames under subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getCustomHostnamesUnderSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getResourceProviders().listCustomHostnameSites(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 list_custom_host_name_sites.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.list_custom_host_name_sites()
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomHostNameSites.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomHostNameSites.json
func ExampleWebSiteManagementClient_NewListCustomHostNameSitesPager_getCustomHostnamesUnderSubscription() {
	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)
	}
	pager := clientFactory.NewWebSiteManagementClient().NewListCustomHostNameSitesPager(&armappservice.WebSiteManagementClientListCustomHostNameSitesOptions{Hostname: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CustomHostnameSitesCollection = armappservice.CustomHostnameSitesCollection{
		// 	Value: []*armappservice.CustomHostnameSites{
		// 		{
		// 			Name: to.Ptr("mywebapp.azurewebsites.net"),
		// 			Type: to.Ptr("Microsoft.Web/customhostnameSites"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/mywebapp.azurewebsites.net"),
		// 			Properties: &armappservice.CustomHostnameSitesProperties{
		// 				CustomHostname: to.Ptr("mywebapp.azurewebsites.net"),
		// 				Region: to.Ptr("West US"),
		// 				SiteResourceIDs: []*armappservice.Identifier{
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus-rg/providers/Microsoft.Web/sites/mywebapp"),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("www.example.com"),
		// 			Type: to.Ptr("Microsoft.Web/customhostnameSites"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com"),
		// 			Properties: &armappservice.CustomHostnameSitesProperties{
		// 				CustomHostname: to.Ptr("www.example.com"),
		// 				Region: to.Ptr("West US 2"),
		// 				SiteResourceIDs: []*armappservice.Identifier{
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Get custom hostnames under this subscription
 *
 * @summary Get custom hostnames under this subscription
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomHostNameSites.json
 */
async function getCustomHostnamesUnderSubscription() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.listCustomHostNameSites()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomHostNameSites.json
// this example is just showing the usage of "ListCustomHostNameSites" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (CustomHostnameSites item in subscriptionResource.GetCustomHostNameSitesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/mywebapp.azurewebsites.net",
      "name": "mywebapp.azurewebsites.net",
      "type": "Microsoft.Web/customhostnameSites",
      "properties": {
        "customHostname": "mywebapp.azurewebsites.net",
        "region": "West US",
        "siteResourceIds": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus-rg/providers/Microsoft.Web/sites/mywebapp"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com",
      "name": "www.example.com",
      "type": "Microsoft.Web/customhostnameSites",
      "properties": {
        "customHostname": "www.example.com",
        "region": "West US 2",
        "siteResourceIds": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3"
          }
        ]
      }
    }
  ],
  "nextLink": null
}

Get specific custom hostname under subscription

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites?hostname=www.example.com&api-version=2024-11-01


/**
 * Samples for ResourceProvider ListCustomHostnameSites.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomSpecificHostNameSites.json
     */
    /**
     * Sample code: Get specific custom hostname under subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getSpecificCustomHostnameUnderSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getResourceProviders().listCustomHostnameSites("www.example.com",
            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 list_custom_specific_host_name_sites.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.list_custom_host_name_sites()
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomSpecificHostNameSites.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomSpecificHostNameSites.json
func ExampleWebSiteManagementClient_NewListCustomHostNameSitesPager_getSpecificCustomHostnameUnderSubscription() {
	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)
	}
	pager := clientFactory.NewWebSiteManagementClient().NewListCustomHostNameSitesPager(&armappservice.WebSiteManagementClientListCustomHostNameSitesOptions{Hostname: to.Ptr("www.example.com")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CustomHostnameSitesCollection = armappservice.CustomHostnameSitesCollection{
		// 	Value: []*armappservice.CustomHostnameSites{
		// 		{
		// 			Name: to.Ptr("www.example.com"),
		// 			Type: to.Ptr("Microsoft.Web/customhostnameSites"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com"),
		// 			Properties: &armappservice.CustomHostnameSitesProperties{
		// 				CustomHostname: to.Ptr("www.example.com"),
		// 				Region: to.Ptr("West US 2"),
		// 				SiteResourceIDs: []*armappservice.Identifier{
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Get custom hostnames under this subscription
 *
 * @summary Get custom hostnames under this subscription
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomSpecificHostNameSites.json
 */
async function getSpecificCustomHostnameUnderSubscription() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const hostname = "www.example.com";
  const options = { hostname };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.listCustomHostNameSites(options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListCustomSpecificHostNameSites.json
// this example is just showing the usage of "ListCustomHostNameSites" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
string hostname = "www.example.com";
await foreach (CustomHostnameSites item in subscriptionResource.GetCustomHostNameSitesAsync(hostname: hostname))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com",
      "name": "www.example.com",
      "type": "Microsoft.Web/customhostnameSites",
      "properties": {
        "customHostname": "www.example.com",
        "region": "West US 2",
        "siteResourceIds": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3"
          }
        ]
      }
    }
  ],
  "nextLink": null
}

Definities

Name	Description
CustomHostnameSites	Een hostnaam en de toegewezen sites
CustomHostnameSitesCollection	Verzameling van aangepaste hostnaamsites
DefaultErrorResponse	Foutreactie van App Service.
Details
Error	Foutmodel.
Identifier	Een domeinspecifieke resource-id.

CustomHostnameSites

Object

Een hostnaam en de toegewezen sites

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.customHostname	string
properties.region	string
properties.siteResourceIds	Identifier[]	Een domeinspecifieke resource-id.
type	string	Type bron

CustomHostnameSitesCollection

Object

Verzameling van aangepaste hostnaamsites

Name	Type	Description
nextLink	string	Koppeling naar de volgende pagina met resources.
value	CustomHostnameSites[]	Verzameling resources.

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	Error	Foutmodel.

Details

Object

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

Error

Object

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 foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Identifier

Object

Een domeinspecifieke resource-id.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.id	string	Tekenreeksweergave van de identiteit.
type	string	Type bron

Delen via

List Custom Host Name Sites - List Custom Host Name Sites

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Get custom hostnames under subscription

Voorbeeldaanvraag

Voorbeeldrespons

Get specific custom hostname under subscription

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CustomHostnameSites

CustomHostnameSitesCollection

DefaultErrorResponse

Details

Error

Identifier