Front Doors - Get

Возвращает Front Door с указанным именем Front Door в указанной подписке и группе ресурсов.

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

Параметры URI

Name In Required Type Description
frontDoorName
path True
  • string

Имя Front Door, которое является глобально уникальным.

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

resourceGroupName
path True
  • string

Имя группы ресурсов в подписке Azure.

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

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API клиента.

Ответы

Name Type Description
200 OK

Все в порядке. Запрос выполнен успешно.

Other Status Codes

Ответ об ошибке Front Door, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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"
  }
}

Определения

Backend

Внутренний адрес подсистемы балансировки нагрузки frontDoor.

backendEnabledState

Позволяет разрешить или запретить использование этого внутреннего сервера. Допустимые значения: Enabled или Disabled

BackendPool

Внутренний пул — это коллекция внутренних серверов, в которую можно направляться.

BackendPoolsSettings

Параметры, которые применяются ко всем серверным пулам.

CacheConfiguration

Параметры кэширования для маршрута типа кэширования. Чтобы отключить кэширование, не предоставляйте объект cacheConfiguration.

CustomHttpsConfiguration

Параметры https для домена

CustomHttpsProvisioningState

Состояние подготовки пользовательских https внешнего интерфейса.

CustomHttpsProvisioningSubstate

Подсостояние подготовки показывает ход выполнения настраиваемого процесса включения и отключения HTTPS по шагам.

DynamicCompressionEnabled

Следует ли использовать динамическое сжатие для кэшированного содержимого

enforceCertificateNameCheckEnabledState

Указывает, следует ли принудительно проверять имя сертификата для HTTPS-запросов ко всем внутренним пулам. Не влияет на запросы, отличные от HTTPS.

ErrorResponse

Ответ об ошибке указывает, что служба Front Door не может обработать входящий запрос. Причина указана в сообщении об ошибке.

ForwardingConfiguration

Описывает маршрут пересылки.

FrontDoor

Front Door представляет коллекцию внутренних конечных точек для маршрутизации трафика вместе с правилами, определяющими способ отправки трафика.

FrontDoorCertificateSource

Определяет источник SSL-сертификата.

FrontDoorCertificateType

Определяет тип сертификата, используемого для безопасных подключений к интерфейснойendPoint.

FrontDoorEnabledState

Рабочее состояние подсистемы балансировки нагрузки Front Door. Допустимые значения: Enabled или Disabled

FrontDoorForwardingProtocol

Это правило будет использоваться при переадресации трафика на внутренние серверы.

FrontDoorHealthProbeMethod

Настраивает метод HTTP, используемый для проверки внутренних серверных компонентов, определенных в backendPools.

FrontDoorProtocol

Схема протокола, используемая для этой пробы

FrontDoorQuery

Обработка терминов запроса URL-адреса при формировании ключа кэша.

FrontDoorRedirectProtocol

Протокол назначения, в который перенаправляется трафик.

FrontDoorRedirectType

Тип перенаправления, который будет использоваться правилом при перенаправлении трафика.

FrontDoorResourceState

Состояние ресурса Front Door или Front Door SubResource.

FrontDoorTlsProtocolType

Определяет протокол расширения TLS, используемый для безопасной доставки.

FrontendEndpoint

Интерфейсная конечная точка, используемая для маршрутизации.

HealthProbeEnabled

Следует ли включать пробы работоспособности для внутренних серверных служб, определенных в backendPools. Пробы работоспособности могут быть отключены только в том случае, если в одном серверном пуле включена одна включенная серверная часть.

HealthProbeSettingsModel

Параметры балансировки нагрузки для внутреннего пула

LoadBalancingSettingsModel

Параметры балансировки нагрузки для внутреннего пула

MinimumTLSVersion

Минимальная версия TLS, необходимая клиентам для установки подтверждения SSL с Front Door.

RedirectConfiguration

Описывает маршрут перенаправления.

RoutingRule

Правило маршрутизации представляет спецификацию трафика для обработки и отправки, а также сведения о пробе работоспособности.

routingRuleEnabledState

Позволяет включить это правило. Допустимые значения: Enabled или Disabled

SessionAffinityEnabledState

Позволяет разрешить или запретить использование сходства сеансов на этом узле. Допустимые параметры: "Включено" или "Отключено"

SubResource

Ссылка на другой подресурс.

Vault

Хранилище Key Vault, содержащее SSL-сертификат.

WebApplicationFirewallPolicyLink

Определяет политику Брандмауэр веб-приложений для каждого узла (если применимо)

Backend

Внутренний адрес подсистемы балансировки нагрузки frontDoor.

Name Type Description
address
  • string

Расположение внутреннего сервера (IP-адрес или полное доменное имя).

backendHostHeader
  • string

Значение заголовка узла, отправляемого на внутренний сервер. Если пустое или не указано, по умолчанию используется входящий узел.

enabledState

Позволяет разрешить или запретить использование этого внутреннего сервера. Допустимые значения: Enabled или Disabled

httpPort
  • integer

Номер TCP-порта HTTP. Значение должно находиться в диапазоне от 1 до 65535.

httpsPort
  • integer

Номер TCP-порта HTTPS. Значение должно находиться в диапазоне от 1 до 65535.

priority
  • integer

Приоритет для балансировки нагрузки. Более высокие приоритеты не будут использоваться для балансировки нагрузки, если какая-либо серверная часть с более низким приоритетом работоспособна.

weight
  • integer

Вес этой конечной точки для балансировки нагрузки.

backendEnabledState

Позволяет разрешить или запретить использование этого внутреннего сервера. Допустимые значения: Enabled или Disabled

Name Type Description
Disabled
  • string
Enabled
  • string

BackendPool

Внутренний пул — это коллекция внутренних серверов, в которую можно направляться.

Name Type Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.backends

Набор внутренних серверов для этого пула

properties.healthProbeSettings

Параметры пробы работоспособности L7 для внутреннего пула

properties.loadBalancingSettings

Параметры балансировки нагрузки для внутреннего пула

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса.

type
  • string

Тип ресурса.

BackendPoolsSettings

Параметры, которые применяются ко всем серверным пулам.

Name Type Default Value Description
enforceCertificateNameCheck Enabled

Указывает, следует ли принудительно проверять имя сертификата для HTTPS-запросов ко всем внутренним пулам. Не влияет на запросы, отличные от HTTPS.

sendRecvTimeoutSeconds
  • integer

Время ожидания отправки и получения при переадресации запроса на серверную часть. При достижении времени ожидания запрос завершается ошибкой и возвращается.

CacheConfiguration

Параметры кэширования для маршрута типа кэширования. Чтобы отключить кэширование, не предоставляйте объект cacheConfiguration.

Name Type Description
dynamicCompression

Следует ли использовать динамическое сжатие для кэшированного содержимого

queryParameterStripDirective

Обработка терминов запроса URL-адреса при формировании ключа кэша.

CustomHttpsConfiguration

Параметры https для домена

Name Type Description
certificateSource

Определяет источник SSL-сертификата.

frontDoorCertificateSourceParameters.certificateType

Определяет тип сертификата, используемого для безопасных подключений к интерфейснойendPoint.

keyVaultCertificateSourceParameters.secretName
  • string

Имя секрета Key Vault, представляющего полный PFX-файл сертификата.

keyVaultCertificateSourceParameters.secretVersion
  • string

Версия секрета Key Vault, представляющего полный PFX-файл сертификата.

keyVaultCertificateSourceParameters.vault

Хранилище Key Vault, содержащее SSL-сертификат.

minimumTlsVersion

Минимальная версия TLS, необходимая клиентам для установки подтверждения SSL с Front Door.

protocolType

Определяет протокол расширения TLS, используемый для безопасной доставки.

CustomHttpsProvisioningState

Состояние подготовки пользовательских https внешнего интерфейса.

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

CustomHttpsProvisioningSubstate

Подсостояние подготовки показывает ход выполнения настраиваемого процесса включения и отключения HTTPS по шагам.

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

DynamicCompressionEnabled

Следует ли использовать динамическое сжатие для кэшированного содержимого

Name Type Description
Disabled
  • string
Enabled
  • string

enforceCertificateNameCheckEnabledState

Указывает, следует ли принудительно проверять имя сертификата для HTTPS-запросов ко всем внутренним пулам. Не влияет на запросы, отличные от HTTPS.

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorResponse

Ответ об ошибке указывает, что служба Front Door не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ForwardingConfiguration

Описывает маршрут пересылки.

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

Ссылка на backendPool, к которой направляется это правило.

cacheConfiguration

Конфигурация кэширования, связанная с этим правилом.

customForwardingPath
  • string

Пользовательский путь, используемый для перезаписи путей ресурсов, соответствующих этому правилу. Оставьте пустым, чтобы использовать входящий путь.

forwardingProtocol

Это правило будет использоваться при переадресации трафика на внутренние серверы.

FrontDoor

Front Door представляет коллекцию внутренних конечных точек для маршрутизации трафика вместе с правилами, определяющими способ отправки трафика.

Name Type Description
id
  • string

Идентификатор ресурса.

location
  • string

Расположение ресурса.

name
  • string

Имя ресурса.

properties.backendPools

Внутренние пулы, доступные для правил маршрутизации.

properties.backendPoolsSettings

Параметры для всех серверных пулов

properties.cname
  • string

Узел, к которому должна принадлежать каждая интерфейснаяendPoint, должна быть CNAME.

properties.enabledState

Рабочее состояние подсистемы балансировки нагрузки Front Door. Допустимые значения: Enabled или Disabled

properties.friendlyName
  • string

Понятное имя для frontDoor

properties.frontendEndpoints

Интерфейсные конечные точки, доступные для правил маршрутизации.

properties.healthProbeSettings

Параметры пробы работоспособности, связанные с этим экземпляром Front Door.

properties.loadBalancingSettings

Параметры балансировки нагрузки, связанные с этим экземпляром Front Door.

properties.provisioningState
  • string

Состояние подготовки Front Door.

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса Front Door.

properties.routingRules

Правила маршрутизации, связанные с этой службой Front Door.

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса.

FrontDoorCertificateSource

Определяет источник SSL-сертификата.

Name Type Description
AzureKeyVault
  • string
FrontDoor
  • string

FrontDoorCertificateType

Определяет тип сертификата, используемого для безопасных подключений к интерфейснойendPoint.

Name Type Description
Dedicated
  • string

FrontDoorEnabledState

Рабочее состояние подсистемы балансировки нагрузки Front Door. Допустимые значения: Enabled или Disabled

Name Type Description
Disabled
  • string
Enabled
  • string

FrontDoorForwardingProtocol

Это правило будет использоваться при переадресации трафика на внутренние серверы.

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

FrontDoorHealthProbeMethod

Настраивает метод HTTP, используемый для проверки внутренних серверных компонентов, определенных в backendPools.

Name Type Description
GET
  • string
HEAD
  • string

FrontDoorProtocol

Схема протокола, используемая для этой пробы

Name Type Description
Http
  • string
Https
  • string

FrontDoorQuery

Обработка терминов запроса URL-адреса при формировании ключа кэша.

Name Type Description
StripAll
  • string
StripNone
  • string

FrontDoorRedirectProtocol

Протокол назначения, в который перенаправляется трафик.

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

FrontDoorRedirectType

Тип перенаправления, который будет использоваться правилом при перенаправлении трафика.

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

FrontDoorResourceState

Состояние ресурса Front Door или Front Door SubResource.

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

FrontDoorTlsProtocolType

Определяет протокол расширения TLS, используемый для безопасной доставки.

Name Type Description
ServerNameIndication
  • string

FrontendEndpoint

Интерфейсная конечная точка, используемая для маршрутизации.

Name Type Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.customHttpsConfiguration

Конфигурация, указывающая, как включить HTTPS

properties.customHttpsProvisioningState

Состояние подготовки пользовательских https внешнего интерфейса.

properties.customHttpsProvisioningSubstate

Подсостояние подготовки показывает ход выполнения настраиваемого процесса включения и отключения HTTPS по шагам.

properties.hostName
  • string

Имя узла frontendEndpoint. Это должно быть доменное имя.

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса.

properties.sessionAffinityEnabledState

Позволяет разрешить или запретить использование сходства сеансов на этом узле. Допустимые параметры: "Включено" или "Отключено"

properties.sessionAffinityTtlSeconds
  • integer

НЕИСПОЛЬЗУЕМЫЕ. Это поле будет пропущено. Срок жизни в секундах для использования сходства сеансов (если применимо).

properties.webApplicationFirewallPolicyLink

Определяет политику Брандмауэр веб-приложений для каждого узла (если применимо)

type
  • string

Тип ресурса.

HealthProbeEnabled

Следует ли включать пробы работоспособности для внутренних серверных служб, определенных в backendPools. Пробы работоспособности могут быть отключены только в том случае, если в одном серверном пуле включена одна включенная серверная часть.

Name Type Description
Disabled
  • string
Enabled
  • string

HealthProbeSettingsModel

Параметры балансировки нагрузки для внутреннего пула

Name Type Default Value Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.enabledState

Следует ли включать пробы работоспособности для внутренних серверных служб, определенных в backendPools. Пробы работоспособности могут быть отключены только в том случае, если в одном серверном пуле включена одна включенная серверная часть.

properties.healthProbeMethod HEAD

Настраивает метод HTTP, используемый для проверки внутренних серверных компонентов, определенных в backendPools.

properties.intervalInSeconds
  • integer

Число секунд между выполнением проб работоспособности.

properties.path
  • string

Путь для пробы работоспособности. По умолчанию используется значение "/".

properties.protocol

Схема протокола, используемая для этой пробы

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса.

type
  • string

Тип ресурса.

LoadBalancingSettingsModel

Параметры балансировки нагрузки для внутреннего пула

Name Type Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.additionalLatencyMilliseconds
  • integer

Дополнительная задержка в миллисекундах для проб, которые попадают в контейнер с наименьшей задержкой.

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса.

properties.sampleSize
  • integer

Количество выборок, которые следует учитывать при принятии решений по балансировке нагрузки.

properties.successfulSamplesRequired
  • integer

Число выборок в течение периода выборки, который должен быть успешным.

type
  • string

Тип ресурса.

MinimumTLSVersion

Минимальная версия TLS, необходимая клиентам для установки подтверждения SSL с Front Door.

Name Type Description
1.0
  • string
1.2
  • string

RedirectConfiguration

Описывает маршрут перенаправления.

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

Фрагмент для добавления в URL-адрес перенаправления. Фрагмент является частью URL-адреса, который приходит после #. Не включайте #.

customHost
  • string

Узел для перенаправления. Оставьте пустым, чтобы использовать входящий узел в качестве конечного узла.

customPath
  • string

Полный путь для перенаправления. Путь не может быть пустым и должен начинаться с /. Оставьте пустым, чтобы использовать входящий путь в качестве пути назначения.

customQueryString
  • string

Набор строк запроса, помещаемых в URL-адрес перенаправления. Установка этого значения заменит любую существующую строку запроса; оставьте пустым, чтобы сохранить входящую строку запроса. Строка запроса должна быть в формате = . Первый ? и & будет добавлен автоматически, поэтому не включайте их в передний план, но разделяйте несколько строк запроса с &.

redirectProtocol

Протокол назначения, в который перенаправляется трафик.

redirectType

Тип перенаправления, который будет использоваться правилом при перенаправлении трафика.

RoutingRule

Правило маршрутизации представляет спецификацию трафика для обработки и отправки, а также сведения о пробе работоспособности.

Name Type Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.acceptedProtocols
  • string[]

Схемы протокола, соответствующие этому правилу

properties.enabledState

Позволяет включить это правило. Допустимые значения: Enabled или Disabled

properties.frontendEndpoints

Интерфейсные конечные точки, связанные с этим правилом

properties.patternsToMatch
  • string[]

Шаблоны маршрутов правила.

properties.resourceState

Состояние ресурса Front Door или Front Door SubResource.
Состояние ресурса.

properties.routeConfiguration RouteConfiguration:

Ссылка на конфигурацию маршрутизации.

type
  • string

Тип ресурса.

routingRuleEnabledState

Позволяет включить это правило. Допустимые значения: Enabled или Disabled

Name Type Description
Disabled
  • string
Enabled
  • string

SessionAffinityEnabledState

Позволяет разрешить или запретить использование сходства сеансов на этом узле. Допустимые параметры: "Включено" или "Отключено"

Name Type Description
Disabled
  • string
Enabled
  • string

SubResource

Ссылка на другой подресурс.

Name Type Description
id
  • string

Идентификатор ресурса.

Vault

Хранилище Key Vault, содержащее SSL-сертификат.

Name Type Description
id
  • string

Идентификатор ресурса.

Определяет политику Брандмауэр веб-приложений для каждого узла (если применимо)

Name Type Description
id
  • string

Идентификатор ресурса.