List Custom Host Name Sites - List Custom Host Name Sites

Layanan:: App Service

Versi API:: 2025-05-01

Dapatkan nama host kustom di bawah langganan ini

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
hostname	query		string	Nama host tertentu

Respons

Nama	Jenis	Deskripsi
200 OK	CustomHostnameSitesCollection	Permintaan itu berhasil.
Other Status Codes	DefaultErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get custom hostnames under subscription

Get specific custom hostname under subscription

Get custom hostnames under subscription

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

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="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: 2025-05-01/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

Respon sampel

Kode status:: 200

{
  "nextLink": null,
  "value": [
    {
      "name": "mywebapp.azurewebsites.net",
      "type": "Microsoft.Web/customhostnameSites",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/mywebapp.azurewebsites.net",
      "properties": {
        "customHostname": "mywebapp.azurewebsites.net",
        "region": "West US",
        "siteResourceIds": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus-rg/providers/Microsoft.Web/sites/mywebapp"
          }
        ]
      }
    },
    {
      "name": "www.example.com",
      "type": "Microsoft.Web/customhostnameSites",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com",
      "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"
          }
        ]
      }
    }
  ]
}

Get specific custom hostname under subscription

Permintaan sampel

HTTP
Python

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

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="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: 2025-05-01/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

Respon sampel

Kode status:: 200

{
  "nextLink": null,
  "value": [
    {
      "name": "www.example.com",
      "type": "Microsoft.Web/customhostnameSites",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com",
      "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"
          }
        ]
      }
    }
  ]
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
CustomHostnameSites	Nama host dan situs yang ditetapkan
CustomHostnameSitesCollection	Kumpulan situs nama host khusus
DefaultErrorResponse	Respons kesalahan App Service.
DefaultErrorResponseError	Model kesalahan.
DefaultErrorResponseErrorDetailsItem	Kesalahan terperinci.
Identifier	Pengidentifikasi sumber daya khusus domain.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

CustomHostnameSites

Objek

Nama host dan situs yang ditetapkan

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
kind	string	Jenis sumber daya.
name	string	Nama Sumber Daya.
properties.customHostname	string
properties.region	string
properties.siteResourceIds	Identifier[]	Pengidentifikasi sumber daya khusus domain.
type	string	Jenis sumber daya.

CustomHostnameSitesCollection

Objek

Kumpulan situs nama host khusus

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	CustomHostnameSites[]	Item CustomHostnameSites di halaman ini

DefaultErrorResponse

Objek

Respons kesalahan App Service.

Nama	Jenis	Deskripsi
error	DefaultErrorResponseError	Model kesalahan.

DefaultErrorResponseError

Objek

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	DefaultErrorResponseErrorDetailsItem[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

DefaultErrorResponseErrorDetailsItem

Objek

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

Identifier

Objek

Pengidentifikasi sumber daya khusus domain.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Jenis sumber daya.
name	string	Nama sumber daya
properties.id	string	Representasi string identitas.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.