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)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Route	[OK]
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Azure Front Door エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Routes_Get

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/Routes_Get.json
// this example is just showing the usage of "FrontDoorRoutes_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FrontDoorEndpointResource created on azure
// for more information of creating FrontDoorEndpointResource, please refer to the document of FrontDoorEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier frontDoorEndpointResourceId = FrontDoorEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
FrontDoorEndpointResource frontDoorEndpoint = client.GetFrontDoorEndpointResource(frontDoorEndpointResourceId);

// get the collection of this FrontDoorRouteResource
FrontDoorRouteCollection collection = frontDoorEndpoint.GetFrontDoorRoutes();

// invoke the operation
string routeName = "route1";
NullableResponse<FrontDoorRouteResource> response = await collection.GetIfExistsAsync(routeName);
FrontDoorRouteResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FrontDoorRouteData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

応答のサンプル

状態コード:: 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	リソースを作成した ID の種類。
DeploymentStatus
EnabledState	この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ForwardingProtocol	この規則は、トラフィックをバックエンドに転送するときに使用するプロトコルです。
httpsRedirect	HTTP トラフィックを HTTPS トラフィックに自動的にリダイレクトするかどうかを指定します。これは、このルールを設定する簡単な方法であり、実行される最初のルールであることに注意してください。
LinkToDefaultDomain	このルートが既定のエンドポイントドメインにリンクされるかどうか。
ResourceReference	別のリソースへの参照。
Route	すべてのルートまたはシークレット関連情報へのフレンドリルート名マッピング。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ActivatedResourceReference

Object

状態と共に別のリソースへの参照。

名前	型	説明
id	string	リソース ID。
isActive	boolean	リソースがアクティブか非アクティブか

AFDEndpointProtocols

列挙

顧客のエンドポイントでサポートされているプロトコル。

値	説明
Http
Https

AfdProvisioningState

列挙

プロビジョニング状態

値	説明
Creating
Deleting
Failed
Succeeded
Updating

afdQueryStringCachingBehavior

列挙

クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。キャッシュ時、特定のクエリ文字列を無視する場合、一意の URL を使用してすべての要求をキャッシュする場合、または特定のクエリ文字列をキャッシュする場合は、クエリ文字列を無視できます。

値	説明
IgnoreQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings
UseQueryString

AfdRouteCacheConfiguration

Object

キャッシュの種類のルートのキャッシュ設定。キャッシュを無効にするには、cacheConfiguration オブジェクトを指定しないでください。

名前	型	説明
compressionSettings	CompressionSettings	圧縮設定。
queryParameters	string	含めるか除外するクエリパラメーター (コンマ区切り)。
queryStringCachingBehavior	afdQueryStringCachingBehavior	クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。キャッシュ時、特定のクエリ文字列を無視する場合、一意の URL を使用してすべての要求をキャッシュする場合、または特定のクエリ文字列をキャッシュする場合は、クエリ文字列を無視できます。

CompressionSettings

Object

圧縮の設定。

名前	型	説明
contentTypesToCompress	string[]	圧縮が適用されるコンテンツタイプの一覧。値は有効な MIME の種類である必要があります。
isCompressionEnabled	boolean	AzureFrontDoor でコンテンツ圧縮が有効かどうかを示します。既定値は false です。圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。要求されたコンテンツが 1 バイト未満または 1 MB より大きい場合、AzureFrontDoor ではコンテンツは圧縮されません。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DeploymentStatus

列挙

値	説明
Failed
InProgress
NotStarted
Succeeded

EnabledState

列挙

この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です

値	説明
Disabled
Enabled

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 トラフィックに自動的にリダイレクトするかどうかを指定します。これは、このルールを設定する簡単な方法であり、実行される最初のルールであることに注意してください。

値	説明
Disabled
Enabled

LinkToDefaultDomain

列挙

このルートが既定のエンドポイントドメインにリンクされるかどうか。

値	説明
Disabled
Enabled

ResourceReference

Object

別のリソースへの参照。

名前	型	説明
id	string	リソース ID。

Route

Object

すべてのルートまたはシークレット関連情報へのフレンドリルート名マッピング。

名前	型	規定値	説明
id	string (arm-id)		リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

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