@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Friendly Rules name mapping to the any Rules or secret related information.
*
* Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2025-01-01-preview, 2025-04-15, 2025-06-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cdn [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Rule extends pulumi.CustomResource {
/**
* Get an existing Rule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Rule;
/**
* Returns true if the given object is an instance of Rule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Rule;
/**
* A list of actions that are executed when all the conditions of a rule are satisfied.
*/
readonly actions: pulumi.Output<(outputs.cdn.DeliveryRuleCacheExpirationActionResponse | outputs.cdn.DeliveryRuleCacheKeyQueryStringActionResponse | outputs.cdn.DeliveryRuleRequestHeaderActionResponse | outputs.cdn.DeliveryRuleResponseHeaderActionResponse | outputs.cdn.DeliveryRuleRouteConfigurationOverrideActionResponse | outputs.cdn.OriginGroupOverrideActionResponse | outputs.cdn.UrlRedirectActionResponse | outputs.cdn.UrlRewriteActionResponse | outputs.cdn.UrlSigningActionResponse)[]>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* A list of conditions that must be matched for the actions to be executed
*/
readonly conditions: pulumi.Output<(outputs.cdn.DeliveryRuleClientPortConditionResponse | outputs.cdn.DeliveryRuleCookiesConditionResponse | outputs.cdn.DeliveryRuleHostNameConditionResponse | outputs.cdn.DeliveryRuleHttpVersionConditionResponse | outputs.cdn.DeliveryRuleIsDeviceConditionResponse | outputs.cdn.DeliveryRulePostArgsConditionResponse | outputs.cdn.DeliveryRuleQueryStringConditionResponse | outputs.cdn.DeliveryRuleRemoteAddressConditionResponse | outputs.cdn.DeliveryRuleRequestBodyConditionResponse | outputs.cdn.DeliveryRuleRequestHeaderConditionResponse | outputs.cdn.DeliveryRuleRequestMethodConditionResponse | outputs.cdn.DeliveryRuleRequestSchemeConditionResponse | outputs.cdn.DeliveryRuleRequestUriConditionResponse | outputs.cdn.DeliveryRuleServerPortConditionResponse | outputs.cdn.DeliveryRuleSocketAddrConditionResponse | outputs.cdn.DeliveryRuleSslProtocolConditionResponse | outputs.cdn.DeliveryRuleUrlFileExtensionConditionResponse | outputs.cdn.DeliveryRuleUrlFileNameConditionResponse | outputs.cdn.DeliveryRuleUrlPathConditionResponse)[] | undefined>;
readonly deploymentStatus: pulumi.Output<string>;
/**
* If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.
*/
readonly matchProcessingBehavior: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
*/
readonly order: pulumi.Output<number>;
/**
* Provisioning status
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The name of the rule set containing the rule.
*/
readonly ruleSetName: pulumi.Output<string>;
/**
* Read only system data
*/
readonly systemData: pulumi.Output<outputs.cdn.SystemDataResponse>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Rule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Rule resource.
*/
export interface RuleArgs {
/**
* A list of actions that are executed when all the conditions of a rule are satisfied.
*/
actions: pulumi.Input<pulumi.Input<inputs.cdn.DeliveryRuleCacheExpirationActionArgs | inputs.cdn.DeliveryRuleCacheKeyQueryStringActionArgs | inputs.cdn.DeliveryRuleRequestHeaderActionArgs | inputs.cdn.DeliveryRuleResponseHeaderActionArgs | inputs.cdn.DeliveryRuleRouteConfigurationOverrideActionArgs | inputs.cdn.OriginGroupOverrideActionArgs | inputs.cdn.UrlRedirectActionArgs | inputs.cdn.UrlRewriteActionArgs | inputs.cdn.UrlSigningActionArgs>[]>;
/**
* A list of conditions that must be matched for the actions to be executed
*/
conditions?: pulumi.Input<pulumi.Input<inputs.cdn.DeliveryRuleClientPortConditionArgs | inputs.cdn.DeliveryRuleCookiesConditionArgs | inputs.cdn.DeliveryRuleHostNameConditionArgs | inputs.cdn.DeliveryRuleHttpVersionConditionArgs | inputs.cdn.DeliveryRuleIsDeviceConditionArgs | inputs.cdn.DeliveryRulePostArgsConditionArgs | inputs.cdn.DeliveryRuleQueryStringConditionArgs | inputs.cdn.DeliveryRuleRemoteAddressConditionArgs | inputs.cdn.DeliveryRuleRequestBodyConditionArgs | inputs.cdn.DeliveryRuleRequestHeaderConditionArgs | inputs.cdn.DeliveryRuleRequestMethodConditionArgs | inputs.cdn.DeliveryRuleRequestSchemeConditionArgs | inputs.cdn.DeliveryRuleRequestUriConditionArgs | inputs.cdn.DeliveryRuleServerPortConditionArgs | inputs.cdn.DeliveryRuleSocketAddrConditionArgs | inputs.cdn.DeliveryRuleSslProtocolConditionArgs | inputs.cdn.DeliveryRuleUrlFileExtensionConditionArgs | inputs.cdn.DeliveryRuleUrlFileNameConditionArgs | inputs.cdn.DeliveryRuleUrlPathConditionArgs>[]>;
/**
* If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.
*/
matchProcessingBehavior?: pulumi.Input<string | enums.cdn.MatchProcessingBehavior>;
/**
* The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
*/
order: pulumi.Input<number>;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Name of the delivery rule which is unique within the endpoint.
*/
ruleName?: pulumi.Input<string>;
/**
* Name of the rule set under the profile.
*/
ruleSetName: pulumi.Input<string>;
}