次の方法で共有


Microsoft.Network frontDoors/rulesEngines 2020-05-01

Bicep リソース定義

frontDoors/rulesEngines リソースの種類は、次の場合にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/frontDoors/rulesEngines リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Network/frontDoors/rulesEngines@2020-05-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    rules: [
      {
        action: {
          requestHeaderActions: [
            {
              headerActionType: 'string'
              headerName: 'string'
              value: 'string'
            }
          ]
          responseHeaderActions: [
            {
              headerActionType: 'string'
              headerName: 'string'
              value: 'string'
            }
          ]
          routeConfigurationOverride: {
            '@odata.type': 'string'
            // For remaining properties, see RouteConfiguration objects
          }
        }
        matchConditions: [
          {
            negateCondition: bool
            rulesEngineMatchValue: [
              'string'
            ]
            rulesEngineMatchVariable: 'string'
            rulesEngineOperator: 'string'
            selector: 'string'
            transforms: [
              'string'
            ]
          }
        ]
        matchProcessingBehavior: 'string'
        name: 'string'
        priority: int
      }
    ]
  }
}

RouteConfiguration オブジェクト

オブジェクトの種類を指定するには 、@odata.type プロパティを設定します。

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration の場合は、次の値を使用します。

  '@odata.type': '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'
  backendPool: {
    id: 'string'
  }
  cacheConfiguration: {
    cacheDuration: 'string'
    dynamicCompression: 'string'
    queryParameters: 'string'
    queryParameterStripDirective: 'string'
  }
  customForwardingPath: 'string'
  forwardingProtocol: 'string'

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration の場合は、次の値を使用します。

  '@odata.type': '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration'
  customFragment: 'string'
  customHost: 'string'
  customPath: 'string'
  customQueryString: 'string'
  redirectProtocol: 'string'
  redirectType: 'string'

プロパティ値

frontDoors/rulesEngines

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。
種類のリソースのシンボル名: frontDoors
properties ルール エンジン構成のプロパティ。 RulesEngineProperties

RulesEngineProperties

名前 説明
rules 特定のルール エンジン構成を定義するルールの一覧。 RulesEngineRule[]

RulesEngineRule

名前 説明
action すべての一致条件が満たされた場合に要求と応答に対して実行するアクション。 RulesEngineAction (必須)
matchConditions このルールのアクションを実行するために満たす必要がある一致条件の一覧。 一致条件がないということは、アクションが常に実行されることを意味します。 RulesEngineMatchCondition[]
matchProcessingBehavior このルールが一致する場合、ルール エンジンは残りのルールの実行を続行するか、停止する必要があります。 存在しない場合、既定値は Continue です。 'Continue'
'Stop'
name この特定の規則を参照する名前。 string (必須)
priority このルールに割り当てられた優先度。 int (必須)

RulesEngineAction

名前 説明
requestHeaderActions AFD からの要求から配信元に適用するヘッダー アクションの一覧。 HeaderAction[]
responseHeaderActions AFD からの応答からクライアントに適用するヘッダー アクションの一覧。 HeaderAction[]
routeConfigurationOverride ルート構成をオーバーライドします。 RouteConfiguration

HeaderAction

名前 説明
headerActionType ヘッダーに適用する操作の種類。 'Append'
'Delete'
'Overwrite' (必須)
headerName このアクションが適用されるヘッダーの名前。 string (必須)
value 指定したヘッダー名を更新する値。 actionType が Delete の場合、この値は使用されません。 string

RouteConfiguration

名前 説明
@odata.type オブジェクトの種類を設定する #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必須)

ForwardingConfiguration

名前 説明
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration' (必須)
backendPool この規則のルーティング先となる BackendPool への参照。 サブリソース
cacheConfiguration この規則に関連付けられているキャッシュ構成。 CacheConfiguration
customForwardingPath この規則に一致するリソース パスを書き換えるために使用されるカスタム パス。 受信パスを使用するには空のままにします。 string
forwardingProtocol バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。 'HttpOnly'
'HttpsOnly'
'MatchRequest'

サブリソース

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

CacheConfiguration

名前 説明
cacheDuration コンテンツをキャッシュする必要がある期間。 使用できる形式は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) です。 HTTP では、値は 1 年以下である必要があります string
dynamicCompression キャッシュされたコンテンツに動的圧縮を使用するかどうか 'Disabled'
'Enabled'
queryParameters を含めるか除外するクエリ パラメーター (コンマ区切り)。 string
queryParameterStripDirective キャッシュ キーを形成するときの URL クエリ用語の処理。 'StripAll'
'StripAllExcept'
'StripNone'
'StripOnly'

RedirectConfiguration

名前 説明
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必須)
customFragment リダイレクト URL に追加するフラグメント。 フラグメントは、#の後に来る URL の一部です。 #を含めないでください。 string
customHost リダイレクトするホスト。 受信ホストを宛先ホストとして使用するには、空のままにします。 string
customPath リダイレクトする完全なパス。 パスを空にすることはできず、/で始まる必要があります。 受信パスを宛先パスとして使用するには、空のままにします。 string
customQueryString リダイレクト URL に配置するクエリ文字列のセット。 この値を設定すると、既存のクエリ文字列が置き換えられます。受信クエリ文字列を保持するには、空のままにします。 クエリ文字列は {key}={value} 形式である必要があります。 最初の ? と & は自動的に追加されるため、先頭に含めるのではなく、& を使用して複数のクエリ文字列を分離します。 string
redirectProtocol トラフィックがリダイレクトされる宛先のプロトコル 'HttpOnly'
'HttpsOnly'
'MatchRequest'
redirectType トラフィックのリダイレクト時にルールが使用するリダイレクトの種類。 'Found'
'Moved'
'PermanentRedirect'
'TemporaryRedirect'

RulesEngineMatchCondition

名前 説明
negateCondition これが条件を否定するかどうかを記述します [bool]
rulesEngineMatchValue 一致する値を照合します。 演算子は、OR セマンティクスを使用して、ここでの各値に適用されます。 いずれかが指定された演算子で変数と一致する場合、この一致条件は一致と見なされます。 string[] (必須)
rulesEngineMatchVariable 一致変数 'IsMobile'
'PostArgs'
'QueryString'
'RemoteAddr'
'RequestBody'
'RequestFilename'
'RequestFilenameExtension'
'RequestHeader'
'RequestMethod'
'RequestPath'
'RequestScheme'
'RequestUri' (必須)
rulesEngineOperator 一致条件に適用する演算子について説明します。 'Any'
'BeginsWith'
'Contains'
'EndsWith'
'Equal'
'GeoMatch'
'GreaterThan'
'GreaterThanOrEqual'
'IPMatch'
'LessThan'
'LessThanOrEqual' (必須)
セレクター 照合する RequestHeader または RequestBody のセレクターの名前 string
変換 変換のリスト 次のいずれかを含む文字列配列:
'小文字'
'RemoveNulls'
'Trim'
'大文字'
'UrlDecode'
'UrlEncode'

ARM テンプレート リソース定義

frontDoors/rulesEngines リソースの種類は、次の場合にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/frontDoors/rulesEngines リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Network/frontDoors/rulesEngines",
  "apiVersion": "2020-05-01",
  "name": "string",
  "properties": {
    "rules": [
      {
        "action": {
          "requestHeaderActions": [
            {
              "headerActionType": "string",
              "headerName": "string",
              "value": "string"
            }
          ],
          "responseHeaderActions": [
            {
              "headerActionType": "string",
              "headerName": "string",
              "value": "string"
            }
          ],
          "routeConfigurationOverride": {
            "@odata.type": "string"
            // For remaining properties, see RouteConfiguration objects
          }
        },
        "matchConditions": [
          {
            "negateCondition": "bool",
            "rulesEngineMatchValue": [ "string" ],
            "rulesEngineMatchVariable": "string",
            "rulesEngineOperator": "string",
            "selector": "string",
            "transforms": [ "string" ]
          }
        ],
        "matchProcessingBehavior": "string",
        "name": "string",
        "priority": "int"
      }
    ]
  }
}

RouteConfiguration オブジェクト

オブジェクトの種類を指定するには 、@odata.type プロパティを設定します。

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration の場合は、次の値を使用します。

  "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
  "backendPool": {
    "id": "string"
  },
  "cacheConfiguration": {
    "cacheDuration": "string",
    "dynamicCompression": "string",
    "queryParameters": "string",
    "queryParameterStripDirective": "string"
  },
  "customForwardingPath": "string",
  "forwardingProtocol": "string"

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration の場合は、次の値を使用します。

  "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
  "customFragment": "string",
  "customHost": "string",
  "customPath": "string",
  "customQueryString": "string",
  "redirectProtocol": "string",
  "redirectType": "string"

プロパティ値

frontDoors/rulesEngines

名前 説明
type リソースの種類 'Microsoft.Network/frontDoors/rulesEngines'
apiVersion リソース API のバージョン '2020-05-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
properties ルール エンジン構成のプロパティ。 RulesEngineProperties

RulesEngineProperties

名前 説明
rules 特定のルール エンジン構成を定義するルールの一覧。 RulesEngineRule[]

RulesEngineRule

名前 説明
action すべての一致条件が満たされた場合に要求と応答に対して実行するアクション。 RulesEngineAction (必須)
matchConditions このルールのアクションを実行するために満たす必要がある一致条件の一覧。 一致条件がない場合、アクションは常に実行されます。 RulesEngineMatchCondition[]
matchProcessingBehavior このルールが一致する場合は、ルール エンジンが残りのルールの実行を続行するか停止する必要があります。 存在しない場合、既定値は Continue です。 'Continue'
'Stop'
name この特定の規則を参照する名前。 string (必須)
priority このルールに割り当てられた優先度。 int (必須)

RulesEngineAction

名前 説明
requestHeaderActions AFD からの要求から配信元に適用するヘッダー アクションの一覧。 HeaderAction[]
responseHeaderActions AFD からの応答からクライアントに適用するヘッダー アクションの一覧。 HeaderAction[]
routeConfigurationOverride ルート構成をオーバーライドします。 RouteConfiguration

HeaderAction

名前 説明
headerActionType ヘッダーに適用する操作の種類。 'Append'
'Delete'
'Overwrite' (必須)
headerName このアクションが適用されるヘッダーの名前。 string (必須)
value 指定したヘッダー名を更新する値。 actionType が Delete の場合、この値は使用されません。 string

RouteConfiguration

名前 説明
@odata.type オブジェクトの種類を設定する #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必須)

ForwardingConfiguration

名前 説明
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration' (必須)
backendPool この規則のルーティング先となる BackendPool への参照。 サブリソース
cacheConfiguration この規則に関連付けられているキャッシュ構成。 CacheConfiguration
customForwardingPath この規則に一致するリソース パスを書き換えるために使用されるカスタム パス。 受信パスを使用するには空のままにします。 string
forwardingProtocol バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。 'HttpOnly'
'HttpsOnly'
'MatchRequest'

サブリソース

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

CacheConfiguration

名前 説明
cacheDuration コンテンツをキャッシュする必要がある期間。 使用できる形式は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) です。 HTTP では、値を 1 年以下にする必要があります string
dynamicCompression キャッシュされたコンテンツに動的圧縮を使用するかどうか 'Disabled'
'Enabled'
queryParameters を含めるか除外するクエリ パラメーター (コンマ区切り)。 string
queryParameterStripDirective キャッシュ キーを形成するときの URL クエリ用語の処理。 'StripAll'
'StripAllExcept'
'StripNone'
'StripOnly'

RedirectConfiguration

名前 説明
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必須)
customFragment リダイレクト URL に追加するフラグメント。 フラグメントは、 # の後に来る URL の一部です。 #を含めないでください。 string
customHost リダイレクトするホスト。 受信ホストを宛先ホストとして使用するには、空のままにします。 string
customPath リダイレクトする完全なパス。 パスを空にすることはできません。/で始まる必要があります。 受信パスを宛先パスとして使用するには、空のままにします。 string
customQueryString リダイレクト URL に配置するクエリ文字列のセット。 この値を設定すると、既存のクエリ文字列が置き換えられます。受信クエリ文字列を保持するには、空のままにします。 クエリ文字列は {key}={value} 形式である必要があります。 最初の ? & は自動的に追加されるため、先頭に含めるのではなく、複数のクエリ文字列を & で区切ります。 string
redirectProtocol トラフィックがリダイレクトされる宛先のプロトコル 'HttpOnly'
'HttpsOnly'
'MatchRequest'
redirectType トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。 'Found'
'Moved'
'PermanentRedirect'
'TemporaryRedirect'

RulesEngineMatchCondition

名前 説明
negateCondition これが否定条件であるかどうかを説明します [bool]
rulesEngineMatchValue 照合する値を照合します。 演算子は、OR セマンティクスを使用して、ここでの各値に適用されます。 いずれかが指定された演算子を持つ変数と一致する場合、この一致条件は一致と見なされます。 string[] (必須)
rulesEngineMatchVariable 一致変数 'IsMobile'
'PostArgs'
'QueryString'
'RemoteAddr'
'RequestBody'
'RequestFilename'
'RequestFilenameExtension'
'RequestHeader'
'RequestMethod'
'RequestPath'
'RequestScheme'
'RequestUri' (必須)
rulesEngineOperator 一致条件に適用する演算子について説明します。 'Any'
'BeginsWith'
'Contains'
'EndsWith'
'Equal'
'GeoMatch'
'GreaterThan'
'GreaterThanOrEqual'
'IPMatch'
'LessThan'
'LessThanOrEqual' (必須)
セレクター 照合する RequestHeader または RequestBody のセレクターの名前 string
変換 変換のリスト 次のいずれかを含む文字列配列:
'小文字'
'RemoveNulls'
'Trim'
'大文字'
'UrlDecode'
'UrlEncode'

Terraform (AzAPI プロバイダー) リソース定義

frontDoors/rulesEngines リソースの種類は、次の場合にデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/frontDoors/rulesEngines リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/frontDoors/rulesEngines@2020-05-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      rules = [
        {
          action = {
            requestHeaderActions = [
              {
                headerActionType = "string"
                headerName = "string"
                value = "string"
              }
            ]
            responseHeaderActions = [
              {
                headerActionType = "string"
                headerName = "string"
                value = "string"
              }
            ]
            routeConfigurationOverride = {
              @odata.type = "string"
              // For remaining properties, see RouteConfiguration objects
            }
          }
          matchConditions = [
            {
              negateCondition = bool
              rulesEngineMatchValue = [
                "string"
              ]
              rulesEngineMatchVariable = "string"
              rulesEngineOperator = "string"
              selector = "string"
              transforms = [
                "string"
              ]
            }
          ]
          matchProcessingBehavior = "string"
          name = "string"
          priority = int
        }
      ]
    }
  })
}

RouteConfiguration オブジェクト

オブジェクトの種類を指定するには 、@odata.type プロパティを設定します。

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration の場合は、次の値を使用します。

  @odata.type = "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"
  backendPool = {
    id = "string"
  }
  cacheConfiguration = {
    cacheDuration = "string"
    dynamicCompression = "string"
    queryParameters = "string"
    queryParameterStripDirective = "string"
  }
  customForwardingPath = "string"
  forwardingProtocol = "string"

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration の場合は、次の値を使用します。

  @odata.type = "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"
  customFragment = "string"
  customHost = "string"
  customPath = "string"
  customQueryString = "string"
  redirectProtocol = "string"
  redirectType = "string"

プロパティ値

frontDoors/rulesEngines

名前 説明
type リソースの種類 "Microsoft.Network/frontDoors/rulesEngines@2020-05-01"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: frontDoors
properties ルール エンジン構成のプロパティ。 RulesEngineProperties

RulesEngineProperties

名前 説明
rules 特定のルール エンジン構成を定義するルールの一覧。 RulesEngineRule[]

RulesEngineRule

名前 説明
action すべての一致条件が満たされた場合に要求と応答に対して実行するアクション。 RulesEngineAction (必須)
matchConditions このルールのアクションを実行するために満たす必要がある一致条件の一覧。 一致条件がない場合、アクションは常に実行されます。 RulesEngineMatchCondition[]
matchProcessingBehavior このルールが一致する場合は、ルール エンジンが残りのルールの実行を続行するか停止する必要があります。 存在しない場合、既定値は Continue です。 "Continue"
"Stop"
name この特定の規則を参照する名前。 string (必須)
priority このルールに割り当てられた優先度。 int (必須)

RulesEngineAction

名前 説明
requestHeaderActions AFD からの要求から配信元に適用するヘッダー アクションの一覧。 HeaderAction[]
responseHeaderActions AFD からの応答からクライアントに適用するヘッダー アクションの一覧。 HeaderAction[]
routeConfigurationOverride ルート構成をオーバーライドします。 RouteConfiguration

HeaderAction

名前 説明
headerActionType ヘッダーに適用する操作の種類。 "Append"
"削除"
"上書き" (必須)
headerName このアクションが適用されるヘッダーの名前。 string (必須)
value 指定したヘッダー名を更新する値。 actionType が Delete の場合、この値は使用されません。 string

RouteConfiguration

名前 説明
@odata.type オブジェクトの種類を設定する #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必須)

ForwardingConfiguration

名前 説明
@odata.type "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration" (必須)
backendPool この規則のルーティング先となる BackendPool への参照。 サブリソース
cacheConfiguration この規則に関連付けられているキャッシュ構成。 CacheConfiguration
customForwardingPath この規則に一致するリソース パスを書き換えるために使用されるカスタム パス。 受信パスを使用するには空のままにします。 string
forwardingProtocol バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。 "HttpOnly"
"HttpsOnly"
"MatchRequest"

サブリソース

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

CacheConfiguration

名前 説明
cacheDuration コンテンツをキャッシュする必要がある期間。 使用できる形式は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) です。 HTTP では、値を 1 年以下にする必要があります string
dynamicCompression キャッシュされたコンテンツに動的圧縮を使用するかどうか "無効"
"有効"
queryParameters を含めるか除外するクエリ パラメーター (コンマ区切り)。 string
queryParameterStripDirective キャッシュ キーを形成するときの URL クエリ用語の処理。 "StripAll"
"StripAllExcept"
"StripNone"
"StripOnly"

RedirectConfiguration

名前 説明
@odata.type "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration" (必須)
customFragment リダイレクト URL に追加するフラグメント。 フラグメントは、#の後に来る URL の一部です。 #を含めないでください。 string
customHost リダイレクトするホスト。 受信ホストを宛先ホストとして使用するには、空のままにします。 string
customPath リダイレクトする完全なパス。 パスを空にすることはできず、/で始まる必要があります。 受信パスを宛先パスとして使用するには、空のままにします。 string
customQueryString リダイレクト URL に配置するクエリ文字列のセット。 この値を設定すると、既存のクエリ文字列が置き換えられます。受信クエリ文字列を保持するには、空のままにします。 クエリ文字列は {key}={value} 形式である必要があります。 最初の ? と & は自動的に追加されるため、先頭に含めるのではなく、& を使用して複数のクエリ文字列を分離します。 string
redirectProtocol トラフィックがリダイレクトされる宛先のプロトコル "HttpOnly"
"HttpsOnly"
"MatchRequest"
redirectType トラフィックのリダイレクト時にルールが使用するリダイレクトの種類。 "Found"
"Moved"
"PermanentRedirect"
"TemporaryRedirect"

RulesEngineMatchCondition

名前 説明
negateCondition これが条件を否定するかどうかを記述します [bool]
rulesEngineMatchValue 一致する値を照合します。 演算子は、OR セマンティクスを使用して、ここでの各値に適用されます。 いずれかが指定された演算子で変数と一致する場合、この一致条件は一致と見なされます。 string[] (必須)
rulesEngineMatchVariable 一致変数 "IsMobile"
"PostArgs"
"QueryString"
"RemoteAddr"
"RequestBody"
"RequestFilename"
"RequestFilenameExtension"
"RequestHeader"
"RequestMethod"
"RequestPath"
"RequestScheme"
"RequestUri" (必須)
rulesEngineOperator 一致条件に適用する演算子について説明します。 "Any"
"BeginsWith"
"Contains"
"EndsWith"
"等しい"
"GeoMatch"
"GreaterThan"
"GreaterThanOrEqual"
"IPMatch"
"LessThan"
"LessThanOrEqual" (必須)
セレクター 照合する RequestHeader または RequestBody のセレクターの名前 string
変換 変換のリスト 次のいずれかを含む文字列配列:
"小文字"
"RemoveNulls"
"Trim"
"大文字"
"UrlDecode"
"UrlEncode"