List Custom Host Name Sites - List Custom Host Name Sites

Service:

App Service

API Version:

2023-12-01

Získání vlastních názvů hostitelů v rámci tohoto předplatného

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID vašeho předplatného Azure Jedná se o řetězec ve formátu GUID (např. 00000000-0000-0000-0000-0000000000000000).
api-version	query	True	string	Verze rozhraní API
hostname	query		string	Konkrétní název hostitele

Odpovědi

Name	Typ	Description
200 OK	CustomHostnameSitesCollection	OK
Other Status Codes	DefaultErrorResponse	App Service chybovou odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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
}

Definice

Name	Description
CustomHostnameSites	Název hostitele a přiřazené weby
CustomHostnameSitesCollection	Kolekce webů s vlastními názvy hostitelů
DefaultErrorResponse	App Service chybovou odpověď.
Details
Error	Model chyb.
Identifier	Identifikátor prostředku specifický pro doménu.

CustomHostnameSites

Název hostitele a přiřazené weby

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
name	string	Název prostředku.
properties.customHostname	string
properties.region	string
properties.siteResourceIds	Identifier[]	Identifikátor prostředku specifický pro doménu.
type	string	Typ prostředku.

CustomHostnameSitesCollection

Kolekce webů s vlastními názvy hostitelů

Name	Typ	Description
nextLink	string	Odkaz na další stránku zdrojů
value	CustomHostnameSites[]	Kolekce prostředků.

DefaultErrorResponse

App Service chybovou odpověď.

Name	Typ	Description
error	Error	Model chyb.

Details

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

Error

Model chyb.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
details	Details[]	Podrobné chyby.
innererror	string	Další informace o chybě ladění
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

Identifier

Identifikátor prostředku specifický pro doménu.

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
name	string	Název prostředku.
properties.id	string	Řetězcová reprezentace identity.
type	string	Typ prostředku.