Endpoints - Start

サービス:

CDN

API バージョン:

2024-02-01

停止状態にある既存の CDN エンドポイントを開始します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start?api-version=2024-02-01

URI パラメーター

名前	/	必須	型	説明
endpointName	path	True	string	グローバルに一意であるプロファイルの下のエンドポイントの名前。
profileName	path	True	string	リソース グループ内で一意である CDN プロファイルの名前。
resourceGroupName	path	True	string	Azure サブスクリプション内のリソース グループの名前。 正規表現パターン: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure サブスクリプション ID。
api-version	query	True	string	クライアント要求で使用される API のバージョン。 現在のバージョンは 2024-02-01 です。

応答

名前	型	説明
200 OK	Endpoint	OK です。 要求は成功しました。
202 Accepted	Endpoint	受け入れられ、操作は非同期的に完了します。 ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する CDN エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Endpoints_Start

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/start?api-version=2024-02-01

Java

/**
 * Samples for Endpoints Start.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Start.json
     */
    /**
     * Sample code: Endpoints_Start.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void endpointsStart(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getEndpoints().start("RG", "profile1", "endpoint1",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python endpoints_start.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.endpoints.begin_start(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Start.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

Go

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/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Start.json
func ExampleEndpointsClient_BeginStart() {
	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)
	}
	poller, err := clientFactory.NewEndpointsClient().BeginStart(ctx, "RG", "profile1", "endpoint1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Endpoint = armcdn.Endpoint{
	// 	Name: to.Ptr("endpoint4899"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1"),
	// 	Location: to.Ptr("WestUs"),
	// 	Tags: map[string]*string{
	// 		"kay1": to.Ptr("value1"),
	// 	},
	// 	Properties: &armcdn.EndpointProperties{
	// 		ContentTypesToCompress: []*string{
	// 		},
	// 		GeoFilters: []*armcdn.GeoFilter{
	// 		},
	// 		IsCompressionEnabled: to.Ptr(false),
	// 		IsHTTPAllowed: to.Ptr(true),
	// 		IsHTTPSAllowed: to.Ptr(true),
	// 		OptimizationType: to.Ptr(armcdn.OptimizationTypeDynamicSiteAcceleration),
	// 		OriginHostHeader: to.Ptr("www.bing.com"),
	// 		ProbePath: to.Ptr("/image"),
	// 		QueryStringCachingBehavior: to.Ptr(armcdn.QueryStringCachingBehaviorNotSet),
	// 		HostName: to.Ptr("endpoint1.azureedge.net"),
	// 		Origins: []*armcdn.DeepCreatedOrigin{
	// 			{
	// 				Name: to.Ptr("www-bing-com"),
	// 				Properties: &armcdn.DeepCreatedOriginProperties{
	// 					HostName: to.Ptr("www.bing.com"),
	// 					HTTPPort: to.Ptr[int32](80),
	// 					HTTPSPort: to.Ptr[int32](443),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armcdn.EndpointProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.EndpointResourceStateStarting),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Starts an existing CDN endpoint that is on a stopped state.
 *
 * @summary Starts an existing CDN endpoint that is on a stopped state.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Start.json
 */
async function endpointsStart() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.endpoints.beginStartAndWait(
    resourceGroupName,
    profileName,
    endpointName,
  );
  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

dotnet

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.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Start.json
// this example is just showing the usage of "CdnEndpoints_Start" 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 CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// invoke the operation
ArmOperation<CdnEndpointResource> lro = await cdnEndpoint.StartAsync(WaitUntil.Completed);
CdnEndpointResource result = lro.Value;

// 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
CdnEndpointData 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": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Succeeded",
    "resourceState": "Starting",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "NotSet",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443
        }
      }
    ],
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": "DynamicSiteAcceleration",
    "probePath": "/image",
    "geoFilters": []
  }
}

状態コード:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Succeeded",
    "resourceState": "Starting",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "NotSet",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443
        }
      }
    ],
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": "DynamicSiteAcceleration",
    "probePath": "/image",
    "geoFilters": []
  }
}

定義

名前	説明
algorithm	URL 署名に使用するアルゴリズム
cacheBehavior	要求のキャッシュ動作
CacheConfiguration	キャッシュの種類のルートのキャッシュ設定。 キャッシュを無効にするには、cacheConfiguration オブジェクトを指定しないでください。
CacheExpirationActionParameters	キャッシュの有効期限アクションのパラメーターを定義します。
CacheKeyQueryStringActionParameters	キャッシュ キー クエリ文字列アクションのパラメーターを定義します。
CacheType	コンテンツをキャッシュする必要があるレベル。
ClientPortMatchConditionParameters	ClientPort の一致条件のパラメーターを定義します
ClientPortOperator	一致する演算子について説明します
CookiesMatchConditionParameters	Cookie の一致条件のパラメーターを定義します
CookiesOperator	一致する演算子について説明します
DeepCreatedCustomDomain	CDN エンドポイントで作成されたカスタム ドメイン。
DeepCreatedOrigin	CDN エンドポイントの作成時に追加される CDN コンテンツのメイン配信元。
DeepCreatedOriginGroup	CDN エンドポイントの作成時に追加される CDN コンテンツの配信元グループ。 トラフィックは、配信元の正常性に基づいて配信元グループ内の配信元に送信されます。
DeliveryPolicy	エンドポイントに使用する配信ルールを指定するポリシー。
DeliveryRule	一連のアクションと条件を指定するルール
DeliveryRuleCacheExpirationAction	配信ルールのキャッシュ有効期限アクションを定義します。
DeliveryRuleCacheKeyQueryStringAction	配信ルールのキャッシュ キー クエリ文字列アクションを定義します。
DeliveryRuleClientPortCondition	配信ルールの ClientPort 条件を定義します。
DeliveryRuleCookiesCondition	配信ルールの Cookie 条件を定義します。
DeliveryRuleHostNameCondition	配信ルールの HostName 条件を定義します。
DeliveryRuleHttpVersionCondition	配信ルールの HttpVersion 条件を定義します。
DeliveryRuleIsDeviceCondition	配信ルールの IsDevice 条件を定義します。
DeliveryRulePostArgsCondition	配信ルールの PostArgs 条件を定義します。
DeliveryRuleQueryStringCondition	配信ルールの QueryString 条件を定義します。
DeliveryRuleRemoteAddressCondition	配信ルールの RemoteAddress 条件を定義します。
DeliveryRuleRequestBodyCondition	配信ルールの RequestBody 条件を定義します。
DeliveryRuleRequestHeaderAction	配信ルールの要求ヘッダー アクションを定義します。
DeliveryRuleRequestHeaderCondition	配信ルールの RequestHeader 条件を定義します。
DeliveryRuleRequestMethodCondition	配信ルールの RequestMethod 条件を定義します。
DeliveryRuleRequestSchemeCondition	配信ルールの RequestScheme 条件を定義します。
DeliveryRuleRequestUriCondition	配信ルールの RequestUri 条件を定義します。
DeliveryRuleResponseHeaderAction	配信ルールの応答ヘッダー アクションを定義します。
DeliveryRuleRouteConfigurationOverrideAction	配信ルールのルート構成オーバーライド アクションを定義します。 Frontdoor Standard/Premium プロファイルにのみ適用されます。
DeliveryRuleServerPortCondition	配信ルールの ServerPort 条件を定義します。
DeliveryRuleSocketAddrCondition	配信ルールの SocketAddress 条件を定義します。
DeliveryRuleSslProtocolCondition	配信ルールの SslProtocol 条件を定義します。
DeliveryRuleUrlFileExtensionCondition	配信ルールの UrlFileExtension 条件を定義します。
DeliveryRuleUrlFileNameCondition	配信ルールの UrlFileName 条件を定義します。
DeliveryRuleUrlPathCondition	配信ルールの UrlPath 条件を定義します。
DestinationProtocol	リダイレクトに使用するプロトコル。 既定値は MatchRequest です
Endpoint	CDN エンドポイントは、配信元、プロトコル、コンテンツ キャッシュ、配信動作などの構成情報を含む CDN プロファイル内のエンティティです。 CDN エンドポイントでは、URL 形式の .azureedge.net が使用されます。
EndpointProvisioningState	エンドポイントのプロビジョニング状態。
EndpointResourceState	エンドポイントのリソースの状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ForwardingProtocol	バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。
GeoFilter	CDN エンドポイント内でのユーザーの geo アクセスを定義するルール。
GeoFilterActions	geo フィルターのアクション。つまり、アクセスを許可またはブロックします。
HeaderAction	実行するアクション
HeaderActionParameters	要求ヘッダー アクションのパラメーターを定義します。
HealthProbeParameters	正常性プローブを配信元に送信するプロパティを含む JSON オブジェクト。
HealthProbeRequestType	行われた正常性プローブの要求の種類。
HostNameMatchConditionParameters	HostName の一致条件のパラメーターを定義します
HostNameOperator	一致する演算子について説明します
HttpErrorRangeParameters	http 状態コードの範囲を表す JSON オブジェクト
HttpVersionMatchConditionParameters	HttpVersion の一致条件のパラメーターを定義します
HttpVersionOperator	一致する演算子について説明します
IdentityType	リソースを作成または変更する ID の種類
IsDeviceMatchConditionParameters	IsDevice の一致条件のパラメーターを定義します
IsDeviceOperator	一致する演算子について説明します
KeyVaultSigningKeyParameters	URL 署名キーにユーザーの KeyVault を使用するためのパラメーターについて説明します。
MatchValues	配信ルールの条件の一致値
OptimizationType	顧客がこの CDN エンドポイントを最適化するシナリオ (ダウンロード、メディア サービスなど) を指定します。 この情報を使用すると、シナリオ駆動型の最適化を適用できます。
OriginGroupOverride	配信元グループのオーバーライド構成のパラメーターを定義します。
OriginGroupOverrideAction	配信ルールの配信元グループのオーバーライド アクションを定義します。
OriginGroupOverrideActionParameters	配信元グループのオーバーライド アクションのパラメーターを定義します。
paramIndicator	パラメーターの目的を示します
PostArgsMatchConditionParameters	PostArgs の一致条件のパラメーターを定義します
PostArgsOperator	一致する演算子について説明します
PrivateEndpointStatus	Private Linkへの接続の承認状態
ProbeProtocol	正常性プローブに使用するプロトコル。
queryStringBehavior	要求のキャッシュ動作
QueryStringCachingBehavior	クエリ文字列を含む要求を CDN がキャッシュする方法を定義します。 キャッシュ時にクエリ文字列を無視したり、キャッシュをバイパスしてクエリ文字列を含む要求がキャッシュされないようにしたり、一意の URL ですべての要求をキャッシュしたりできます。
QueryStringMatchConditionParameters	QueryString の一致条件のパラメーターを定義します
QueryStringOperator	一致する演算子について説明します
RedirectType	トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。
RemoteAddressMatchConditionParameters	RemoteAddress の一致条件のパラメーターを定義します
RemoteAddressOperator	一致する演算子について説明します
RequestBodyMatchConditionParameters	RequestBody の一致条件のパラメーターを定義します
RequestBodyOperator	一致する演算子について説明します
RequestHeaderMatchConditionParameters	RequestHeader の一致条件のパラメーターを定義します
RequestHeaderOperator	一致する演算子について説明します
RequestMethodMatchConditionParameters	RequestMethod の一致条件のパラメーターを定義します
RequestMethodOperator	一致する演算子について説明します
RequestSchemeMatchConditionParameters	RequestScheme の一致条件のパラメーターを定義します
RequestUriMatchConditionParameters	RequestUri 一致条件のパラメーターを定義します
RequestUriOperator	一致する演算子について説明します
ResourceReference	別のリソースへの参照。
ResponseBasedDetectedErrorTypes	配信元が異常と見なされる実際のユーザー要求の応答エラーの種類
ResponseBasedOriginErrorDetectionParameters	実際の要求/応答を使用して配信元の正常性を判断するためのプロパティを含む JSON オブジェクト。
RouteConfigurationOverrideActionParameters	ルート構成オーバーライド アクションのパラメーターを定義します。
ruleCacheBehavior	要求のキャッシュ動作
ruleIsCompressionEnabled	コンテンツ圧縮が有効かどうかを示します。 圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。 要求されたコンテンツが 1 バイト未満または 1 MB を超える場合、AzureFrontDoor ではコンテンツは圧縮されません。
ruleQueryStringCachingBehavior	クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。 キャッシュ時にクエリ文字列を無視したり、特定のクエリ文字列を無視したり、一意の URL ですべての要求をキャッシュしたり、特定のクエリ文字列をキャッシュしたりできます。
ServerPortMatchConditionParameters	ServerPort の一致条件のパラメーターを定義します
ServerPortOperator	一致する演算子について説明します
SocketAddrMatchConditionParameters	SocketAddress の一致条件のパラメーターを定義します
SocketAddrOperator	一致する演算子について説明します
SslProtocol	確立された TLS 接続のプロトコル。
SslProtocolMatchConditionParameters	SslProtocol 一致条件のパラメーターを定義します
SslProtocolOperator	一致する演算子について説明します
SystemData	システム データの読み取り専用
transform	一致する前に適用される変換について説明します
UrlFileExtensionMatchConditionParameters	UrlFileExtension の一致条件のパラメーターを定義します
UrlFileExtensionOperator	一致する演算子について説明します
UrlFileNameMatchConditionParameters	UrlFilename の一致条件のパラメーターを定義します
UrlFileNameOperator	一致する演算子について説明します
UrlPathMatchConditionParameters	UrlPath の一致条件のパラメーターを定義します
UrlPathOperator	一致する演算子について説明します
UrlRedirectAction	配信ルールの URL リダイレクト アクションを定義します。
UrlRedirectActionParameters	URL リダイレクト アクションのパラメーターを定義します。
UrlRewriteAction	配信ルールの URL 書き換えアクションを定義します。
UrlRewriteActionParameters	URL 書き換えアクションのパラメーターを定義します。
UrlSigningAction	配信ルールの URL 署名アクションを定義します。
UrlSigningActionParameters	URL 署名アクションのパラメーターを定義します。
UrlSigningKey	URL 署名キー
UrlSigningParamIdentifier	特定の目的でパラメーターを識別する方法 (有効期限など) を定義します
WebApplicationFirewallPolicyLink	エンドポイントのWeb Application Firewall ポリシーを定義します (該当する場合)

algorithm

URL 署名に使用するアルゴリズム

名前	型	説明
SHA256	string

cacheBehavior

要求のキャッシュ動作

名前	型	説明
BypassCache	string
Override	string
SetIfMissing	string

CacheConfiguration

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

名前	型	説明
cacheBehavior	ruleCacheBehavior	要求のキャッシュ動作
cacheDuration	string	コンテンツをキャッシュする必要がある期間。 使用できる形式は [d.]hh:mm:ss です
isCompressionEnabled	ruleIsCompressionEnabled	コンテンツ圧縮が有効かどうかを示します。 圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。 要求されたコンテンツが 1 バイト未満または 1 MB を超える場合、AzureFrontDoor ではコンテンツは圧縮されません。
queryParameters	string	を含めるか除外するクエリ パラメーター (コンマ区切り)。
queryStringCachingBehavior	ruleQueryStringCachingBehavior	クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。 キャッシュ時にクエリ文字列を無視したり、特定のクエリ文字列を無視したり、一意の URL ですべての要求をキャッシュしたり、特定のクエリ文字列をキャッシュしたりできます。

CacheExpirationActionParameters

キャッシュの有効期限アクションのパラメーターを定義します。

名前	型	説明
cacheBehavior	cacheBehavior	要求のキャッシュ動作
cacheDuration	string	コンテンツをキャッシュする必要がある期間。 使用できる形式は [d.]hh:mm:ss です
cacheType	CacheType	コンテンツをキャッシュする必要があるレベル。
typeName	enum: DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

キャッシュ キー クエリ文字列アクションのパラメーターを定義します。

名前	型	説明
queryParameters	string	を含めるか除外するクエリ パラメーター (コンマ区切り)。
queryStringBehavior	queryStringBehavior	要求のキャッシュ動作
typeName	enum: DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

コンテンツをキャッシュする必要があるレベル。

名前	型	説明
All	string

ClientPortMatchConditionParameters

ClientPort の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	ClientPortOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleClientPortConditionParameters

ClientPortOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

CookiesMatchConditionParameters

Cookie の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	CookiesOperator		一致する演算子について説明します
selector	string		照合する Cookie の名前
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleCookiesConditionParameters

CookiesOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

DeepCreatedCustomDomain

CDN エンドポイントで作成されたカスタム ドメイン。

名前	型	説明
name	string	カスタム ドメイン名。
properties.hostName	string	カスタム ドメインのホスト名。 ドメイン名を指定してください。
properties.validationData	string	ローカル のコンプライアンス上の理由により、CDN を一部のリージョンに配信する場合は、特別な検証またはデータが必要になる場合があります。 たとえば、中国でコンテンツを配信するには、カスタム ドメインの ICP ライセンス番号が必要です。

DeepCreatedOrigin

CDN エンドポイントの作成時に追加される CDN コンテンツのメイン配信元。

名前	型	説明
name	string	エンドポイント内で一意である必要がある配信元名。
properties.enabled	boolean	配信元が負荷分散に対して有効になっているかどうか。 既定では、配信元は常に有効になっています。
properties.hostName	string	配信元のアドレス。 ドメイン名、IPv4 アドレス、または IPv6 アドレスを指定できます。 これは、エンドポイント内のすべての配信元で一意である必要があります。
properties.httpPort	integer	HTTP ポートの値。 1 から 65535 の間である必要があります。
properties.httpsPort	integer	HTTPS ポートの値。 1 から 65535 の間である必要があります。
properties.originHostHeader	string	要求ごとに配信元に送信されるホスト ヘッダー値。 これを空白のままにすると、要求のホスト名によってこの値が決定されます。 Web Apps、Blob Storage、Cloud Services などの Azure CDN 配信元の場合、このホスト ヘッダーの値が既定で配信元のホスト名と一致する必要があります。
properties.priority	integer	負荷分散のために、指定された配信元グループの配信元の優先順位。 優先度の低い配信元が正常な場合、負荷分散には優先度が高くなります。1 ~ 5 の間である必要があります。
properties.privateEndpointStatus	PrivateEndpointStatus	Private Linkへの接続の承認状態
properties.privateLinkAlias	string	Private Link リソースのエイリアス。 この省略可能なフィールドに値を設定すると、この配信元が 'Private' であることを示します
properties.privateLinkApprovalMessage	string	Private Linkに接続するための承認要求に含めるカスタム メッセージ。
properties.privateLinkLocation	string	Private Link リソースの場所。 'privateLinkResourceId' が設定されている場合にのみ必須
properties.privateLinkResourceId	string	Private Link リソースのリソース ID。 この省略可能なフィールドに値を設定すると、このバックエンドが "プライベート" であることを示します
properties.weight	integer	負荷分散のための、特定の配信元グループ内での配信元の重み。 1 から 1000 の間である必要があります

DeepCreatedOriginGroup

CDN エンドポイントの作成時に追加される CDN コンテンツの配信元グループ。 トラフィックは、配信元の正常性に基づいて配信元グループ内の配信元に送信されます。

名前	型	説明
name	string	エンドポイント内で一意である必要がある配信元グループ名。
properties.healthProbeSettings	HealthProbeParameters	配信元の正常性を判断するために使用される、配信元に対する正常性プローブの設定。
properties.origins	ResourceReference[]	指定された配信元グループ内の CDN 経由で配信されるコンテンツのソース。
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	実際の要求/応答を使用して配信元の正常性を判断するためのプロパティを含む JSON オブジェクト。このプロパティは現在サポートされていません。
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	異常なエンドポイントが正常であるか、新しいエンドポイントが追加されたときに、トラフィックをエンドポイントに段階的にシフトする時間 (分単位)。 既定値は 10 分です。 このプロパティは現在サポートされていません。

DeliveryPolicy

エンドポイントに使用する配信ルールを指定するポリシー。

名前	型	説明
description	string	ポリシーのわかりやすい説明。
rules	DeliveryRule[]	配信ルールの一覧。

DeliveryRule

一連のアクションと条件を指定するルール

名前	型	説明
actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]	ルールのすべての条件が満たされたときに実行されるアクションの一覧。
conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]	アクションを実行するために一致する必要がある条件の一覧
name	string	ルールの名前
order	integer	エンドポイントにルールが適用される順序。 使用可能な値 {0,1,2,3,.........} 順序が小さいルールは、より大きな順序のルールの前に適用されます。 順序 0 のルールは特別なルールです。 条件を必要とせず、それに記載されているアクションは常に適用されます。

DeliveryRuleCacheExpirationAction

配信ルールのキャッシュ有効期限アクションを定義します。

名前	型	説明
name	string: CacheExpiration	配信ルールのアクションの名前。
parameters	CacheExpirationActionParameters	アクションのパラメーターを定義します。

DeliveryRuleCacheKeyQueryStringAction

配信ルールのキャッシュ キー クエリ文字列アクションを定義します。

名前	型	説明
name	string: CacheKeyQueryString	配信ルールのアクションの名前。
parameters	CacheKeyQueryStringActionParameters	アクションのパラメーターを定義します。

DeliveryRuleClientPortCondition

配信ルールの ClientPort 条件を定義します。

名前	型	説明
name	string: ClientPort	配信ルールの条件の名前。
parameters	ClientPortMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleCookiesCondition

配信ルールの Cookie 条件を定義します。

名前	型	説明
name	string: Cookies	配信ルールの条件の名前。
parameters	CookiesMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleHostNameCondition

配信ルールの HostName 条件を定義します。

名前	型	説明
name	string: HostName	配信ルールの条件の名前。
parameters	HostNameMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleHttpVersionCondition

配信ルールの HttpVersion 条件を定義します。

名前	型	説明
name	string: HttpVersion	配信ルールの条件の名前。
parameters	HttpVersionMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleIsDeviceCondition

配信ルールの IsDevice 条件を定義します。

名前	型	説明
name	string: IsDevice	配信ルールの条件の名前。
parameters	IsDeviceMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRulePostArgsCondition

配信ルールの PostArgs 条件を定義します。

名前	型	説明
name	string: PostArgs	配信ルールの条件の名前。
parameters	PostArgsMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleQueryStringCondition

配信ルールの QueryString 条件を定義します。

名前	型	説明
name	string: QueryString	配信ルールの条件の名前。
parameters	QueryStringMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRemoteAddressCondition

配信ルールの RemoteAddress 条件を定義します。

名前	型	説明
name	string: RemoteAddress	配信ルールの条件の名前。
parameters	RemoteAddressMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRequestBodyCondition

配信ルールの RequestBody 条件を定義します。

名前	型	説明
name	string: RequestBody	配信ルールの条件の名前。
parameters	RequestBodyMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRequestHeaderAction

配信ルールの要求ヘッダー アクションを定義します。

名前	型	説明
name	string: ModifyRequestHeader	配信ルールのアクションの名前。
parameters	HeaderActionParameters	アクションのパラメーターを定義します。

DeliveryRuleRequestHeaderCondition

配信ルールの RequestHeader 条件を定義します。

名前	型	説明
name	string: RequestHeader	配信ルールの条件の名前。
parameters	RequestHeaderMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRequestMethodCondition

配信ルールの RequestMethod 条件を定義します。

名前	型	説明
name	string: RequestMethod	配信ルールの条件の名前。
parameters	RequestMethodMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRequestSchemeCondition

配信ルールの RequestScheme 条件を定義します。

名前	型	説明
name	string: RequestScheme	配信ルールの条件の名前。
parameters	RequestSchemeMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleRequestUriCondition

配信ルールの RequestUri 条件を定義します。

名前	型	説明
name	string: RequestUri	配信ルールの条件の名前。
parameters	RequestUriMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleResponseHeaderAction

配信ルールの応答ヘッダー アクションを定義します。

名前	型	説明
name	string: ModifyResponseHeader	配信ルールのアクションの名前。
parameters	HeaderActionParameters	アクションのパラメーターを定義します。

DeliveryRuleRouteConfigurationOverrideAction

配信ルールのルート構成オーバーライド アクションを定義します。 Frontdoor Standard/Premium プロファイルにのみ適用されます。

名前	型	説明
name	string: RouteConfigurationOverride	配信ルールのアクションの名前。
parameters	RouteConfigurationOverrideActionParameters	アクションのパラメーターを定義します。

DeliveryRuleServerPortCondition

配信ルールの ServerPort 条件を定義します。

名前	型	説明
name	string: ServerPort	配信ルールの条件の名前。
parameters	ServerPortMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleSocketAddrCondition

配信ルールの SocketAddress 条件を定義します。

名前	型	説明
name	string: SocketAddr	配信ルールの条件の名前。
parameters	SocketAddrMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleSslProtocolCondition

配信ルールの SslProtocol 条件を定義します。

名前	型	説明
name	string: SslProtocol	配信ルールの条件の名前。
parameters	SslProtocolMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleUrlFileExtensionCondition

配信ルールの UrlFileExtension 条件を定義します。

名前	型	説明
name	string: UrlFileExtension	配信ルールの条件の名前。
parameters	UrlFileExtensionMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleUrlFileNameCondition

配信ルールの UrlFileName 条件を定義します。

名前	型	説明
name	string: UrlFileName	配信ルールの条件の名前。
parameters	UrlFileNameMatchConditionParameters	条件のパラメーターを定義します。

DeliveryRuleUrlPathCondition

配信ルールの UrlPath 条件を定義します。

名前	型	説明
name	string: UrlPath	配信ルールの条件の名前。
parameters	UrlPathMatchConditionParameters	条件のパラメーターを定義します。

DestinationProtocol

リダイレクトに使用するプロトコル。 既定値は MatchRequest です

名前	型	説明
Http	string
Https	string
MatchRequest	string

Endpoint

CDN エンドポイントは、配信元、プロトコル、コンテンツ キャッシュ、配信動作などの構成情報を含む CDN プロファイル内のエンティティです。 CDN エンドポイントでは、URL 形式の .azureedge.net が使用されます。

名前	型	規定値	説明
id	string		リソースの ID
location	string		リソースの場所。
name	string		リソース名。
properties.contentTypesToCompress	string[]		圧縮が適用されるコンテンツ タイプの一覧。 値は有効な MIME の種類である必要があります。
properties.customDomains	DeepCreatedCustomDomain[]		エンドポイントの下にあるカスタム ドメイン。
properties.defaultOriginGroup	ResourceReference		配信元グループへの参照。
properties.deliveryPolicy	DeliveryPolicy		エンドポイントに使用する配信ルールを指定するポリシー。
properties.geoFilters	GeoFilter[]		CDN エンドポイント内のユーザーの geo アクセスを定義するルールの一覧。 各 geo フィルターは、指定されたパスまたはコンテンツへのアクセス規則を定義します。たとえば、パス /pictures/ の APAC ブロックなどです。
properties.hostName	string		{endpointName} として構造化されたエンドポイントのホスト名。{DNSZone}(例: contoso.azureedge.net)
properties.isCompressionEnabled	boolean		CDN でコンテンツ圧縮が有効かどうかを示します。 既定値は false です。 圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。 要求されたコンテンツが 1 バイトより小さいか、1 MB を超える場合、CDN ではコンテンツは圧縮されません。
properties.isHttpAllowed	boolean	True	エンドポイントで HTTP トラフィックが許可されているかどうかを示します。 既定値は true です。 少なくとも 1 つのプロトコル (HTTP または HTTPS) を許可する必要があります。
properties.isHttpsAllowed	boolean	True	エンドポイントで HTTPS トラフィックが許可されているかどうかを示します。 既定値は true です。 少なくとも 1 つのプロトコル (HTTP または HTTPS) を許可する必要があります。
properties.optimizationType	OptimizationType		お客様がこの CDN エンドポイントを最適化するシナリオ (ダウンロード、メディア サービスなど) を指定します。 この情報を使用すると、CDN はシナリオ駆動型の最適化を適用できます。
properties.originGroups	DeepCreatedOriginGroup[]		可用性に基づいてトラフィックの負荷分散に使用される配信元で構成される配信元グループ。
properties.originHostHeader	string		要求ごとに配信元に送信されるホスト ヘッダー値。 Endpoint のこのプロパティは、エンドポイントが単一の配信元を使用する場合にのみ許可され、配信元で指定されたのと同じプロパティでオーバーライドできます。この値を空白のままにすると、要求ホスト名によってこの値が決定されます。 Web Apps、Blob Storage、Cloud Services などの Azure CDN 配信元の場合、このホスト ヘッダーの値が既定で配信元のホスト名と一致する必要があります。
properties.originPath	string		CDN がコンテンツの取得に使用できる配信元のディレクトリ パス (例: contoso.cloudapp.net/originpath)。
properties.origins	DeepCreatedOrigin[]		CDN 経由で配信されるコンテンツのソース。
properties.probePath	string		配信元でホストされているファイルへのパス。動的コンテンツの配信を高速化し、CDN の最適なルートを計算するのに役立ちます。 これは、原点パスに対する相対パスです。 このプロパティは、1 つの配信元を使用する場合にのみ関連します。
properties.provisioningState	EndpointProvisioningState		エンドポイントのプロビジョニング状態。
properties.queryStringCachingBehavior	QueryStringCachingBehavior	NotSet	クエリ文字列を含む要求を CDN がキャッシュする方法を定義します。 キャッシュ時にクエリ文字列を無視したり、キャッシュをバイパスしてクエリ文字列を含む要求がキャッシュされないようにしたり、一意の URL ですべての要求をキャッシュしたりできます。
properties.resourceState	EndpointResourceState		エンドポイントのリソースの状態。
properties.urlSigningKeys	UrlSigningKey[]		署名済み URL ハッシュの検証に使用されるキーの一覧。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink		エンドポイントのWeb Application Firewall ポリシーを定義します (該当する場合)
systemData	SystemData		システム データの読み取り専用
tags	object		リソース タグ。
type	string		リソースの種類。

EndpointProvisioningState

エンドポイントのプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

EndpointResourceState

エンドポイントのリソースの状態。

名前	型	説明
Creating	string
Deleting	string
Running	string
Starting	string
Stopped	string
Stopping	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

ForwardingProtocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

名前	型	説明
HttpOnly	string
HttpsOnly	string
MatchRequest	string

GeoFilter

CDN エンドポイント内でのユーザーの geo アクセスを定義するルール。

名前	型	説明
action	GeoFilterActions	geo フィルターのアクション。つまり、アクセスを許可またはブロックします。
countryCodes	string[]	geo フィルターでのユーザーの国または地域のアクセスを定義する 2 文字の国または地域コード (AU、MX、米国など)。
relativePath	string	geo フィルターに適用できる相対パス。 (例: '/mypictures'、'/mypicture/kitty.jpg'など)

GeoFilterActions

geo フィルターのアクション。つまり、アクセスを許可またはブロックします。

名前	型	説明
Allow	string
Block	string

HeaderAction

実行するアクション

名前	型	説明
Append	string
Delete	string
Overwrite	string

HeaderActionParameters

要求ヘッダー アクションのパラメーターを定義します。

名前	型	説明
headerAction	HeaderAction	実行するアクション
headerName	string	変更するヘッダーの名前
typeName	enum: DeliveryRuleHeaderActionParameters
value	string	指定したアクションの値

HealthProbeParameters

正常性プローブを配信元に送信するプロパティを含む JSON オブジェクト。

名前	型	説明
probeIntervalInSeconds	integer	正常性プローブ間の秒数。既定値は 240 秒です。
probePath	string	配信元の正常性を判断するために使われる、配信元を基準とするパス。
probeProtocol	ProbeProtocol	正常性プローブに使用するプロトコル。
probeRequestType	HealthProbeRequestType	行われた正常性プローブの要求の種類。

HealthProbeRequestType

行われた正常性プローブの要求の種類。

名前	型	説明
GET	string
HEAD	string
NotSet	string

HostNameMatchConditionParameters

HostName の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	HostNameOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleHostNameConditionParameters

HostNameOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

HttpErrorRangeParameters

http 状態コードの範囲を表す JSON オブジェクト

名前	型	説明
begin	integer	http 状態コード範囲の包括的な開始。
end	integer	http 状態コード範囲の包括的な終了。

HttpVersionMatchConditionParameters

HttpVersion の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	HttpVersionOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

一致する演算子について説明します

名前	型	説明
Equal	string

IdentityType

リソースを作成または変更する ID の種類

名前	型	説明
application	string
key	string
managedIdentity	string
user	string

IsDeviceMatchConditionParameters

IsDevice の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	MatchValues[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	IsDeviceOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleIsDeviceConditionParameters

IsDeviceOperator

一致する演算子について説明します

名前	型	説明
Equal	string

KeyVaultSigningKeyParameters

URL 署名キーにユーザーの KeyVault を使用するためのパラメーターについて説明します。

名前	型	説明
resourceGroupName	string	シークレットを含むユーザーのKey Vaultのリソース グループ
secretName	string	Key Vault内のシークレットの名前。
secretVersion	string	Key Vault内のシークレットのバージョン (GUID)。
subscriptionId	string	シークレットを含むユーザーのKey Vaultのサブスクリプション ID
typeName	enum: KeyVaultSigningKeyParameters
vaultName	string	シークレットを含むユーザーのKey Vaultの名前

MatchValues

配信ルールの条件の一致値

名前	型	説明
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

OptimizationType

顧客がこの CDN エンドポイントを最適化するシナリオ (ダウンロード、メディア サービスなど) を指定します。 この情報を使用すると、シナリオ駆動型の最適化を適用できます。

名前	型	説明
DynamicSiteAcceleration	string
GeneralMediaStreaming	string
GeneralWebDelivery	string
LargeFileDownload	string
VideoOnDemandMediaStreaming	string

OriginGroupOverride

配信元グループのオーバーライド構成のパラメーターを定義します。

名前	型	説明
forwardingProtocol	ForwardingProtocol	バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。
originGroup	ResourceReference	は、ルート上の DefaultOriginGroup をオーバーライドする OriginGroup を定義します。

OriginGroupOverrideAction

配信ルールの配信元グループのオーバーライド アクションを定義します。

名前	型	説明
name	string: OriginGroupOverride	配信ルールのアクションの名前。
parameters	OriginGroupOverrideActionParameters	アクションのパラメーターを定義します。

OriginGroupOverrideActionParameters

配信元グループのオーバーライド アクションのパラメーターを定義します。

名前	型	説明
originGroup	ResourceReference	は、DefaultOriginGroup をオーバーライドする OriginGroup を定義します。
typeName	enum: DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

パラメーターの目的を示します

名前	型	説明
Expires	string
KeyId	string
Signature	string

PostArgsMatchConditionParameters

PostArgs の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	PostArgsOperator		一致する演算子について説明します
selector	string		照合する PostArg の名前
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRulePostArgsConditionParameters

PostArgsOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

PrivateEndpointStatus

Private Linkへの接続の承認状態

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

ProbeProtocol

正常性プローブに使用するプロトコル。

名前	型	説明
Http	string
Https	string
NotSet	string

queryStringBehavior

要求のキャッシュ動作

名前	型	説明
Exclude	string
ExcludeAll	string
Include	string
IncludeAll	string

QueryStringCachingBehavior

クエリ文字列を含む要求を CDN がキャッシュする方法を定義します。 キャッシュ時にクエリ文字列を無視したり、キャッシュをバイパスしてクエリ文字列を含む要求がキャッシュされないようにしたり、一意の URL ですべての要求をキャッシュしたりできます。

名前	型	説明
BypassCaching	string
IgnoreQueryString	string
NotSet	string
UseQueryString	string

QueryStringMatchConditionParameters

QueryString の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	QueryStringOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleQueryStringConditionParameters

QueryStringOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RedirectType

トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。

名前	型	説明
Found	string
Moved	string
PermanentRedirect	string
TemporaryRedirect	string

RemoteAddressMatchConditionParameters

RemoteAddress の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		照合する値を照合します。 演算子は、OR セマンティクスを使用して、ここでの各値に適用されます。 いずれかが指定された演算子を持つ変数と一致する場合、この一致条件は一致と見なされます。
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	RemoteAddressOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

一致する演算子について説明します

名前	型	説明
Any	string
GeoMatch	string
IPMatch	string

RequestBodyMatchConditionParameters

RequestBody の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	RequestBodyOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestHeaderMatchConditionParameters

RequestHeader の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	RequestHeaderOperator		一致する演算子について説明します
selector	string		一致するヘッダーの名前
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestMethodMatchConditionParameters

RequestMethod の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	MatchValues[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	RequestMethodOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRequestMethodConditionParameters

RequestMethodOperator

一致する演算子について説明します

名前	型	説明
Equal	string

RequestSchemeMatchConditionParameters

RequestScheme の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	MatchValues[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	enum: Equal		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRequestSchemeConditionParameters

RequestUriMatchConditionParameters

RequestUri 一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	RequestUriOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleRequestUriConditionParameters

RequestUriOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

ResourceReference

別のリソースへの参照。

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

ResponseBasedDetectedErrorTypes

配信元が異常と見なされる実際のユーザー要求の応答エラーの種類

名前	型	説明
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

実際の要求/応答を使用して配信元の正常性を判断するためのプロパティを含む JSON オブジェクト。

名前	型	説明
httpErrorRanges	HttpErrorRangeParameters[]	配信元のサーバー エラーと見なされ、異常としてマークされている Http 状態コード範囲の一覧。
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	配信元が異常と見なされる実際のユーザー要求の応答エラーの種類
responseBasedFailoverThresholdPercentage	integer	フェールオーバーがトリガーされるサンプル内の失敗した要求の割合。

RouteConfigurationOverrideActionParameters

ルート構成オーバーライド アクションのパラメーターを定義します。

名前	型	説明
cacheConfiguration	CacheConfiguration	この規則に関連付けられているキャッシュ構成。 キャッシュを無効にするには、cacheConfiguration オブジェクトを指定しないでください。
originGroupOverride	OriginGroupOverride	配信元グループへの参照は、構成をオーバーライドします。 ルートで既定の配信元グループを使用するには、空のままにします。
typeName	enum: DeliveryRuleRouteConfigurationOverrideActionParameters

ruleCacheBehavior

要求のキャッシュ動作

名前	型	説明
HonorOrigin	string
OverrideAlways	string
OverrideIfOriginMissing	string

ruleIsCompressionEnabled

コンテンツ圧縮が有効かどうかを示します。 圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。 要求されたコンテンツが 1 バイト未満または 1 MB を超える場合、AzureFrontDoor ではコンテンツは圧縮されません。

名前	型	説明
Disabled	string
Enabled	string

ruleQueryStringCachingBehavior

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

名前	型	説明
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

ServerPortMatchConditionParameters

ServerPort の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	ServerPortOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleServerPortConditionParameters

ServerPortOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

SocketAddrMatchConditionParameters

SocketAddress の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	SocketAddrOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

一致する演算子について説明します

名前	型	説明
Any	string
IPMatch	string

SslProtocol

確立された TLS 接続のプロトコル。

名前	型	説明
TLSv1	string
TLSv1.1	string
TLSv1.2	string

SslProtocolMatchConditionParameters

SslProtocol 一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	SslProtocol[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが条件を否定するかどうかを記述します
operator	SslProtocolOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

一致する演算子について説明します

名前	型	説明
Equal	string

SystemData

システム データの読み取り専用

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

transform

一致する前に適用される変換について説明します

名前	型	説明
Lowercase	string
RemoveNulls	string
Trim	string
Uppercase	string
UrlDecode	string
UrlEncode	string

UrlFileExtensionMatchConditionParameters

UrlFileExtension の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	UrlFileExtensionOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlFileNameMatchConditionParameters

UrlFilename の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	UrlFileNameOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlPathMatchConditionParameters

UrlPath の一致条件のパラメーターを定義します

名前	型	規定値	説明
matchValues	string[]		配信ルールの条件の一致値
negateCondition	boolean	False	これが否定条件であるかどうかを説明します
operator	UrlPathOperator		一致する演算子について説明します
transforms	transform[]		変換のリスト
typeName	enum: DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

一致する演算子について説明します

名前	型	説明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string
Wildcard	string

UrlRedirectAction

配信ルールの URL リダイレクト アクションを定義します。

名前	型	説明
name	string: UrlRedirect	配信ルールのアクションの名前。
parameters	UrlRedirectActionParameters	アクションのパラメーターを定義します。

UrlRedirectActionParameters

URL リダイレクト アクションのパラメーターを定義します。

名前	型	説明
customFragment	string	リダイレクト URL に追加するフラグメント。 フラグメントは、#の後に来る URL の一部です。 #を含めないでください。
customHostname	string	リダイレクトするホスト。 受信ホストを宛先ホストとして使用するには、空のままにします。
customPath	string	リダイレクトする完全なパス。 パスを空にすることはできず、/で始まる必要があります。 受信パスを宛先パスとして使用するには、空のままにします。
customQueryString	string	リダイレクト URL に配置するクエリ文字列のセット。 この値を設定すると、既存のクエリ文字列が置き換えられます。受信クエリ文字列を保持するには、空のままにします。 クエリ文字列は = 形式である必要があります。 ? & は自動的に追加されるため、それらを含めないでください。
destinationProtocol	DestinationProtocol	リダイレクトに使用するプロトコル。 既定値は MatchRequest です
redirectType	RedirectType	トラフィックのリダイレクト時にルールが使用するリダイレクトの種類。
typeName	enum: DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

配信ルールの URL 書き換えアクションを定義します。

名前	型	説明
name	string: UrlRewrite	配信ルールのアクションの名前。
parameters	UrlRewriteActionParameters	アクションのパラメーターを定義します。

UrlRewriteActionParameters

URL 書き換えアクションのパラメーターを定義します。

名前	型	説明
destination	string	上記の要求の書き換え先となる相対 URL を定義します。
preserveUnmatchedPath	boolean	一致しないパスを保持するかどうか。 既定値は true です。
sourcePattern	string	は、書き換えられる可能性がある要求の種類を識別する要求 URI パターンを定義します。 value が空白の場合、すべての文字列が一致します。
typeName	enum: DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

配信ルールの URL 署名アクションを定義します。

名前	型	説明
name	string: UrlSigning	配信ルールのアクションの名前。
parameters	UrlSigningActionParameters	アクションのパラメーターを定義します。

UrlSigningActionParameters

URL 署名アクションのパラメーターを定義します。

名前	型	説明
algorithm	algorithm	URL 署名に使用するアルゴリズム
parameterNameOverride	UrlSigningParamIdentifier[]	有効期限、キー ID などについて考慮する URL 内のクエリ文字列パラメーターを定義します。
typeName	enum: DeliveryRuleUrlSigningActionParameters

UrlSigningKey

URL 署名キー

名前	型	説明
keyId	string	顧客定義のキー ID を定義します。この ID は、ハッシュの形成に使用されるキーを示す受信要求に存在します。
keySourceParameters	KeyVaultSigningKeyParameters	URL 署名キーにカスタマー キー コンテナーを使用するためのパラメーターを定義します。

UrlSigningParamIdentifier

特定の目的でパラメーターを識別する方法 (有効期限など) を定義します

名前	型	説明
paramIndicator	paramIndicator	パラメーターの目的を示します
paramName	string	パラメーター名

WebApplicationFirewallPolicyLink

エンドポイントのWeb Application Firewall ポリシーを定義します (該当する場合)

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