Web Apps - Analyze Custom Hostname

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição para Analisar um nome de anfitrião personalizado.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome da aplicação Web.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
api-version	query	True	string	Versão da API
hostName	query		string	Nome de anfitrião personalizado.

Respostas

Name	Tipo	Description
200 OK	CustomHostnameAnalysisResult	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Analyze custom hostname for webapp.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/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",
  "name": "sitef6141",
  "type": "Microsoft.Web/sites",
  "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",
    "cNameRecords": [
      "siteog.azurewebsites.net"
    ]
  }
}

Definições

Name	Description
CustomHostnameAnalysisResult	Análise de domínio personalizada.
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
Details
DnsVerificationTestResult	Resultado do teste de verificação DNS.
Error	Modelo de erro.
ErrorEntity	Corpo da resposta de erro devolvida da API.

CustomHostnameAnalysisResult

Análise de domínio personalizada.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.aRecords	string[]	Um controlador de registos pode ver este nome de anfitrião.
properties.alternateCNameRecords	string[]	O controlador de registos CName alternativo pode ver este nome de anfitrião.
properties.alternateTxtRecords	string[]	O controlador de registos TXT alternativo pode ver este nome de anfitrião.
properties.cNameRecords	string[]	O controlador de registos CName pode ver este nome de anfitrião.
properties.conflictingAppResourceId	string	Nome da aplicação em conflito na unidade de dimensionamento se estiver na mesma subscrição.
properties.customDomainVerificationFailureInfo	ErrorEntity	Informações de falha não processadas se a verificação DNS falhar.
properties.customDomainVerificationTest	DnsVerificationTestResult	Resultado do teste de verificação DNS.
properties.hasConflictAcrossSubscription	boolean	`true` se existir um conflito entre subscrições; caso contrário, `false`.
properties.hasConflictOnScaleUnit	boolean	`true` se existir um conflito numa unidade de escala; caso contrário, `false`.
properties.isHostnameAlreadyVerified	boolean	`true` se o nome do anfitrião já estiver verificado; caso contrário, `false`.
properties.txtRecords	string[]	O controlador de registos TXT pode ver este nome de anfitrião.
type	string	Tipo de recurso.

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

DnsVerificationTestResult

Resultado do teste de verificação DNS.

Name	Tipo	Description
Failed	string
Passed	string
Skipped	string

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

ErrorEntity

Corpo da resposta de erro devolvida da API.

Name	Tipo	Description
code	string	Código de erro básico.
details	ErrorEntity[]	Detalhes do Erro.
extendedCode	string	Tipo de erro.
innerErrors	ErrorEntity[]	Erros internos.
message	string	Quaisquer detalhes do erro.
messageTemplate	string	Modelo de mensagem.
parameters	string[]	Parâmetros para o modelo.
target	string	O destino do erro.