Web Apps - Analyze Custom Hostname Slot

Referencia

Service:: App Service

API Version:: 2023-12-01

Descripción para Analizar un nombre de host personalizado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname?hostName={hostName}&api-version=2023-12-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la aplicación web.
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el recurso. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Nombre de la ranura de la aplicación web. Si no se especifica, el valor predeterminado será el espacio de producción.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versión de la API
hostName	query		string	Nombre de host personalizado.

Respuestas

Nombre	Tipo	Description
200 OK	CustomHostnameAnalysisResult	Aceptar
Other Status Codes	DefaultErrorResponse	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

Analyze custom hostname for slot

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging/analyzeCustomHostname?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging",
  "name": "sitef6141/staging",
  "type": "Microsoft.Web/sites/stagings",
  "properties": {
    "isHostnameAlreadyVerified": true,
    "customDomainVerificationTest": "Passed",
    "customDomainVerificationFailureInfo": {
      "code": "07198",
      "message": "Custom domain verification failed on conflicting CNAMEs."
    },
    "hasConflictOnScaleUnit": false,
    "hasConflictAcrossSubscription": true,
    "conflictingAppResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog/slots/qa",
    "cNameRecords": [
      "siteog.azurewebsites.net"
    ]
  }
}

Definiciones

Nombre	Description
CustomHostnameAnalysisResult	Análisis de dominio personalizado.
DefaultErrorResponse	App Service respuesta de error.
Details
DnsVerificationTestResult	Resultado de la prueba de comprobación de DNS.
Error	Modelo de error.
ErrorEntity	Cuerpo de la respuesta de error devuelta desde la API.

CustomHostnameAnalysisResult

Análisis de dominio personalizado.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.aRecords	string[]	Un controlador de registros puede ver para este nombre de host.
properties.alternateCNameRecords	string[]	El controlador de registros CName alternativo puede ver para este nombre de host.
properties.alternateTxtRecords	string[]	El controlador de registros TXT alternativo puede ver para este nombre de host.
properties.cNameRecords	string[]	El controlador de registros CName puede ver para este nombre de host.
properties.conflictingAppResourceId	string	Nombre de la aplicación en conflicto en la unidad de escalado si se encuentra dentro de la misma suscripción.
properties.customDomainVerificationFailureInfo	ErrorEntity	Información de error sin procesar si se produce un error en la comprobación de DNS.
properties.customDomainVerificationTest	DnsVerificationTestResult	Resultado de la prueba de comprobación de DNS.
properties.hasConflictAcrossSubscription	boolean	`true` si hay un conflicto entre suscripciones; de lo contrario, `false`.
properties.hasConflictOnScaleUnit	boolean	`true` si hay un conflicto en una unidad de escalado; de lo contrario, `false`.
properties.isHostnameAlreadyVerified	boolean	`true` si ya se ha comprobado el nombre de host; de lo contrario, `false`.
properties.txtRecords	string[]	El controlador de registros TXT puede ver para este nombre de host.
type	string	Tipo de recurso.

DefaultErrorResponse

App Service respuesta de error.

Nombre	Tipo	Description
error	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.

DnsVerificationTestResult

Resultado de la prueba de comprobación de DNS.

Nombre	Tipo	Description
Failed	string
Passed	string
Skipped	string

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.

ErrorEntity

Cuerpo de la respuesta de error devuelta desde la API.

Nombre	Tipo	Description
code	string	Código de error básico.
details	ErrorEntity[]	Detalles del error.
extendedCode	string	Tipo de error.
innerErrors	ErrorEntity[]	Errores internos.
message	string	Cualquier detalle del error.
messageTemplate	string	Plantilla de mensaje.
parameters	string[]	Parámetros de la plantilla.
target	string	Destino del error.

Share via