List Custom Host Name Sites - List Custom Host Name Sites

Service:

App Service

API Version:

2023-12-01

Dapatkan nama host kustom di bawah langganan ini

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-00000000000).
api-version	query	True	string	Versi API
hostname	query		string	Nama host tertentu

Respons

Nama	Jenis	Deskripsi
200 OK	CustomHostnameSitesCollection	OK
Other Status Codes	DefaultErrorResponse	App Service respons kesalahan.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

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

Sample Request

HTTP

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

Sample Response

Status code:

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

Sample Request

HTTP

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

Sample Response

Status code:

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
}

Definisi

Nama	Deskripsi
CustomHostnameSites	Nama host dan situs yang ditetapkan
CustomHostnameSitesCollection	Kumpulan situs nama host kustom
DefaultErrorResponse	App Service respons kesalahan.
Details
Error	Model kesalahan.
Identifier	Pengidentifikasi sumber daya khusus domain.

CustomHostnameSites

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

Kumpulan situs nama host kustom

Nama	Jenis	Deskripsi
nextLink	string	Tautkan ke halaman sumber daya berikutnya.
value	CustomHostnameSites[]	Kumpulan sumber daya.

DefaultErrorResponse

App Service respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

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

Error

Model kesalahan.

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

Identifier

Pengidentifikasi sumber daya khusus domain.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
kind	string	Jenis sumber daya.
name	string	Nama Sumber Daya.
properties.id	string	Representasi string identitas.
type	string	Jenis sumber daya