Front Doors - Get

Obtém um Front Door com o nome do Front Door especificado na assinatura e no grupo de recursos especificados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}?api-version=2019-05-01

Parâmetros de URI

Name In Required Type Description
frontDoorName
path True
  • string

Nome do Front Door, que é globalmente exclusivo.

Regex pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$

resourceGroupName
path True
  • string

Nome do grupo de recursos na assinatura do Azure.

Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$

subscriptionId
path True
  • string

As credenciais de assinatura que identificam exclusivamente a assinatura Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão de API do cliente.

Respostas

Name Type Description
200 OK

OK. A solicitação foi bem-sucedida.

Other Status Codes

Resposta de erro do Front Door que descreve por que a operação falhou.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get Front Door

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1?api-version=2019-05-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
  "name": "frontDoor1",
  "type": "Microsoft.Network/frontDoor",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": "",
            "forwardingProtocol": "MatchRequest",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled",
    "resourceState": "Enabled",
    "provisioningState": "Succeeded",
    "cname": "frontDoor1.azurefd.net"
  }
}

Definições

Backend

Endereço de back-end de um balanceador de carga frontDoor.

backendEnabledState

Se deseja habilitar o uso desse back-end. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

BackendPool

Um pool de back-end é uma coleção de back-ends que podem ser roteados.

BackendPoolsSettings

Configurações que se aplicam a todos os pools de back-end.

CacheConfiguration

Caching configurações para uma rota de tipo de cache. Para desabilitar o cache, não forneça um objeto cacheConfiguration.

CustomHttpsConfiguration

Configurações de https para um domínio

CustomHttpsProvisioningState

Status de provisionamento de Https Personalizados do frontendEndpoint.

CustomHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso da habilitação/desabilitação de HTTPS personalizada passo a passo.

DynamicCompressionEnabled

Se deve usar compactação dinâmica para conteúdo armazenado em cache

enforceCertificateNameCheckEnabledState

Se deseja impor a verificação de nome de certificado em solicitações HTTPS a todos os pools de back-end. Nenhum efeito em solicitações não HTTPS.

ErrorResponse

A resposta de erro indica que o serviço Front Door não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

ForwardingConfiguration

Descreve a rota de encaminhamento.

FrontDoor

O Front Door representa uma coleção de pontos de extremidade de back-end para rotear o tráfego junto com regras que especificam como o tráfego é enviado para lá.

FrontDoorCertificateSource

Define a origem do certificado SSL

FrontDoorCertificateType

Define o tipo do certificado usado para conexões seguras com um front-endEndpoint

FrontDoorEnabledState

Status operacional do balanceador de carga do Front Door. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

FrontDoorForwardingProtocol

Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.

FrontDoorHealthProbeMethod

Configura qual método HTTP usar para investigar os back-ends definidos em back-endPools.

FrontDoorProtocol

Esquema de protocolo a ser usado para esta investigação

FrontDoorQuery

Tratamento de termos de consulta de URL ao formar a chave de cache.

FrontDoorRedirectProtocol

O protocolo do destino para onde o tráfego é redirecionado

FrontDoorRedirectType

O tipo de redirecionamento que a regra usará ao redirecionar o tráfego.

FrontDoorResourceState

Status do recurso do Front Door ou do SubResource do Front Door.

FrontDoorTlsProtocolType

Define o protocolo de extensão TLS usado para entrega segura

FrontendEndpoint

Um ponto de extremidade de front-end usado para roteamento.

HealthProbeEnabled

Se as investigações de integridade devem ser feitas em back-ends definidos em back-endPools. Investigações de integridade só poderão ser desabilitadas se houver um único back-end habilitado em um único pool de back-end habilitado.

HealthProbeSettingsModel

Configurações de balanceamento de carga para um pool de back-end

LoadBalancingSettingsModel

Configurações de balanceamento de carga para um pool de back-end

MinimumTLSVersion

A versão mínima do TLS necessária dos clientes para estabelecer um handshake SSL com o Front Door.

RedirectConfiguration

Descreve a rota de redirecionamento.

RoutingRule

Uma regra de roteamento representa uma especificação para o tráfego a ser tratado e para onde enviá-lo, juntamente com informações de investigação de integridade.

routingRuleEnabledState

Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

SessionAffinityEnabledState

Se deseja permitir a afinidade de sessão neste host. As opções válidas são 'Habilitado' ou 'Desabilitado'

SubResource

Referência a outra sub-fonte.

Vault

O Key Vault que contém o certificado SSL

WebApplicationFirewallPolicyLink

Define a política de Firewall de Aplicativo Web para cada host (se aplicável)

Backend

Endereço de back-end de um balanceador de carga frontDoor.

Name Type Description
address
  • string

Localização do back-end (endereço IP ou FQDN)

backendHostHeader
  • string

O valor a ser usado como o cabeçalho de host enviado para o back-end. Se estiver em branco ou não for especificado, esse padrão será o host de entrada.

enabledState

Se deseja habilitar o uso desse back-end. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

httpPort
  • integer

O número da porta TCP do HTTP. Precisa estar entre 1 e 65535.

httpsPort
  • integer

O número da porta TCP do HTTPS. Precisa estar entre 1 e 65535.

priority
  • integer

A prioridade a ser usada para o balanceamento de carga. Prioridades mais altas não serão usadas para balanceamento de carga se qualquer back-end de prioridade inferior estiver íntegro.

weight
  • integer

O peso desse ponto de extremidade para fins de balanceamento de carga.

backendEnabledState

Se deseja habilitar o uso desse back-end. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

Name Type Description
Disabled
  • string
Enabled
  • string

BackendPool

Um pool de back-end é uma coleção de back-ends que podem ser roteados.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.backends

O conjunto de back-ends para esse pool

properties.healthProbeSettings

Configurações de investigação de integridade L7 para um pool de back-end

properties.loadBalancingSettings

Configurações de balanceamento de carga para um pool de back-end

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso.

type
  • string

Tipo de recurso.

BackendPoolsSettings

Configurações que se aplicam a todos os pools de back-end.

Name Type Default Value Description
enforceCertificateNameCheck Enabled

Se você deve impor a verificação de nome de certificado em solicitações HTTPS para todos os pools de back-end. Nenhum efeito em solicitações não HTTPS.

sendRecvTimeoutSeconds
  • integer

Enviar e receber tempo limite na solicitação de encaminhamento para o back-end. Quando o tempo limite é atingido, a solicitação falha e retorna.

CacheConfiguration

Caching configurações para uma rota de tipo de cache. Para desabilitar o cache, não forneça um objeto cacheConfiguration.

Name Type Description
dynamicCompression

Se deve usar compactação dinâmica para conteúdo armazenado em cache

queryParameterStripDirective

Tratamento de termos de consulta de URL ao formar a chave de cache.

CustomHttpsConfiguration

Configurações de https para um domínio

Name Type Description
certificateSource

Define a origem do certificado SSL

frontDoorCertificateSourceParameters.certificateType

Define o tipo do certificado usado para conexões seguras com um front-endEndpoint

keyVaultCertificateSourceParameters.secretName
  • string

O nome do segredo do Key Vault que representa o PFX do certificado completo

keyVaultCertificateSourceParameters.secretVersion
  • string

A versão do segredo do Key Vault que representa o PFX do certificado completo

keyVaultCertificateSourceParameters.vault

O Key Vault que contém o certificado SSL

minimumTlsVersion

A versão mínima do TLS necessária dos clientes para estabelecer um handshake SSL com o Front Door.

protocolType

Define o protocolo de extensão TLS usado para entrega segura

CustomHttpsProvisioningState

Status de provisionamento de Https Personalizados do frontendEndpoint.

Name Type Description
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string
Failed
  • string

CustomHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso da habilitação/desabilitação de HTTPS personalizada passo a passo.

Name Type Description
CertificateDeleted
  • string
CertificateDeployed
  • string
DeletingCertificate
  • string
DeployingCertificate
  • string
DomainControlValidationRequestApproved
  • string
DomainControlValidationRequestRejected
  • string
DomainControlValidationRequestTimedOut
  • string
IssuingCertificate
  • string
PendingDomainControlValidationREquestApproval
  • string
SubmittingDomainControlValidationRequest
  • string

DynamicCompressionEnabled

Se deve usar compactação dinâmica para conteúdo armazenado em cache

Name Type Description
Disabled
  • string
Enabled
  • string

enforceCertificateNameCheckEnabledState

Se deseja impor a verificação de nome de certificado em solicitações HTTPS a todos os pools de back-end. Nenhum efeito em solicitações não HTTPS.

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorResponse

A resposta de erro indica que o serviço Front Door não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

ForwardingConfiguration

Descreve a rota de encaminhamento.

Name Type Description
@odata.type string:
  • #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
backendPool

Uma referência ao BackendPool para o qual essa regra é roteada.

cacheConfiguration

A configuração de cache associada a essa regra.

customForwardingPath
  • string

Um caminho personalizado usado para reescrever caminhos de recurso correspondentes a essa regra. Deixe em branco para usar o caminho de entrada.

forwardingProtocol

Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.

FrontDoor

O Front Door representa uma coleção de pontos de extremidade de back-end para rotear o tráfego junto com regras que especificam como o tráfego é enviado para lá.

Name Type Description
id
  • string

ID do recurso.

location
  • string

Local do recurso.

name
  • string

Nome do recurso.

properties.backendPools

Pools de back-end disponíveis para regras de roteamento.

properties.backendPoolsSettings

Configurações para todos os back-endPools

properties.cname
  • string

O host para o qual cada frontendEndpoint deve CNAME.

properties.enabledState

Status operacional do balanceador de carga do Front Door. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

properties.friendlyName
  • string

Um nome amigável para o frontDoor

properties.frontendEndpoints

Pontos de extremidade de front-end disponíveis para regras de roteamento.

properties.healthProbeSettings

Configurações de investigação de integridade associadas a esta instância do Front Door.

properties.loadBalancingSettings

Configurações de balanceamento de carga associadas a esta instância do Front Door.

properties.provisioningState
  • string

Estado de provisionamento do Front Door.

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso do Front Door.

properties.routingRules

Regras de roteamento associadas a este Front Door.

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.

FrontDoorCertificateSource

Define a origem do certificado SSL

Name Type Description
AzureKeyVault
  • string
FrontDoor
  • string

FrontDoorCertificateType

Define o tipo do certificado usado para conexões seguras com um front-endEndpoint

Name Type Description
Dedicated
  • string

FrontDoorEnabledState

Status operacional do balanceador de carga do Front Door. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

Name Type Description
Disabled
  • string
Enabled
  • string

FrontDoorForwardingProtocol

Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.

Name Type Description
HttpOnly
  • string
HttpsOnly
  • string
MatchRequest
  • string

FrontDoorHealthProbeMethod

Configura qual método HTTP usar para investigar os back-ends definidos em back-endPools.

Name Type Description
GET
  • string
HEAD
  • string

FrontDoorProtocol

Esquema de protocolo a ser usado para esta investigação

Name Type Description
Http
  • string
Https
  • string

FrontDoorQuery

Tratamento de termos de consulta de URL ao formar a chave de cache.

Name Type Description
StripAll
  • string
StripNone
  • string

FrontDoorRedirectProtocol

O protocolo do destino para onde o tráfego é redirecionado

Name Type Description
HttpOnly
  • string
HttpsOnly
  • string
MatchRequest
  • string

FrontDoorRedirectType

O tipo de redirecionamento que a regra usará ao redirecionar o tráfego.

Name Type Description
Found
  • string
Moved
  • string
PermanentRedirect
  • string
TemporaryRedirect
  • string

FrontDoorResourceState

Status do recurso do Front Door ou do SubResource do Front Door.

Name Type Description
Creating
  • string
Deleting
  • string
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string

FrontDoorTlsProtocolType

Define o protocolo de extensão TLS usado para entrega segura

Name Type Description
ServerNameIndication
  • string

FrontendEndpoint

Um ponto de extremidade de front-end usado para roteamento.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.customHttpsConfiguration

A configuração que especifica como habilitar HTTPS

properties.customHttpsProvisioningState

Status de provisionamento de Https Personalizados do front-endEndpoint.

properties.customHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso da habilitação/desabilitação do processo https personalizado passo a passo.

properties.hostName
  • string

O nome de host do frontendEndpoint. Precisa ser um nome de domínio.

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso.

properties.sessionAffinityEnabledState

Se deseja permitir a afinidade de sessão neste host. As opções válidas são "Habilitado" ou "Desabilitado"

properties.sessionAffinityTtlSeconds
  • integer

UTILIZADAS. Esse campo será ignorado. O TTL a ser usado em segundos para afinidade de sessão, se aplicável.

properties.webApplicationFirewallPolicyLink

Define a política de Firewall de Aplicativo Web para cada host (se aplicável)

type
  • string

Tipo de recurso.

HealthProbeEnabled

Se as investigações de integridade devem ser feitas em back-ends definidos em back-endPools. Investigações de integridade só poderão ser desabilitadas se houver um único back-end habilitado em um único pool de back-end habilitado.

Name Type Description
Disabled
  • string
Enabled
  • string

HealthProbeSettingsModel

Configurações de balanceamento de carga para um pool de back-end

Name Type Default Value Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.enabledState

Se as investigações de integridade devem ser feitas em back-ends definidos em back-endPools. Investigações de integridade só poderão ser desabilitadas se houver um único back-end habilitado em um único pool de back-end habilitado.

properties.healthProbeMethod HEAD

Configura qual método HTTP usar para investigar os back-ends definidos em back-endPools.

properties.intervalInSeconds
  • integer

O número de segundos entre as investigações de integridade.

properties.path
  • string

O caminho a ser usado para a investigação de integridade. O padrão é /

properties.protocol

Esquema de protocolo a ser usado para esta investigação

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso.

type
  • string

Tipo de recurso.

LoadBalancingSettingsModel

Configurações de balanceamento de carga para um pool de back-end

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.additionalLatencyMilliseconds
  • integer

A latência adicional em milissegundos para que as investigações caiam no bucket de latência mais baixo

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso.

properties.sampleSize
  • integer

O número de exemplos a serem considerados para decisões de balanceamento de carga

properties.successfulSamplesRequired
  • integer

O número de exemplos dentro do período de exemplo que deve ter êxito

type
  • string

Tipo de recurso.

MinimumTLSVersion

A versão mínima do TLS necessária dos clientes para estabelecer um handshake SSL com o Front Door.

Name Type Description
1.0
  • string
1.2
  • string

RedirectConfiguration

Descreve a rota de redirecionamento.

Name Type Description
@odata.type string:
  • #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration
customFragment
  • string

Fragmento a ser adicionado à URL de redirecionamento. Fragmento é a parte da URL que vem depois de #. Não inclua o #.

customHost
  • string

Hospede para redirecionar. Deixe vazio para usar o host de entrada como o host de destino.

customPath
  • string

O caminho completo para redirecionamento. O caminho não pode estar vazio e deve começar com /. Deixe vazio para usar o caminho de entrada como caminho de destino.

customQueryString
  • string

O conjunto de cadeias de caracteres de consulta a serem colocadas na URL de redirecionamento. Definir esse valor substituiria qualquer cadeia de caracteres de consulta existente; deixe vazio para preservar a cadeia de caracteres de consulta de entrada. A cadeia de caracteres de consulta deve estar em = formato. O primeiro? e & será adicionado automaticamente, portanto, não os inclua na frente, mas separe várias cadeias de caracteres de consulta com &.

redirectProtocol

O protocolo do destino para onde o tráfego é redirecionado

redirectType

O tipo de redirecionamento que a regra usará ao redirecionar o tráfego.

RoutingRule

Uma regra de roteamento representa uma especificação para o tráfego a ser tratado e para onde enviá-lo, juntamente com informações de investigação de integridade.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.acceptedProtocols
  • string[]

Esquemas de protocolo para corresponder a essa regra

properties.enabledState

Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

properties.frontendEndpoints

Pontos de extremidade de front-end associados a essa regra

properties.patternsToMatch
  • string[]

Os padrões de rota da regra.

properties.resourceState

Status do recurso do Front Door ou do SubResource do Front Door.
Status do recurso.

properties.routeConfiguration RouteConfiguration:

Uma referência à configuração de roteamento.

type
  • string

Tipo de recurso.

routingRuleEnabledState

Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

Name Type Description
Disabled
  • string
Enabled
  • string

SessionAffinityEnabledState

Se deseja permitir a afinidade de sessão neste host. As opções válidas são 'Habilitado' ou 'Desabilitado'

Name Type Description
Disabled
  • string
Enabled
  • string

SubResource

Referência a outra sub-fonte.

Name Type Description
id
  • string

ID do recurso.

Vault

O Key Vault que contém o certificado SSL

Name Type Description
id
  • string

ID do recurso.

Define a política de Firewall de Aplicativo Web para cada host (se aplicável)

Name Type Description
id
  • string

ID do recurso.