Routes - Get

Ссылка

Service:: Front Door Service

API Version:: 2023-05-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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 для использования с клиентским запросом. Текущая версия — 01.05.2023.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
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=2023-05-01


/** Samples for Routes Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
     */
    /**
     * Sample code: Routes_Get.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routesGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getRoutes().getWithResponse("RG", "profile1", "endpoint1",
            "route1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python routes_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.routes.get(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        route_name="route1",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
func ExampleRoutesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRoutesClient().Get(ctx, "RG", "profile1", "endpoint1", "route1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Route = armcdn.Route{
	// 	Name: to.Ptr("route1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/afdendpoints/routes"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1"),
	// 	Properties: &armcdn.RouteProperties{
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 		CacheConfiguration: &armcdn.AfdRouteCacheConfiguration{
	// 			CompressionSettings: &armcdn.CompressionSettings{
	// 				ContentTypesToCompress: []*string{
	// 					to.Ptr("text/html"),
	// 					to.Ptr("application/octet-stream")},
	// 					IsCompressionEnabled: to.Ptr(true),
	// 				},
	// 				QueryStringCachingBehavior: to.Ptr(armcdn.AfdQueryStringCachingBehaviorIgnoreQueryString),
	// 			},
	// 			CustomDomains: []*armcdn.ActivatedResourceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"),
	// 			}},
	// 			EnabledState: to.Ptr(armcdn.EnabledStateEnabled),
	// 			ForwardingProtocol: to.Ptr(armcdn.ForwardingProtocolMatchRequest),
	// 			HTTPSRedirect: to.Ptr(armcdn.HTTPSRedirectEnabled),
	// 			LinkToDefaultDomain: to.Ptr(armcdn.LinkToDefaultDomainEnabled),
	// 			OriginGroup: &armcdn.ResourceReference{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"),
	// 			},
	// 			PatternsToMatch: []*string{
	// 				to.Ptr("/*")},
	// 				RuleSets: []*armcdn.ResourceReference{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"),
	// 				}},
	// 				SupportedProtocols: []*armcdn.AFDEndpointProtocols{
	// 					to.Ptr(armcdn.AFDEndpointProtocolsHTTPS),
	// 					to.Ptr(armcdn.AFDEndpointProtocolsHTTP)},
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
 *
 * @summary Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
 */
async function routesGet() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const routeName = "route1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.routes.get(resourceGroupName, profileName, endpointName, routeName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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	Поддерживаемые протоколы для конечной точки клиента.
AfdErrorResponse	Сообщение об ошибке
AfdProvisioningState	Состояние подготовки
afdQueryStringCachingBehavior	Определяет, как Frontdoor кэширует запросы, включающие строки запроса. При кэшировании можно игнорировать любые строки запроса, игнорировать определенные строки запроса, кэшировать каждый запрос с уникальным URL-адресом или кэшировать определенные строки запроса.
AfdRouteCacheConfiguration	Параметры кэширования для маршрута типа кэширования. Чтобы отключить кэширование, не предоставляйте объект cacheConfiguration.
CompressionSettings	параметры сжатия.
DeploymentStatus
EnabledState	Позволяет включить это правило. Допустимые значения: Enabled или Disabled.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ForwardingProtocol	Протокол, который будет использоваться этим правилом при переадресации трафика на серверные серверы.
httpsRedirect	Указывает, следует ли автоматически перенаправлять трафик HTTP в трафик HTTPS. Обратите внимание, что это простой способ настроить это правило, и это будет первое правило, которое будет выполнено.
IdentityType	Тип удостоверения, создающего или изменяющего ресурсы
LinkToDefaultDomain	будет ли этот маршрут связан с доменом конечной точки по умолчанию.
ResourceReference	Ссылка на другой ресурс.
Route	Понятное сопоставление имен маршрутов со сведениями, связанными с маршрутами или секретами.
SystemData	Чтение только системных данных

ActivatedResourceReference

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

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

AFDEndpointProtocols

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

Имя	Тип	Описание
Http	string
Https	string

AfdErrorResponse

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

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

AfdProvisioningState

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

Имя	Тип	Описание
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

afdQueryStringCachingBehavior

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

Имя	Тип	Описание
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

AfdRouteCacheConfiguration

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

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

CompressionSettings

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

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

DeploymentStatus

Имя	Тип	Описание
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

EnabledState

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

Имя	Тип	Описание
Disabled	string
Enabled	string

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ForwardingProtocol

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

Имя	Тип	Описание
HttpOnly	string
HttpsOnly	string
MatchRequest	string

httpsRedirect

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

Имя	Тип	Описание
Disabled	string
Enabled	string

IdentityType

Тип удостоверения, создающего или изменяющего ресурсы

Имя	Тип	Описание
application	string
key	string
managedIdentity	string
user	string

LinkToDefaultDomain

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

Имя	Тип	Описание
Disabled	string
Enabled	string

ResourceReference

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

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

Route

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

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса.
name	string		Имя ресурса.
properties.cacheConfiguration	AfdRouteCacheConfiguration		Конфигурация кэширования для этого маршрута. Чтобы отключить кэширование, не предоставляйте объект cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Домены, на которые ссылается эта конечная точка.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Позволяет включить это правило. Допустимые значения: Enabled или Disabled.
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		Чтение только системных данных
type	string		Тип ресурса.

SystemData

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

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

Routes - Get

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

Routes_Get

Sample Request

Sample Response

Определения

ActivatedResourceReference

AFDEndpointProtocols

AfdErrorResponse

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ForwardingProtocol

httpsRedirect

IdentityType

LinkToDefaultDomain

ResourceReference

Route

SystemData

Дополнительные ресурсы