Rules Engines - Create Or Update

Referencia

Servicio:: Front Door Service

Versión de la API:: 2021-06-01

Crea una nueva configuración del motor de reglas con el nombre especificado dentro de Front Door especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName}?api-version=2021-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	Nombre de Front Door que es único globalmente.
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Nombre del grupo de recursos dentro de la suscripción de Azure.
rulesEngineName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nombre del motor de reglas que es único dentro de Front Door.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.rules	RulesEngineRule[]	Lista de reglas que definen una configuración concreta del motor de reglas.

Respuestas

Nombre	Tipo	Description
200 OK	RulesEngine	De acuerdo
201 Created	RulesEngine	Creado
202 Accepted	RulesEngine	Aceptado
Other Status Codes	ErrorResponse	Respuesta de error de Front Door que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create or update a specific Rules Engine Configuration

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1?api-version=2021-06-01

{
  "properties": {
    "rules": [
      {
        "name": "Rule1",
        "priority": 1,
        "action": {
          "routeConfigurationOverride": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
            "redirectType": "Moved",
            "redirectProtocol": "HttpsOnly",
            "customHost": "www.bing.com",
            "customPath": "/api",
            "customFragment": "fragment",
            "customQueryString": "a=b"
          }
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RemoteAddr",
            "rulesEngineOperator": "GeoMatch",
            "rulesEngineMatchValue": [
              "CH"
            ]
          }
        ],
        "matchProcessingBehavior": "Stop"
      },
      {
        "name": "Rule2",
        "priority": 2,
        "action": {
          "responseHeaderActions": [
            {
              "headerActionType": "Overwrite",
              "headerName": "Cache-Control",
              "value": "public, max-age=31536000"
            }
          ]
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RequestFilenameExtension",
            "rulesEngineOperator": "Equal",
            "rulesEngineMatchValue": [
              "jpg"
            ],
            "transforms": [
              "Lowercase"
            ]
          }
        ]
      },
      {
        "name": "Rule3",
        "priority": 3,
        "action": {
          "routeConfigurationOverride": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": null,
            "forwardingProtocol": "HttpsOnly",
            "cacheConfiguration": {
              "queryParameterStripDirective": "StripOnly",
              "queryParameters": "a=b,p=q",
              "dynamicCompression": "Disabled",
              "cacheDuration": "P1DT12H20M30S"
            },
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          }
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RequestHeader",
            "rulesEngineOperator": "Equal",
            "rulesEngineMatchValue": [
              "allowoverride"
            ],
            "transforms": [
              "Lowercase"
            ],
            "negateCondition": false,
            "selector": "Rules-Engine-Route-Forward"
          }
        ]
      }
    ]
  }
}


import com.azure.core.management.SubResource;
import com.azure.resourcemanager.frontdoor.models.CacheConfiguration;
import com.azure.resourcemanager.frontdoor.models.DynamicCompressionEnabled;
import com.azure.resourcemanager.frontdoor.models.ForwardingConfiguration;
import com.azure.resourcemanager.frontdoor.models.FrontDoorForwardingProtocol;
import com.azure.resourcemanager.frontdoor.models.FrontDoorQuery;
import com.azure.resourcemanager.frontdoor.models.FrontDoorRedirectProtocol;
import com.azure.resourcemanager.frontdoor.models.FrontDoorRedirectType;
import com.azure.resourcemanager.frontdoor.models.HeaderAction;
import com.azure.resourcemanager.frontdoor.models.HeaderActionType;
import com.azure.resourcemanager.frontdoor.models.MatchProcessingBehavior;
import com.azure.resourcemanager.frontdoor.models.RedirectConfiguration;
import com.azure.resourcemanager.frontdoor.models.RulesEngineAction;
import com.azure.resourcemanager.frontdoor.models.RulesEngineMatchCondition;
import com.azure.resourcemanager.frontdoor.models.RulesEngineMatchVariable;
import com.azure.resourcemanager.frontdoor.models.RulesEngineOperator;
import com.azure.resourcemanager.frontdoor.models.RulesEngineRule;
import com.azure.resourcemanager.frontdoor.models.Transform;
import java.time.Duration;
import java.util.Arrays;

/**
 * Samples for RulesEngines CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorRulesEngineCreate.
     * json
     */
    /**
     * Sample code: Create or update a specific Rules Engine Configuration.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void
        createOrUpdateASpecificRulesEngineConfiguration(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager.rulesEngines().define("rulesEngine1").withExistingFrontDoor("rg1", "frontDoor1")
            .withRules(
                Arrays.asList(
                    new RulesEngineRule().withName("Rule1").withPriority(1)
                        .withAction(new RulesEngineAction().withRouteConfigurationOverride(new RedirectConfiguration()
                            .withRedirectType(FrontDoorRedirectType.MOVED)
                            .withRedirectProtocol(FrontDoorRedirectProtocol.HTTPS_ONLY).withCustomHost("www.bing.com")
                            .withCustomPath("/api").withCustomFragment("fragment").withCustomQueryString("a=b")))
                        .withMatchConditions(Arrays.asList(new RulesEngineMatchCondition()
                            .withRulesEngineMatchVariable(RulesEngineMatchVariable.REMOTE_ADDR)
                            .withRulesEngineOperator(RulesEngineOperator.GEO_MATCH)
                            .withRulesEngineMatchValue(Arrays.asList("CH"))))
                        .withMatchProcessingBehavior(MatchProcessingBehavior.STOP),
                    new RulesEngineRule().withName("Rule2").withPriority(2)
                        .withAction(new RulesEngineAction().withResponseHeaderActions(
                            Arrays.asList(new HeaderAction().withHeaderActionType(HeaderActionType.OVERWRITE)
                                .withHeaderName("Cache-Control").withValue("public, max-age=31536000"))))
                        .withMatchConditions(Arrays.asList(new RulesEngineMatchCondition()
                            .withRulesEngineMatchVariable(RulesEngineMatchVariable.REQUEST_FILENAME_EXTENSION)
                            .withRulesEngineOperator(RulesEngineOperator.EQUAL)
                            .withRulesEngineMatchValue(Arrays.asList("jpg"))
                            .withTransforms(Arrays.asList(Transform.LOWERCASE)))),
                    new RulesEngineRule().withName("Rule3").withPriority(3)
                        .withAction(new RulesEngineAction().withRouteConfigurationOverride(
                            new ForwardingConfiguration().withForwardingProtocol(FrontDoorForwardingProtocol.HTTPS_ONLY)
                                .withCacheConfiguration(new CacheConfiguration()
                                    .withQueryParameterStripDirective(FrontDoorQuery.STRIP_ONLY)
                                    .withQueryParameters("a=b,p=q")
                                    .withDynamicCompression(DynamicCompressionEnabled.DISABLED)
                                    .withCacheDuration(Duration.parse("P1DT12H20M30S")))
                                .withBackendPool(new SubResource().withId(
                                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"))))
                        .withMatchConditions(Arrays.asList(new RulesEngineMatchCondition()
                            .withRulesEngineMatchVariable(RulesEngineMatchVariable.REQUEST_HEADER)
                            .withSelector("Rules-Engine-Route-Forward")
                            .withRulesEngineOperator(RulesEngineOperator.EQUAL).withNegateCondition(false)
                            .withRulesEngineMatchValue(Arrays.asList("allowoverride"))
                            .withTransforms(Arrays.asList(Transform.LOWERCASE))))))
            .create();
    }
}

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.frontdoor import FrontDoorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-frontdoor
# USAGE
    python frontdoor_rules_engine_create.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 = FrontDoorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.rules_engines.begin_create_or_update(
        resource_group_name="rg1",
        front_door_name="frontDoor1",
        rules_engine_name="rulesEngine1",
        rules_engine_parameters={
            "properties": {
                "rules": [
                    {
                        "action": {
                            "routeConfigurationOverride": {
                                "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
                                "customFragment": "fragment",
                                "customHost": "www.bing.com",
                                "customPath": "/api",
                                "customQueryString": "a=b",
                                "redirectProtocol": "HttpsOnly",
                                "redirectType": "Moved",
                            }
                        },
                        "matchConditions": [
                            {
                                "rulesEngineMatchValue": ["CH"],
                                "rulesEngineMatchVariable": "RemoteAddr",
                                "rulesEngineOperator": "GeoMatch",
                            }
                        ],
                        "matchProcessingBehavior": "Stop",
                        "name": "Rule1",
                        "priority": 1,
                    },
                    {
                        "action": {
                            "responseHeaderActions": [
                                {
                                    "headerActionType": "Overwrite",
                                    "headerName": "Cache-Control",
                                    "value": "public, max-age=31536000",
                                }
                            ]
                        },
                        "matchConditions": [
                            {
                                "rulesEngineMatchValue": ["jpg"],
                                "rulesEngineMatchVariable": "RequestFilenameExtension",
                                "rulesEngineOperator": "Equal",
                                "transforms": ["Lowercase"],
                            }
                        ],
                        "name": "Rule2",
                        "priority": 2,
                    },
                    {
                        "action": {
                            "routeConfigurationOverride": {
                                "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
                                "backendPool": {
                                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
                                },
                                "cacheConfiguration": {
                                    "cacheDuration": "P1DT12H20M30S",
                                    "dynamicCompression": "Disabled",
                                    "queryParameterStripDirective": "StripOnly",
                                    "queryParameters": "a=b,p=q",
                                },
                                "customForwardingPath": None,
                                "forwardingProtocol": "HttpsOnly",
                            }
                        },
                        "matchConditions": [
                            {
                                "negateCondition": False,
                                "rulesEngineMatchValue": ["allowoverride"],
                                "rulesEngineMatchVariable": "RequestHeader",
                                "rulesEngineOperator": "Equal",
                                "selector": "Rules-Engine-Route-Forward",
                                "transforms": ["Lowercase"],
                            }
                        ],
                        "name": "Rule3",
                        "priority": 3,
                    },
                ]
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorRulesEngineCreate.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 armfrontdoor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/frontdoor/armfrontdoor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b54ffc9278eff071455b1dbb4ad2e772afce885d/specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorRulesEngineCreate.json
func ExampleRulesEnginesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfrontdoor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRulesEnginesClient().BeginCreateOrUpdate(ctx, "rg1", "frontDoor1", "rulesEngine1", armfrontdoor.RulesEngine{
		Properties: &armfrontdoor.RulesEngineProperties{
			Rules: []*armfrontdoor.RulesEngineRule{
				{
					Name: to.Ptr("Rule1"),
					Action: &armfrontdoor.RulesEngineAction{
						RouteConfigurationOverride: &armfrontdoor.RedirectConfiguration{
							ODataType:         to.Ptr("#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"),
							CustomFragment:    to.Ptr("fragment"),
							CustomHost:        to.Ptr("www.bing.com"),
							CustomPath:        to.Ptr("/api"),
							CustomQueryString: to.Ptr("a=b"),
							RedirectProtocol:  to.Ptr(armfrontdoor.FrontDoorRedirectProtocolHTTPSOnly),
							RedirectType:      to.Ptr(armfrontdoor.FrontDoorRedirectTypeMoved),
						},
					},
					MatchConditions: []*armfrontdoor.RulesEngineMatchCondition{
						{
							RulesEngineMatchValue: []*string{
								to.Ptr("CH")},
							RulesEngineMatchVariable: to.Ptr(armfrontdoor.RulesEngineMatchVariableRemoteAddr),
							RulesEngineOperator:      to.Ptr(armfrontdoor.RulesEngineOperatorGeoMatch),
						}},
					MatchProcessingBehavior: to.Ptr(armfrontdoor.MatchProcessingBehaviorStop),
					Priority:                to.Ptr[int32](1),
				},
				{
					Name: to.Ptr("Rule2"),
					Action: &armfrontdoor.RulesEngineAction{
						ResponseHeaderActions: []*armfrontdoor.HeaderAction{
							{
								HeaderActionType: to.Ptr(armfrontdoor.HeaderActionTypeOverwrite),
								HeaderName:       to.Ptr("Cache-Control"),
								Value:            to.Ptr("public, max-age=31536000"),
							}},
					},
					MatchConditions: []*armfrontdoor.RulesEngineMatchCondition{
						{
							RulesEngineMatchValue: []*string{
								to.Ptr("jpg")},
							RulesEngineMatchVariable: to.Ptr(armfrontdoor.RulesEngineMatchVariableRequestFilenameExtension),
							RulesEngineOperator:      to.Ptr(armfrontdoor.RulesEngineOperatorEqual),
							Transforms: []*armfrontdoor.Transform{
								to.Ptr(armfrontdoor.TransformLowercase)},
						}},
					Priority: to.Ptr[int32](2),
				},
				{
					Name: to.Ptr("Rule3"),
					Action: &armfrontdoor.RulesEngineAction{
						RouteConfigurationOverride: &armfrontdoor.ForwardingConfiguration{
							ODataType: to.Ptr("#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"),
							BackendPool: &armfrontdoor.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"),
							},
							CacheConfiguration: &armfrontdoor.CacheConfiguration{
								CacheDuration:                to.Ptr("P1DT12H20M30S"),
								DynamicCompression:           to.Ptr(armfrontdoor.DynamicCompressionEnabledDisabled),
								QueryParameterStripDirective: to.Ptr(armfrontdoor.FrontDoorQueryStripOnly),
								QueryParameters:              to.Ptr("a=b,p=q"),
							},
							ForwardingProtocol: to.Ptr(armfrontdoor.FrontDoorForwardingProtocolHTTPSOnly),
						},
					},
					MatchConditions: []*armfrontdoor.RulesEngineMatchCondition{
						{
							NegateCondition: to.Ptr(false),
							RulesEngineMatchValue: []*string{
								to.Ptr("allowoverride")},
							RulesEngineMatchVariable: to.Ptr(armfrontdoor.RulesEngineMatchVariableRequestHeader),
							RulesEngineOperator:      to.Ptr(armfrontdoor.RulesEngineOperatorEqual),
							Selector:                 to.Ptr("Rules-Engine-Route-Forward"),
							Transforms: []*armfrontdoor.Transform{
								to.Ptr(armfrontdoor.TransformLowercase)},
						}},
					Priority: to.Ptr[int32](3),
				}},
		},
	}, 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.RulesEngine = armfrontdoor.RulesEngine{
	// 	Name: to.Ptr("rulesEngine1"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1"),
	// 	Properties: &armfrontdoor.RulesEngineProperties{
	// 		Rules: []*armfrontdoor.RulesEngineRule{
	// 			{
	// 				Name: to.Ptr("Rule1"),
	// 				Action: &armfrontdoor.RulesEngineAction{
	// 					RouteConfigurationOverride: &armfrontdoor.RedirectConfiguration{
	// 						ODataType: to.Ptr("#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"),
	// 						CustomFragment: to.Ptr("fragment"),
	// 						CustomHost: to.Ptr("www.bing.com"),
	// 						CustomPath: to.Ptr("/api"),
	// 						CustomQueryString: to.Ptr("a=b"),
	// 						RedirectProtocol: to.Ptr(armfrontdoor.FrontDoorRedirectProtocolHTTPSOnly),
	// 						RedirectType: to.Ptr(armfrontdoor.FrontDoorRedirectTypeMoved),
	// 					},
	// 				},
	// 				MatchConditions: []*armfrontdoor.RulesEngineMatchCondition{
	// 					{
	// 						RulesEngineMatchValue: []*string{
	// 							to.Ptr("CH")},
	// 							RulesEngineMatchVariable: to.Ptr(armfrontdoor.RulesEngineMatchVariableRemoteAddr),
	// 							RulesEngineOperator: to.Ptr(armfrontdoor.RulesEngineOperatorGeoMatch),
	// 					}},
	// 					MatchProcessingBehavior: to.Ptr(armfrontdoor.MatchProcessingBehaviorStop),
	// 					Priority: to.Ptr[int32](1),
	// 				},
	// 				{
	// 					Name: to.Ptr("Rule2"),
	// 					Action: &armfrontdoor.RulesEngineAction{
	// 						ResponseHeaderActions: []*armfrontdoor.HeaderAction{
	// 							{
	// 								HeaderActionType: to.Ptr(armfrontdoor.HeaderActionTypeOverwrite),
	// 								HeaderName: to.Ptr("Cache-Control"),
	// 								Value: to.Ptr("public, max-age=31536000"),
	// 						}},
	// 					},
	// 					MatchConditions: []*armfrontdoor.RulesEngineMatchCondition{
	// 						{
	// 							RulesEngineMatchValue: []*string{
	// 								to.Ptr("jpg")},
	// 								RulesEngineMatchVariable: to.Ptr(armfrontdoor.RulesEngineMatchVariableRequestFilenameExtension),
	// 								RulesEngineOperator: to.Ptr(armfrontdoor.RulesEngineOperatorEqual),
	// 								Transforms: []*armfrontdoor.Transform{
	// 									to.Ptr(armfrontdoor.TransformLowercase)},
	// 							}},
	// 							Priority: to.Ptr[int32](2),
	// 					}},
	// 				},
	// 			}
}

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

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

/**
 * This sample demonstrates how to Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
 *
 * @summary Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorRulesEngineCreate.json
 */
async function createOrUpdateASpecificRulesEngineConfiguration() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "rg1";
  const frontDoorName = "frontDoor1";
  const rulesEngineName = "rulesEngine1";
  const rulesEngineParameters = {
    rules: [
      {
        name: "Rule1",
        action: {
          routeConfigurationOverride: {
            odataType: "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
            customFragment: "fragment",
            customHost: "www.bing.com",
            customPath: "/api",
            customQueryString: "a=b",
            redirectProtocol: "HttpsOnly",
            redirectType: "Moved",
          },
        },
        matchConditions: [
          {
            rulesEngineMatchValue: ["CH"],
            rulesEngineMatchVariable: "RemoteAddr",
            rulesEngineOperator: "GeoMatch",
          },
        ],
        matchProcessingBehavior: "Stop",
        priority: 1,
      },
      {
        name: "Rule2",
        action: {
          responseHeaderActions: [
            {
              headerActionType: "Overwrite",
              headerName: "Cache-Control",
              value: "public, max-age=31536000",
            },
          ],
        },
        matchConditions: [
          {
            rulesEngineMatchValue: ["jpg"],
            rulesEngineMatchVariable: "RequestFilenameExtension",
            rulesEngineOperator: "Equal",
            transforms: ["Lowercase"],
          },
        ],
        priority: 2,
      },
      {
        name: "Rule3",
        action: {
          routeConfigurationOverride: {
            odataType: "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            backendPool: {
              id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
            },
            cacheConfiguration: {
              cacheDuration: "P1DT12H20M30S",
              dynamicCompression: "Disabled",
              queryParameterStripDirective: "StripOnly",
              queryParameters: "a=b,p=q",
            },
            customForwardingPath: undefined,
            forwardingProtocol: "HttpsOnly",
          },
        },
        matchConditions: [
          {
            negateCondition: false,
            rulesEngineMatchValue: ["allowoverride"],
            rulesEngineMatchVariable: "RequestHeader",
            rulesEngineOperator: "Equal",
            selector: "Rules-Engine-Route-Forward",
            transforms: ["Lowercase"],
          },
        ],
        priority: 3,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const result = await client.rulesEngines.beginCreateOrUpdateAndWait(
    resourceGroupName,
    frontDoorName,
    rulesEngineName,
    rulesEngineParameters,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.FrontDoor.Models;
using Azure.ResourceManager.FrontDoor;

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorRulesEngineCreate.json
// this example is just showing the usage of "RulesEngines_CreateOrUpdate" 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 FrontDoorRulesEngineResource created on azure
// for more information of creating FrontDoorRulesEngineResource, please refer to the document of FrontDoorRulesEngineResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string frontDoorName = "frontDoor1";
string rulesEngineName = "rulesEngine1";
ResourceIdentifier frontDoorRulesEngineResourceId = FrontDoorRulesEngineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, frontDoorName, rulesEngineName);
FrontDoorRulesEngineResource frontDoorRulesEngine = client.GetFrontDoorRulesEngineResource(frontDoorRulesEngineResourceId);

// invoke the operation
FrontDoorRulesEngineData data = new FrontDoorRulesEngineData
{
    Rules = {new RulesEngineRule("Rule1", 1, new RulesEngineAction
    {
    RouteConfigurationOverride = new RedirectConfiguration
    {
    RedirectType = FrontDoorRedirectType.Moved,
    RedirectProtocol = FrontDoorRedirectProtocol.HttpsOnly,
    CustomHost = "www.bing.com",
    CustomPath = "/api",
    CustomFragment = "fragment",
    CustomQueryString = "a=b",
    },
    })
    {
    MatchConditions = {new RulesEngineMatchCondition(RulesEngineMatchVariable.RemoteAddr, RulesEngineOperator.GeoMatch, new string[]{"CH"})},
    MatchProcessingBehavior = MatchProcessingBehavior.Stop,
    }, new RulesEngineRule("Rule2", 2, new RulesEngineAction
    {
    ResponseHeaderActions = {new RulesEngineHeaderAction(RulesEngineHeaderActionType.Overwrite, "Cache-Control")
    {
    Value = "public, max-age=31536000",
    }},
    })
    {
    MatchConditions = {new RulesEngineMatchCondition(RulesEngineMatchVariable.RequestFilenameExtension, RulesEngineOperator.Equal, new string[]{"jpg"})
    {
    Transforms = {RulesEngineMatchTransform.Lowercase},
    }},
    }, new RulesEngineRule("Rule3", 3, new RulesEngineAction
    {
    RouteConfigurationOverride = new ForwardingConfiguration
    {
    CustomForwardingPath = null,
    ForwardingProtocol = FrontDoorForwardingProtocol.HttpsOnly,
    CacheConfiguration = new FrontDoorCacheConfiguration
    {
    QueryParameterStripDirective = FrontDoorQuery.StripOnly,
    QueryParameters = "a=b,p=q",
    DynamicCompression = DynamicCompressionEnabled.Disabled,
    CacheDuration = XmlConvert.ToTimeSpan("P1DT12H20M30S"),
    },
    BackendPoolId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"),
    },
    })
    {
    MatchConditions = {new RulesEngineMatchCondition(RulesEngineMatchVariable.RequestHeader, RulesEngineOperator.Equal, new string[]{"allowoverride"})
    {
    Selector = "Rules-Engine-Route-Forward",
    IsNegateCondition = false,
    Transforms = {RulesEngineMatchTransform.Lowercase},
    }},
    }},
};
ArmOperation<FrontDoorRulesEngineResource> lro = await frontDoorRulesEngine.UpdateAsync(WaitUntil.Completed, data);
FrontDoorRulesEngineResource 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
FrontDoorRulesEngineData 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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1",
  "name": "rulesEngine1",
  "properties": {
    "rules": [
      {
        "name": "Rule1",
        "priority": 1,
        "action": {
          "routeConfigurationOverride": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
            "redirectType": "Moved",
            "redirectProtocol": "HttpsOnly",
            "customHost": "www.bing.com",
            "customPath": "/api",
            "customFragment": "fragment",
            "customQueryString": "a=b"
          }
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RemoteAddr",
            "rulesEngineOperator": "GeoMatch",
            "rulesEngineMatchValue": [
              "CH"
            ]
          }
        ],
        "matchProcessingBehavior": "Stop"
      },
      {
        "name": "Rule2",
        "priority": 2,
        "action": {
          "responseHeaderActions": [
            {
              "headerActionType": "Overwrite",
              "headerName": "Cache-Control",
              "value": "public, max-age=31536000"
            }
          ]
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RequestFilenameExtension",
            "rulesEngineOperator": "Equal",
            "rulesEngineMatchValue": [
              "jpg"
            ],
            "transforms": [
              "Lowercase"
            ]
          }
        ]
      }
    ]
  }
}

status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1",
  "name": "rulesEngine1",
  "properties": {
    "rules": [
      {
        "name": "Rule1",
        "priority": 1,
        "action": {
          "routeConfigurationOverride": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
            "redirectType": "Moved",
            "redirectProtocol": "HttpsOnly",
            "customHost": "www.bing.com",
            "customPath": "/api",
            "customFragment": "fragment",
            "customQueryString": "a=b"
          }
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RemoteAddr",
            "rulesEngineOperator": "GeoMatch",
            "rulesEngineMatchValue": [
              "CH"
            ]
          }
        ],
        "matchProcessingBehavior": "Stop"
      },
      {
        "name": "Rule2",
        "priority": 2,
        "action": {
          "responseHeaderActions": [
            {
              "headerActionType": "Overwrite",
              "headerName": "Cache-Control",
              "value": "public, max-age=31536000"
            }
          ]
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RequestFilenameExtension",
            "rulesEngineOperator": "Equal",
            "rulesEngineMatchValue": [
              "jpg"
            ],
            "transforms": [
              "Lowercase"
            ]
          }
        ]
      }
    ]
  }
}

status code:: 202

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1",
  "name": "rulesEngine1",
  "properties": {
    "rules": [
      {
        "name": "Rule1",
        "priority": 1,
        "action": {
          "routeConfigurationOverride": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
            "redirectType": "Moved",
            "redirectProtocol": "HttpsOnly",
            "customHost": "www.bing.com",
            "customPath": "/api",
            "customFragment": "fragment",
            "customQueryString": "a=b"
          }
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "RemoteAddr",
            "rulesEngineOperator": "GeoMatch",
            "rulesEngineMatchValue": [
              "CH"
            ]
          }
        ],
        "matchProcessingBehavior": "Stop"
      },
      {
        "name": "Rule2",
        "priority": 2,
        "action": {
          "responseHeaderActions": [
            {
              "headerActionType": "Overwrite",
              "headerName": "Cache-Control",
              "value": "public, max-age=31536000"
            }
          ]
        },
        "matchConditions": [
          {
            "rulesEngineMatchVariable": "FilenameExtension",
            "rulesEngineOperator": "Equal",
            "rulesEngineMatchValue": [
              "jpg"
            ],
            "transforms": [
              "Lowercase"
            ]
          }
        ]
      }
    ]
  }
}

Definiciones

Nombre	Description
CacheConfiguration	Configuración de almacenamiento en caché para una ruta de tipo de almacenamiento en caché. Para deshabilitar el almacenamiento en caché, no proporcione un objeto cacheConfiguration.
DynamicCompressionEnabled	Si se debe usar la compresión dinámica para el contenido almacenado en caché
ErrorResponse	La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ForwardingConfiguration	Describe la ruta de reenvío.
FrontDoorForwardingProtocol	Protocolo que usará esta regla al reenviar el tráfico a los back-end.
FrontDoorQuery	Tratamiento de los términos de consulta url al formar la clave de caché.
FrontDoorRedirectProtocol	Protocolo del destino al que se redirige el tráfico.
FrontDoorRedirectType	El tipo de redireccionamiento que usará la regla al redirigir el tráfico.
FrontDoorResourceState	Estado del recurso de Front Door o SubResource de Front Door.
HeaderAction	Acción que puede manipular un encabezado HTTP.
headerActionType	Tipo de manipulación que se va a aplicar al encabezado.
MatchProcessingBehavior	Si esta regla es una coincidencia, el motor de reglas seguirá ejecutando las reglas restantes o deténgase. Si no está presente, el valor predeterminado es Continuar.
RedirectConfiguration	Describe la ruta de redirección.
RulesEngine	Una configuración del motor de reglas que contiene una lista de reglas que se ejecutarán para modificar el comportamiento en tiempo de ejecución de la solicitud y la respuesta.
RulesEngineAction	Una o varias acciones que se ejecutarán, modificando la solicitud o la respuesta.
RulesEngineMatchCondition	Definición de una condición de coincidencia
RulesEngineMatchVariable	Coincidencia de variable
RulesEngineOperator	Describe el operador que se va a aplicar a la condición de coincidencia.
RulesEngineRule	Contiene una lista de condiciones de coincidencia y una acción sobre cómo modificar la solicitud o respuesta. Si coinciden varias reglas, las acciones de una regla que entran en conflicto con una regla anterior sobrescriben una acción singular o anexan en el caso de la manipulación de encabezados.
SubResource	Referencia a otro subrecurso.
transform	Describe qué transformaciones se aplican antes de que coincidan.

CacheConfiguration

Object

Configuración de almacenamiento en caché para una ruta de tipo de almacenamiento en caché. Para deshabilitar el almacenamiento en caché, no proporcione un objeto cacheConfiguration.

Nombre	Tipo	Description
cacheDuration	string (duration)	Duración durante la que se debe almacenar en caché el contenido. El formato permitido está en formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requiere que el valor no sea superior a un año.
dynamicCompression	DynamicCompressionEnabled	Si se debe usar la compresión dinámica para el contenido almacenado en caché
queryParameterStripDirective	FrontDoorQuery	Tratamiento de los términos de consulta url al formar la clave de caché.
queryParameters	string	parámetros de consulta para incluir o excluir (separados por comas).

DynamicCompressionEnabled

Enumeración

Si se debe usar la compresión dinámica para el contenido almacenado en caché

Valor	Description
Disabled
Enabled

ErrorResponse

Object

La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ForwardingConfiguration

Object

Describe la ruta de reenvío.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
backendPool	SubResource	Referencia a backendPool a la que se enruta esta regla.
cacheConfiguration	CacheConfiguration	Configuración de almacenamiento en caché asociada a esta regla.
customForwardingPath	string	Ruta de acceso personalizada que se usa para reescribir las rutas de acceso de recursos coincidentes con esta regla. Deje vacío para usar la ruta de acceso entrante.
forwardingProtocol	FrontDoorForwardingProtocol	Protocolo que usará esta regla al reenviar el tráfico a los back-end.

FrontDoorForwardingProtocol

Enumeración

Protocolo que usará esta regla al reenviar el tráfico a los back-end.

Valor	Description
HttpOnly
HttpsOnly
MatchRequest

FrontDoorQuery

Enumeración

Tratamiento de los términos de consulta url al formar la clave de caché.

Valor	Description
StripAll
StripAllExcept
StripNone
StripOnly

FrontDoorRedirectProtocol

Enumeración

Protocolo del destino al que se redirige el tráfico.

Valor	Description
HttpOnly
HttpsOnly
MatchRequest

FrontDoorRedirectType

Enumeración

El tipo de redireccionamiento que usará la regla al redirigir el tráfico.

Valor	Description
Found
Moved
PermanentRedirect
TemporaryRedirect

FrontDoorResourceState

Enumeración

Estado del recurso de Front Door o SubResource de Front Door.

Valor	Description
Creating
Deleting
Disabled
Disabling
Enabled
Enabling
Migrated
Migrating

HeaderAction

Object

Acción que puede manipular un encabezado HTTP.

Nombre	Tipo	Description
headerActionType	headerActionType	Tipo de manipulación que se va a aplicar al encabezado.
headerName	string	Nombre del encabezado al que se aplicará esta acción.
value	string	Valor con el que se va a actualizar el nombre de encabezado especificado. Este valor no se usa si actionType es Delete.

headerActionType

Enumeración

Tipo de manipulación que se va a aplicar al encabezado.

Valor	Description
Append
Delete
Overwrite

MatchProcessingBehavior

Enumeración

Si esta regla es una coincidencia, el motor de reglas seguirá ejecutando las reglas restantes o deténgase. Si no está presente, el valor predeterminado es Continuar.

Valor	Description
Continue
Stop

RedirectConfiguration

Object

Describe la ruta de redirección.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration
customFragment	string	Fragmento que se va a agregar a la dirección URL de redireccionamiento. El fragmento es la parte de la dirección URL que viene después de #. No incluya #.
customHost	string	Host para redirigir. Deje vacío para usar el host entrante como host de destino.
customPath	string	Ruta de acceso completa que se va a redirigir. La ruta de acceso no puede estar vacía y debe comenzar con /. Deje vacío para usar la ruta de acceso entrante como ruta de acceso de destino.
customQueryString	string	Conjunto de cadenas de consulta que se colocarán en la dirección URL de redireccionamiento. Establecer este valor reemplazaría cualquier cadena de consulta existente; deje vacío para conservar la cadena de consulta entrante. La cadena de consulta debe estar en formato = . ¿La primera? y & se agregarán automáticamente, por lo que no los incluyan en el frente, pero separe varias cadenas de consulta con &.
redirectProtocol	FrontDoorRedirectProtocol	Protocolo del destino al que se redirige el tráfico.
redirectType	FrontDoorRedirectType	El tipo de redireccionamiento que usará la regla al redirigir el tráfico.

RulesEngine

Object

Una configuración del motor de reglas que contiene una lista de reglas que se ejecutarán para modificar el comportamiento en tiempo de ejecución de la solicitud y la respuesta.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.resourceState	FrontDoorResourceState	Estado del recurso de Front Door o SubResource de Front Door. Estado del recurso.
properties.rules	RulesEngineRule[]	Lista de reglas que definen una configuración concreta del motor de reglas.
type	string	Tipo de recurso.

RulesEngineAction

Object

Una o varias acciones que se ejecutarán, modificando la solicitud o la respuesta.

Nombre	Tipo	Description
requestHeaderActions	HeaderAction[]	Lista de acciones de encabezado que se van a aplicar desde la solicitud de AFD al origen.
responseHeaderActions	HeaderAction[]	Lista de acciones de encabezado que se van a aplicar desde la respuesta de AFD al cliente.
routeConfigurationOverride	RouteConfiguration: ForwardingConfiguration RedirectConfiguration	Invalide la configuración de ruta.

RulesEngineMatchCondition

Object

Definición de una condición de coincidencia

Nombre	Tipo	Description
negateCondition	boolean	Describe si se trata de una condición negada o no
rulesEngineMatchValue	string[]	Coincide con los valores con los que buscar coincidencias. El operador se aplicará a cada valor de aquí con semántica OR. Si alguno de ellos coincide con la variable con el operador especificado, esta condición de coincidencia se considera una coincidencia.
rulesEngineMatchVariable	RulesEngineMatchVariable	Coincidencia de variable
rulesEngineOperator	RulesEngineOperator	Describe el operador que se va a aplicar a la condición de coincidencia.
selector	string	Nombre del selector en RequestHeader o RequestBody que se va a buscar coincidencia
transforms	transform[]	Lista de transformaciones

RulesEngineMatchVariable

Enumeración

Coincidencia de variable

Valor	Description
IsMobile
PostArgs
QueryString
RemoteAddr
RequestBody
RequestFilename
RequestFilenameExtension
RequestHeader
RequestMethod
RequestPath
RequestScheme
RequestUri

RulesEngineOperator

Enumeración

Describe el operador que se va a aplicar a la condición de coincidencia.

Valor	Description
Any
BeginsWith
Contains
EndsWith
Equal
GeoMatch
GreaterThan
GreaterThanOrEqual
IPMatch
LessThan
LessThanOrEqual

RulesEngineRule

Object

Contiene una lista de condiciones de coincidencia y una acción sobre cómo modificar la solicitud o respuesta. Si coinciden varias reglas, las acciones de una regla que entran en conflicto con una regla anterior sobrescriben una acción singular o anexan en el caso de la manipulación de encabezados.

Nombre	Tipo	Description
action	RulesEngineAction	Acciones que se deben realizar en la solicitud y respuesta si se cumplen todas las condiciones de coincidencia.
matchConditions	RulesEngineMatchCondition[]	Lista de condiciones de coincidencia que deben cumplirse para que se ejecuten las acciones de esta regla. No tener condiciones de coincidencia significa que las acciones siempre se ejecutarán.
matchProcessingBehavior	MatchProcessingBehavior	Si esta regla es una coincidencia, el motor de reglas seguirá ejecutando las reglas restantes o deténgase. Si no está presente, el valor predeterminado es Continuar.
name	string	Un nombre para hacer referencia a esta regla específica.
priority	integer	Prioridad asignada a esta regla.

SubResource

Object

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

transform

Enumeración

Describe qué transformaciones se aplican antes de que coincidan.

Valor	Description
Lowercase
RemoveNulls
Trim
Uppercase
UrlDecode
UrlEncode