List Custom Host Name Sites - List Custom Host Name Sites

Usługa:

App Service

Wersja API:

2025-05-01

Uzyskaj niestandardowe nazwy hostów w ramach tej subskrypcji

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

Z opcjonalnymi parametrami:

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
hostname	query		string	Określona nazwa hosta

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CustomHostnameSitesCollection	Żądanie zakończyło się pomyślnie.
Other Status Codes	DefaultErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

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

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:

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

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:

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"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
CustomHostnameSites	Nazwa hosta i przypisane do niego lokacje
CustomHostnameSitesCollection	Kolekcja witryn z niestandardowymi nazwami hostów
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
DefaultErrorResponseError	Model błędu.
DefaultErrorResponseErrorDetailsItem	Szczegółowe błędy.
Identifier	Identyfikator zasobu specyficzny dla domeny.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

CustomHostnameSites

Sprzeciwiać się

Nazwa hosta i przypisane do niego lokacje

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

Sprzeciwiać się

Kolekcja witryn z niestandardowymi nazwami hostów

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	CustomHostnameSites[]	Elementy CustomHostnameSites na tej stronie

DefaultErrorResponse

Sprzeciwiać się

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	DefaultErrorResponseError	Model błędu.

DefaultErrorResponseError

Sprzeciwiać się

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowej identyfikacji błędu.
details	DefaultErrorResponseErrorDetailsItem[]	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.

DefaultErrorResponseErrorDetailsItem

Sprzeciwiać się

Szczegółowe błędy.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowej identyfikacji 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

Sprzeciwiać się

Identyfikator zasobu specyficzny dla domeny.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu
properties.id	string	Reprezentacja ciągu tożsamości.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.