Routes - Get

Служба:: Front Door Service

Версия API:: 2025-04-15

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpointName	path	True	string	Имя конечной точки в профиле, уникальное глобально.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Имя Azure Front Door Standard или Azure Front Door Premium, уникальное в группе ресурсов.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
routeName	path	True	string	Имя правила маршрутизации.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	Route	ХОРОШО
Other Status Codes	ErrorResponse	Ответ об ошибке Azure Front Door, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Routes_Get

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2025-04-15

Пример ответа

Код состояния:: 200

{
  "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	Ссылка на другой ресурс вместе с его состоянием.
AFDEndpointProtocols	Поддерживаемые протоколы для конечной точки клиента.
AfdProvisioningState	Состояние обеспечения
afdQueryStringCachingBehavior	Определяет способ кэширования запросов Frontdoor, включающих строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.
AfdRouteCacheConfiguration	Параметры кэширования для маршрута типа кэширования. Чтобы отключить кэширование, не укажите объект cacheConfiguration.
CompressionSettings	параметры сжатия.
createdByType	Тип удостоверения, создавшего ресурс.
DeploymentStatus
EnabledState	Следует ли включить использование этого правила. Допустимые значения: "Включено" или "Отключено"
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ForwardingProtocol	Протокол, используемый этим правилом при переадресации трафика в серверные части.
httpsRedirect	Следует ли автоматически перенаправлять HTTP-трафик в трафик HTTPS. Обратите внимание, что это простой способ настройки этого правила, и это будет первое правило, которое выполняется.
LinkToDefaultDomain	Будет ли этот маршрут связан с доменом конечной точки по умолчанию.
ResourceReference	Ссылка на другой ресурс.
Route	Сопоставление имен "Понятные маршруты" с любыми сведениями о маршрутах или секретах.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

ActivatedResourceReference

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
isActive	boolean	Является ли ресурс активным или неактивным

AFDEndpointProtocols

Перечисление

Поддерживаемые протоколы для конечной точки клиента.

Значение	Описание
Http
Https

AfdProvisioningState

Перечисление

Состояние обеспечения

Значение	Описание
Succeeded
Failed
Updating
Deleting
Creating

afdQueryStringCachingBehavior

Перечисление

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

Значение	Описание
IgnoreQueryString
UseQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings

AfdRouteCacheConfiguration

Object

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

Имя	Тип	Описание
compressionSettings	CompressionSettings	параметры сжатия.
queryParameters	string	параметры запроса для включения или исключения (разделенные запятыми).
queryStringCachingBehavior	afdQueryStringCachingBehavior	Определяет способ кэширования запросов Frontdoor, включающих строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.

CompressionSettings

Object

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

Имя	Тип	Описание
contentTypesToCompress	string[]	Список типов контента, к которым применяется сжатие. Значение должно быть допустимым типом MIME.
isCompressionEnabled	boolean	Указывает, включена ли сжатие содержимого в AzureFrontDoor. По умолчанию используется значение false. Если сжатие включено, содержимое будет использоваться в виде сжатия, если запросы пользователей к сжатой версии. Содержимое не сжимается в AzureFrontDoor, если запрошенное содержимое меньше 1 байта или больше 1 МБ.

createdByType

Перечисление

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

Значение	Описание
User
Application
ManagedIdentity
Key

DeploymentStatus

Перечисление

Значение	Описание
NotStarted
InProgress
Succeeded
Failed

EnabledState

Перечисление

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

Значение	Описание
Enabled
Disabled

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ForwardingProtocol

Перечисление

Протокол, используемый этим правилом при переадресации трафика в серверные части.

Значение	Описание
HttpOnly
HttpsOnly
MatchRequest

httpsRedirect

Перечисление

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

Значение	Описание
Enabled
Disabled

LinkToDefaultDomain

Перечисление

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

Значение	Описание
Enabled
Disabled

ResourceReference

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.

Route

Object

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

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Имя ресурса
properties.cacheConfiguration	AfdRouteCacheConfiguration		Конфигурация кэширования для этого маршрута. Чтобы отключить кэширование, не укажите объект cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Домены, на которые ссылается эта конечная точка.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Следует ли включить использование этого правила. Допустимые значения: "Включено" или "Отключено"
properties.endpointName	string		Имя конечной точки, содержащей маршрут.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Протокол, используемый этим правилом при переадресации трафика в серверные части.
properties.httpsRedirect	httpsRedirect	Disabled	Следует ли автоматически перенаправлять HTTP-трафик в трафик HTTPS. Обратите внимание, что это простой способ настройки этого правила, и это будет первое правило, которое выполняется.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	Будет ли этот маршрут связан с доменом конечной точки по умолчанию.
properties.originGroup	ResourceReference		Ссылка на группу источников.
properties.originPath	string		Путь к каталогу в источнике, который AzureFrontDoor может использовать для получения содержимого, например contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Шаблоны маршрутов правила.
properties.provisioningState	AfdProvisioningState		Состояние обеспечения
properties.ruleSets	ResourceReference[]		наборы правил, на которые ссылается эта конечная точка.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Список поддерживаемых протоколов для этого маршрута.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Routes - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

Routes_Get

Образец запроса

Пример ответа

Определения

ActivatedResourceReference

AFDEndpointProtocols

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

httpsRedirect

LinkToDefaultDomain

ResourceReference

Route

systemData