Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. cdn
  5. getRuleSet
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.cdn.getRuleSet

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. Azure REST API version: 2023-05-01.

Other available API versions: 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01.

Using getRuleSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRuleSet(args: GetRuleSetArgs, opts?: InvokeOptions): Promise<GetRuleSetResult>
function getRuleSetOutput(args: GetRuleSetOutputArgs, opts?: InvokeOptions): Output<GetRuleSetResult>
Copy
def get_rule_set(profile_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 rule_set_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRuleSetResult
def get_rule_set_output(profile_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 rule_set_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRuleSetResult]
Copy
func LookupRuleSet(ctx *Context, args *LookupRuleSetArgs, opts ...InvokeOption) (*LookupRuleSetResult, error)
func LookupRuleSetOutput(ctx *Context, args *LookupRuleSetOutputArgs, opts ...InvokeOption) LookupRuleSetResultOutput
Copy

> Note: This function is named LookupRuleSet in the Go SDK.

public static class GetRuleSet 
{
    public static Task<GetRuleSetResult> InvokeAsync(GetRuleSetArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleSetResult> Invoke(GetRuleSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRuleSetResult> getRuleSet(GetRuleSetArgs args, InvokeOptions options)
public static Output<GetRuleSetResult> getRuleSet(GetRuleSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cdn:getRuleSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProfileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the rule set under the profile which is unique globally.
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the rule set under the profile which is unique globally.
profileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the rule set under the profile which is unique globally.
profileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the rule set under the profile which is unique globally.
profile_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
rule_set_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the rule set under the profile which is unique globally.
profileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the rule set under the profile which is unique globally.

getRuleSet Result

The following output properties are available:

DeploymentStatus string
Id string
Resource ID.
Name string
Resource name.
ProfileName string
The name of the profile which holds the rule set.
ProvisioningState string
Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
Read only system data
Type string
Resource type.
DeploymentStatus string
Id string
Resource ID.
Name string
Resource name.
ProfileName string
The name of the profile which holds the rule set.
ProvisioningState string
Provisioning status
SystemData SystemDataResponse
Read only system data
Type string
Resource type.
deploymentStatus String
id String
Resource ID.
name String
Resource name.
profileName String
The name of the profile which holds the rule set.
provisioningState String
Provisioning status
systemData SystemDataResponse
Read only system data
type String
Resource type.
deploymentStatus string
id string
Resource ID.
name string
Resource name.
profileName string
The name of the profile which holds the rule set.
provisioningState string
Provisioning status
systemData SystemDataResponse
Read only system data
type string
Resource type.
deployment_status str
id str
Resource ID.
name str
Resource name.
profile_name str
The name of the profile which holds the rule set.
provisioning_state str
Provisioning status
system_data SystemDataResponse
Read only system data
type str
Resource type.
deploymentStatus String
id String
Resource ID.
name String
Resource name.
profileName String
The name of the profile which holds the rule set.
provisioningState String
Provisioning status
systemData Property Map
Read only system data
type String
Resource type.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC)
CreatedBy string
An identifier for the identity that created the resource
CreatedByType string
The type of identity that created the resource
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
An identifier for the identity that last modified the resource
LastModifiedByType string
The type of identity that last modified the resource
CreatedAt string
The timestamp of resource creation (UTC)
CreatedBy string
An identifier for the identity that created the resource
CreatedByType string
The type of identity that created the resource
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
An identifier for the identity that last modified the resource
LastModifiedByType string
The type of identity that last modified the resource
createdAt String
The timestamp of resource creation (UTC)
createdBy String
An identifier for the identity that created the resource
createdByType String
The type of identity that created the resource
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
An identifier for the identity that last modified the resource
lastModifiedByType String
The type of identity that last modified the resource
createdAt string
The timestamp of resource creation (UTC)
createdBy string
An identifier for the identity that created the resource
createdByType string
The type of identity that created the resource
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
An identifier for the identity that last modified the resource
lastModifiedByType string
The type of identity that last modified the resource
created_at str
The timestamp of resource creation (UTC)
created_by str
An identifier for the identity that created the resource
created_by_type str
The type of identity that created the resource
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
An identifier for the identity that last modified the resource
last_modified_by_type str
The type of identity that last modified the resource
createdAt String
The timestamp of resource creation (UTC)
createdBy String
An identifier for the identity that created the resource
createdByType String
The type of identity that created the resource
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
An identifier for the identity that last modified the resource
lastModifiedByType String
The type of identity that last modified the resource

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native