Routes - Get

Возвращает существующий маршрут с указанным именем маршрута в указанной подписке, группе ресурсов, профиле и конечной точке AzureFrontDoor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}?api-version=2021-06-01

Параметры URI

Name In Required Type Description
endpointName
path True
  • string

Имя конечной точки в профиле, уникальное глобально.

profileName
path True
  • string

Имя профиля Azure Front Door уровня "Стандартный" или Azure Front Door Premium, уникальное в группе ресурсов.

resourceGroupName
path True
  • string

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

Regex pattern: ^[-\w\._\(\)]+$

routeName
path True
  • string

Имя правила маршрутизации.

subscriptionId
path True
  • string

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

api-version
query True
  • string

Версия API, используемая с клиентским запросом. Текущая версия — 2021-06-01.

Ответы

Name Type Description
200 OK

ОК

Other Status Codes

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

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

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 олицетворения учетной записи пользователя

Примеры

Routes_Get

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2021-06-01

Sample Response

{
  "name": "route1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1",
  "type": "Microsoft.Cdn/profiles/afdendpoints/routes",
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "cacheConfiguration": {
      "compressionSettings": {
        "contentTypesToCompress": [
          "text/html",
          "application/octet-stream"
        ],
        "isCompressionEnabled": true
      },
      "queryStringCachingBehavior": "IgnoreQueryString",
      "queryParameters": null
    },
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Определения

ActivatedResourceReference

Ссылка на другой ресурс вместе с его состоянием.

AfdErrorResponse

Сообщение об ошибке

AfdProvisioningState

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

afdQueryStringCachingBehavior

Определяет, как Frontdoor кэширует запросы, включающие строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.

AfdRouteCacheConfiguration

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

CompressionSettings

параметры сжатия.

DeploymentStatus
EnabledState

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

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ForwardingProtocol

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

httpsRedirect

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

IdentityType

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

LinkToDefaultDomain

Будет ли этот маршрут связан с доменом конечной точки по умолчанию.

ResourceReference

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

Route

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

SystemData

Чтение только системных данных

ActivatedResourceReference

Ссылка на другой ресурс вместе с его состоянием.

Name Type Description
id
  • string

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

isActive
  • boolean

Является ли ресурс активным или неактивным

AfdErrorResponse

Сообщение об ошибке

Name Type Description
error

Объект ошибки.

AfdProvisioningState

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

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

afdQueryStringCachingBehavior

Определяет, как Frontdoor кэширует запросы, включающие строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.

Name Type Description
IgnoreQueryString
  • string
IgnoreSpecifiedQueryStrings
  • string
IncludeSpecifiedQueryStrings
  • string
UseQueryString
  • string

AfdRouteCacheConfiguration

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

Name Type Description
compressionSettings

параметры сжатия.

queryParameters
  • string

параметры запроса для включения или исключения (разделенные запятыми).

queryStringCachingBehavior

Определяет, как Frontdoor кэширует запросы, включающие строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.

CompressionSettings

параметры сжатия.

Name Type Description
contentTypesToCompress
  • string[]

Список типов контента, к которым применяется сжатие. Значение должно быть допустимым типом MIME.

isCompressionEnabled
  • boolean

Указывает, включено ли сжатие содержимого в AzureFrontDoor. Значение по умолчанию — false. Если сжатие включено, содержимое будет обрабатываться как сжатое, если пользователь запрашивает сжатую версию. Содержимое не сжимается в AzureFrontDoor, если запрошенное содержимое меньше 1 байта или больше 1 МБ.

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

EnabledState

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

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name Type Description
info
  • object

Дополнительные сведения.

type
  • string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.

code
  • string

Код ошибки.

details

Сведения об ошибке.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект ошибки.

ForwardingProtocol

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

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

httpsRedirect

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

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

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

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

LinkToDefaultDomain

Будет ли этот маршрут связан с доменом конечной точки по умолчанию.

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

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

Name Type Description
id
  • string

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

Route

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

Name Type Description
id
  • string

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

name
  • string

Имя ресурса.

properties.cacheConfiguration

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

properties.customDomains

Домены, на которые ссылается эта конечная точка.

properties.deploymentStatus
properties.enabledState

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

properties.endpointName
  • string

Имя конечной точки, содержащей маршрут.

properties.forwardingProtocol

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

properties.httpsRedirect

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

properties.linkToDefaultDomain

Будет ли этот маршрут связан с доменом конечной точки по умолчанию.

properties.originGroup

Ссылка на группу источников.

properties.originPath
  • string

Путь к каталогу в источнике, который AzureFrontDoor может использовать для получения содержимого, например contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

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

properties.provisioningState

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

properties.ruleSets

наборы правил, на которые ссылается эта конечная точка.

properties.supportedProtocols
  • string[]

Список поддерживаемых протоколов для этого маршрута.

systemData

Чтение только системных данных

type
  • string

Тип ресурса.

SystemData

Чтение только системных данных

Name Type Description
createdAt
  • string

Метка времени создания ресурса (UTC)

createdBy
  • string

Идентификатор удостоверения, создавшего ресурс.

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt
  • string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy
  • string

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

lastModifiedByType

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