List Custom Host Name Sites - List Custom Host Name Sites
Obtención de nombres de host personalizados en esta suscripción
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites?api-version=2023-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites?hostname={hostname}&api-version=2023-12-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-00000000000000). |
api-version
|
query | True |
string |
Versión de la API |
hostname
|
query |
string |
Nombre de host específico |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
App Service respuesta de error. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Get custom hostnames under subscription |
Get specific custom hostname under subscription |
Get custom hostnames under subscription
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites?api-version=2023-12-01
Sample Response
{
"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
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
{
"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
}
Definiciones
Nombre | Description |
---|---|
Custom |
Un nombre de host y sus sitios asignados |
Custom |
Colección de sitios de nombre de host personalizados |
Default |
App Service respuesta de error. |
Details | |
Error |
Modelo de error. |
Identifier |
Identificador de recursos específico del dominio. |
CustomHostnameSites
Un nombre de host y sus sitios asignados
Nombre | Tipo | Description |
---|---|---|
id |
string |
Id. de recurso. |
kind |
string |
Tipo de recurso. |
name |
string |
Nombre del recurso. |
properties.customHostname |
string |
|
properties.region |
string |
|
properties.siteResourceIds |
Identificador de recursos específico del dominio. |
|
type |
string |
Tipo de recurso. |
CustomHostnameSitesCollection
Colección de sitios de nombre de host personalizados
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Vínculo a la página siguiente de recursos. |
value |
Colección de recursos. |
DefaultErrorResponse
App Service respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Modelo de error. |
Details
Nombre | Tipo | Description |
---|---|---|
code |
string |
Cadena estandarizada para identificar mediante programación el error. |
message |
string |
Descripción detallada del error e información de depuración. |
target |
string |
Descripción detallada del error e información de depuración. |
Error
Modelo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Cadena estandarizada para identificar mediante programación el error. |
details |
Details[] |
Errores detallados. |
innererror |
string |
Más información para depurar el error. |
message |
string |
Descripción detallada del error e información de depuración. |
target |
string |
Descripción detallada del error e información de depuración. |
Identifier
Identificador de recursos específico del dominio.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Id. de recurso. |
kind |
string |
Tipo de recurso. |
name |
string |
Nombre del recurso. |
properties.id |
string |
Representación de cadena de la identidad. |
type |
string |
Tipo de recurso. |