List Custom Host Name Sites - List Custom Host Name Sites

Service:

App Service

API Version:

2023-12-01

Pobieranie niestandardowych nazw hostów w ramach tej subskrypcji

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Wersja interfejsu API
hostname	query		string	Określona nazwa hosta

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CustomHostnameSitesCollection	OK
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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
}

Definicje

Nazwa	Opis
CustomHostnameSites	Nazwa hosta i przypisane do niego witryny
CustomHostnameSitesCollection	Kolekcja niestandardowych witryn nazw hostów
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.
Identifier	Identyfikator zasobu specyficzny dla domeny.

CustomHostnameSites

Nazwa hosta i przypisane do niego witryny

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.customHostname	string
properties.region	string
properties.siteResourceIds	Identifier[]	Identyfikator zasobu specyficzny dla domeny.
type	string	Typ zasobu.

CustomHostnameSitesCollection

Kolekcja niestandardowych witryn nazw hostów

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	CustomHostnameSites[]	Kolekcja zasobów.

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Identifier

Identyfikator zasobu specyficzny dla domeny.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.id	string	Reprezentacja ciągu tożsamości.
type	string	Typ zasobu.