Front Doors - Get

Obtém uma porta frontal com o nome da porta frontal especificado no grupo de subscrição e recursos especificados.

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

Parâmetros do URI

Name In Required Type Description
frontDoorName
path True
  • string

Nome da Porta da Frente que é globalmente único.

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

resourceGroupName
path True
  • string

Nome do grupo de recursos dentro da assinatura Azure.

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

subscriptionId
path True
  • string

As credenciais de subscrição que identificam exclusivamente a subscrição Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão API do cliente.

Respostas

Name Type Description
200 OK

OK. O pedido foi bem sucedido.

Other Status Codes

Resposta de erro da porta da frente descrevendo por que a operação falhou.

Segurança

azure_auth

Flow de Azure Ative Directory OAuth2

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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 backend de um balançador de carga frontDoor.

backendEnabledState

Se permitir a utilização deste backend. Os valores permitidos são 'Activados' ou 'Desactivados'

BackendPool

Uma piscina de backend é uma coleção de backends que pode ser encaminhado para.

BackendPoolsSettings

Definições que se aplicam a todas as piscinas de backend.

CacheConfiguration

Colocação em Cache configurações para uma rota do tipo caching. Para desativar o cache, não forneça um objeto de cacheConfiguration.

CustomHttpsConfiguration

Definições de https para um domínio

CustomHttpsProvisioningState

Estado de provisionamento de Https Personalizados do frontendEndpoint.

CustomHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso do processo https personalizado que permite/desativa o processo passo a passo.

DynamicCompressionEnabled

Se usar compressão dinâmica para conteúdo em cache

enforceCertificateNameCheckEnabledState

Se para impor o nome do certificado verifique os pedidos HTTPS a todos os pools de backend. Nenhum efeito sobre os pedidos não-HTTPS.

ErrorResponse

A resposta de erro indica que o serviço porta frontal não é capaz de processar o pedido de entrada. A razão é fornecida na mensagem de erro.

ForwardingConfiguration

Descreve rota de encaminhamento.

FrontDoor

A Porta da Frente representa uma coleção de pontos finais de backend para encaminhar o tráfego para, juntamente com regras que especificam como o tráfego é enviado para lá.

FrontDoorCertificateSource

Define a origem do certificado SSL

FrontDoorCertificateType

Define o tipo de certificado utilizado para ligações seguras a um frontendEndpoint

FrontDoorEnabledState

Estado operacional do balançador de carga da porta da frente. Os valores permitidos são 'Activados' ou 'Desactivados'

FrontDoorForwardingProtocol

Protocolo esta regra utilizará quando encaminhar o tráfego para backends.

FrontDoorHealthProbeMethod

Configurações que o método HTTP a utilizar para sondar os backends definidos em backendPools.

FrontDoorProtocol

Esquema de protocolo para usar para esta sonda

FrontDoorQuery

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

FrontDoorRedirectProtocol

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

FrontDoorRedirectType

O tipo de redireccionamento que a regra utilizará ao redirecionar o tráfego.

FrontDoorResourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.

FrontDoorTlsProtocolType

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

FrontendEndpoint

Um ponto final de frontend usado para encaminhamento.

HealthProbeEnabled

Se permitir que as sondas de saúde sejam feitas contra backendpools definidas em backendPools. As sondas de saúde só podem ser desativadas se houver um único backend ativado em um único pool de backend ativado.

HealthProbeSettingsModel

Ajustes de equilíbrio de carga para uma piscina de backend

LoadBalancingSettingsModel

Ajustes de equilíbrio de carga para uma piscina de backend

MinimumTLSVersion

A versão TLS mínima exigida aos clientes para estabelecer um aperto de mão SSL com Porta frontal.

RedirectConfiguration

Descreve rota de redirecionamento.

RoutingRule

Uma regra de encaminhamento representa uma especificação para o tráfego tratar e para onde enviá-lo, juntamente com informações sobre sondas de saúde.

routingRuleEnabledState

Se permitir o uso desta regra. Os valores permitidos são 'Activados' ou 'Desactivados'

SessionAffinityEnabledState

Se permitir a afinidade da sessão neste anfitrião. As opções válidas são 'Activadas' ou 'Desactivadas'

SubResource

Referência a outro subresource.

Vault

O Key Vault que contém o certificado SSL

WebApplicationFirewallPolicyLink

Define a política de Firewall de Aplicações Web para cada hospedeiro (se aplicável)

Backend

Endereço backend de um balançador de carga frontDoor.

Name Type Description
address
  • string

Localização do backend (endereço IP ou FQDN)

backendHostHeader
  • string

O valor a utilizar como cabeçalho do anfitrião enviado para o backend. Se em branco ou não especificado, isto é padrão para o anfitrião que está a chegar.

enabledState

Se permitir a utilização deste backend. Os valores permitidos são 'Activados' ou 'Desactivados'

httpPort
  • integer

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

httpsPort
  • integer

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

priority
  • integer

Prioridade a utilizar para equilibrar cargas. As prioridades mais elevadas não serão utilizadas para o equilíbrio da carga se qualquer backend de menor prioridade for saudável.

weight
  • integer

Peso deste ponto final para efeitos de equilíbrio de carga.

backendEnabledState

Se permitir a utilização deste backend. Os valores permitidos são 'Activados' ou 'Desactivados'

Name Type Description
Disabled
  • string
Enabled
  • string

BackendPool

Uma piscina de backend é uma coleção de backends que pode ser encaminhado para.

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.backends

O conjunto de backends para esta piscina

properties.healthProbeSettings

Definições de sonda de saúde L7 para uma piscina de backend

properties.loadBalancingSettings

Ajustes de equilíbrio de carga para uma piscina de backend

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos.

type
  • string

Tipo de recurso.

BackendPoolsSettings

Definições que se aplicam a todas as piscinas de backend.

Name Type Default Value Description
enforceCertificateNameCheck Enabled

Se para impor o nome do certificado verifique os pedidos HTTPS a todos os pools de backend. Nenhum efeito sobre os pedidos não-HTTPS.

sendRecvTimeoutSeconds
  • integer

Envie e receba um tempo limite no envio do pedido para o backend. Quando o tempo limite é atingido, o pedido falha e regressa.

CacheConfiguration

Colocação em Cache configurações para uma rota do tipo caching. Para desativar o cache, não forneça um objeto de cacheConfiguration.

Name Type Description
dynamicCompression

Se usar compressão dinâmica para conteúdo em cache

queryParameterStripDirective

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

CustomHttpsConfiguration

Definições de https para um domínio

Name Type Description
certificateSource

Define a origem do certificado SSL

frontDoorCertificateSourceParameters.certificateType

Define o tipo de certificado utilizado para ligações seguras a um frontendEndpoint

keyVaultCertificateSourceParameters.secretName
  • string

O nome do segredo Key Vault representando o certificado completo PFX

keyVaultCertificateSourceParameters.secretVersion
  • string

A versão do segredo Key Vault representando o certificado completo PFX

keyVaultCertificateSourceParameters.vault

O Key Vault que contém o certificado SSL

minimumTlsVersion

A versão TLS mínima exigida aos clientes para estabelecer um aperto de mão SSL com Porta frontal.

protocolType

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

CustomHttpsProvisioningState

Estado 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 do processo https personalizado que permite/desativa o processo 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 usar compressão dinâmica para conteúdo em cache

Name Type Description
Disabled
  • string
Enabled
  • string

enforceCertificateNameCheckEnabledState

Se para impor o nome do certificado verifique os pedidos HTTPS a todos os pools de backend. Nenhum efeito sobre os pedidos não-HTTPS.

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorResponse

A resposta de erro indica que o serviço porta frontal não é capaz de processar o pedido de entrada. A razão é fornecida na mensagem de erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

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

ForwardingConfiguration

Descreve rota de encaminhamento.

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

Uma referência ao BackendPool a que esta regra se encaminha.

cacheConfiguration

A configuração do caching associada a esta regra.

customForwardingPath
  • string

Um caminho personalizado usado para reescrever caminhos de recursos combinados com esta regra. Deixe vazio para utilizar o caminho de entrada.

forwardingProtocol

Protocolo esta regra utilizará quando encaminhar o tráfego para backends.

FrontDoor

A Porta da Frente representa uma coleção de pontos finais de backend para encaminhar o tráfego para, juntamente com regras que especificam como o tráfego é enviado para lá.

Name Type Description
id
  • string

Identificação de recursos.

location
  • string

Localização do recurso.

name
  • string

Nome de recurso.

properties.backendPools

Piscinas de backend disponíveis para regras de encaminhamento.

properties.backendPoolsSettings

Definições para todos os backendPools

properties.cname
  • string

O anfitrião a que cada frontendEndpoint deve CNAME.

properties.enabledState

Estado operacional do balançador de carga da porta da frente. Os valores permitidos são 'Activados' ou 'Desactivados'

properties.friendlyName
  • string

Um nome amigável para a porta da frente

properties.frontendEndpoints

Pontos finais frontend disponíveis para regras de encaminhamento.

properties.healthProbeSettings

Definições de sonda de saúde associadas a esta instância da Porta frontal.

properties.loadBalancingSettings

Ajustes de equilíbrio de carga associados a esta instância da porta frontal.

properties.provisioningState
  • string

Estado de provisionamento da porta da frente.

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos da Porta da Frente.

properties.routingRules

Regras de encaminhamento associadas a esta Porta frontal.

tags
  • object

Etiquetas de recursos.

type
  • string

Tipo de recurso.

FrontDoorCertificateSource

Define a origem do certificado SSL

Name Type Description
AzureKeyVault
  • string
FrontDoor
  • string

FrontDoorCertificateType

Define o tipo de certificado utilizado para ligações seguras a um frontendEndpoint

Name Type Description
Dedicated
  • string

FrontDoorEnabledState

Estado operacional do balançador de carga da porta da frente. Os valores permitidos são 'Activados' ou 'Desactivados'

Name Type Description
Disabled
  • string
Enabled
  • string

FrontDoorForwardingProtocol

Protocolo esta regra utilizará quando encaminhar o tráfego para backends.

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

FrontDoorHealthProbeMethod

Configurações que o método HTTP a utilizar para sondar os backends definidos em backendPools.

Name Type Description
GET
  • string
HEAD
  • string

FrontDoorProtocol

Esquema de protocolo para usar para esta sonda

Name Type Description
Http
  • string
Https
  • string

FrontDoorQuery

Tratamento dos termos de consulta de URL ao formar a chave 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 redireccionamento que a regra utilizará ao redirecionar o tráfego.

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

FrontDoorResourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.

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

FrontDoorTlsProtocolType

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

Name Type Description
ServerNameIndication
  • string

FrontendEndpoint

Um ponto final de frontend usado para encaminhamento.

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.customHttpsConfiguration

A configuração especificando como ativar HTTPS

properties.customHttpsProvisioningState

Estado de provisionamento de Https Personalizados do frontendEndpoint.

properties.customHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso do processo https personalizado que permite/desativa o processo passo a passo.

properties.hostName
  • string

O nome de anfitrião do frontendEndpoint. Deve ser um nome de domínio.

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos.

properties.sessionAffinityEnabledState

Se permitir a afinidade da sessão neste anfitrião. As opções válidas são 'Activadas' ou 'Desactivadas'

properties.sessionAffinityTtlSeconds
  • integer

NÃO ÉUSTUMADO. Este campo será ignorado. O TTL para utilizar em segundos para afinidade da sessão, se aplicável.

properties.webApplicationFirewallPolicyLink

Define a política de Firewall de Aplicações Web para cada hospedeiro (se aplicável)

type
  • string

Tipo de recurso.

HealthProbeEnabled

Se permitir que as sondas de saúde sejam feitas contra backendpools definidas em backendPools. As sondas de saúde só podem ser desativadas se houver um único backend ativado em um único pool de backend ativado.

Name Type Description
Disabled
  • string
Enabled
  • string

HealthProbeSettingsModel

Ajustes de equilíbrio de carga para uma piscina de backend

Name Type Default Value Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.enabledState

Se permitir que as sondas de saúde sejam feitas contra backendpools definidas em backendPools. As sondas de saúde só podem ser desativadas se houver um único backend ativado em um único pool de backend ativado.

properties.healthProbeMethod HEAD

Configurações que o método HTTP a utilizar para sondar os backends definidos em backendPools.

properties.intervalInSeconds
  • integer

O número de segundos entre as sondas de saúde.

properties.path
  • string

O caminho a usar para a sonda de saúde. O padrão é /

properties.protocol

Esquema de protocolo para usar para esta sonda

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos.

type
  • string

Tipo de recurso.

LoadBalancingSettingsModel

Ajustes de equilíbrio de carga para uma piscina de backend

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.additionalLatencyMilliseconds
  • integer

A latência adicional em milissegundos para as sondas cair no menor balde de latência

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos.

properties.sampleSize
  • integer

O número de amostras a ter em conta para as decisões de equilíbrio de carga

properties.successfulSamplesRequired
  • integer

O número de amostras dentro do período de amostra que deve ter sucesso

type
  • string

Tipo de recurso.

MinimumTLSVersion

A versão TLS mínima exigida aos clientes para estabelecer um aperto de mão SSL com Porta frontal.

Name Type Description
1.0
  • string
1.2
  • string

RedirectConfiguration

Descreve rota de redirecionamento.

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

Fragmento para adicionar ao URL de redirecionamento. Fragmento é a parte do URL que vem depois de #. Não inclua o #.

customHost
  • string

Anfitrião para redirecionar. Deixe vazio para usar o anfitrião que chega como anfitrião de destino.

customPath
  • string

O caminho completo para redirecionar. O caminho não pode ser vazio e deve começar com /. Deixe vazio para utilizar o caminho de entrada como caminho de destino.

customQueryString
  • string

O conjunto de cordas de consulta a colocar no URL de redirecionamento. A definição deste valor substituiria qualquer cadeia de consulta existente; deixar vazio para preservar a cadeia de consulta de entrada. A cadeia de consulta deve estar em formato =. O primeiro? e & será adicionado automaticamente para não incluí-los na frente, mas separar várias cadeias de consulta com &.

redirectProtocol

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

redirectType

O tipo de redireccionamento que a regra utilizará ao redirecionar o tráfego.

RoutingRule

Uma regra de encaminhamento representa uma especificação para o tráfego tratar e para onde enviá-lo, juntamente com informações sobre sondas de saúde.

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.acceptedProtocols
  • string[]

Esquemas de protocolo para corresponder a esta regra

properties.enabledState

Se permitir o uso desta regra. Os valores permitidos são 'Activados' ou 'Desactivados'

properties.frontendEndpoints

Pontos finais frontend associados a esta regra

properties.patternsToMatch
  • string[]

Os padrões de rota da regra.

properties.resourceState

Estado do recurso da Porta frontal ou subResource da porta da frente.
Estado dos recursos.

properties.routeConfiguration RouteConfiguration:

Uma referência à configuração do encaminhamento.

type
  • string

Tipo de recurso.

routingRuleEnabledState

Se permitir o uso desta regra. Os valores permitidos são 'Activados' ou 'Desactivados'

Name Type Description
Disabled
  • string
Enabled
  • string

SessionAffinityEnabledState

Se permitir a afinidade da sessão neste anfitrião. As opções válidas são 'Activadas' ou 'Desactivadas'

Name Type Description
Disabled
  • string
Enabled
  • string

SubResource

Referência a outro subresource.

Name Type Description
id
  • string

Identificação de recursos.

Vault

O Key Vault que contém o certificado SSL

Name Type Description
id
  • string

Identificação de recursos.

Define a política de Firewall de Aplicações Web para cada hospedeiro (se aplicável)

Name Type Description
id
  • string

Identificação de recursos.