1. Packages
  2. Azure Native
  3. API Docs
  4. cloudngfw
  5. getLocalRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.cloudngfw.getLocalRule

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

Get a LocalRulesResource

Uses Azure REST API version 2025-02-06-preview.

Other available API versions: 2023-09-01, 2023-10-10-preview, 2024-01-19-preview, 2024-02-07-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cloudngfw [ApiVersion]. See the version guide for details.

Using getLocalRule

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 getLocalRule(args: GetLocalRuleArgs, opts?: InvokeOptions): Promise<GetLocalRuleResult>
function getLocalRuleOutput(args: GetLocalRuleOutputArgs, opts?: InvokeOptions): Output<GetLocalRuleResult>
Copy
def get_local_rule(local_rulestack_name: Optional[str] = None,
                   priority: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLocalRuleResult
def get_local_rule_output(local_rulestack_name: Optional[pulumi.Input[str]] = None,
                   priority: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetLocalRuleResult]
Copy
func LookupLocalRule(ctx *Context, args *LookupLocalRuleArgs, opts ...InvokeOption) (*LookupLocalRuleResult, error)
func LookupLocalRuleOutput(ctx *Context, args *LookupLocalRuleOutputArgs, opts ...InvokeOption) LookupLocalRuleResultOutput
Copy

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

public static class GetLocalRule 
{
    public static Task<GetLocalRuleResult> InvokeAsync(GetLocalRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalRuleResult> Invoke(GetLocalRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocalRuleResult> getLocalRule(GetLocalRuleArgs args, InvokeOptions options)
public static Output<GetLocalRuleResult> getLocalRule(GetLocalRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cloudngfw:getLocalRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LocalRulestackName
This property is required.
Changes to this property will trigger replacement.
string
LocalRulestack resource name
Priority
This property is required.
Changes to this property will trigger replacement.
string
Local Rule priority
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
LocalRulestackName
This property is required.
Changes to this property will trigger replacement.
string
LocalRulestack resource name
Priority
This property is required.
Changes to this property will trigger replacement.
string
Local Rule priority
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
localRulestackName
This property is required.
Changes to this property will trigger replacement.
String
LocalRulestack resource name
priority
This property is required.
Changes to this property will trigger replacement.
String
Local Rule priority
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
localRulestackName
This property is required.
Changes to this property will trigger replacement.
string
LocalRulestack resource name
priority
This property is required.
Changes to this property will trigger replacement.
string
Local Rule priority
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
local_rulestack_name
This property is required.
Changes to this property will trigger replacement.
str
LocalRulestack resource name
priority
This property is required.
Changes to this property will trigger replacement.
str
Local Rule priority
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
localRulestackName
This property is required.
Changes to this property will trigger replacement.
String
LocalRulestack resource name
priority
This property is required.
Changes to this property will trigger replacement.
String
Local Rule priority
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getLocalRule Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Priority int
ProvisioningState string
Provisioning state of the resource.
RuleName string
rule name
SystemData Pulumi.AzureNative.Cloudngfw.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ActionType string
rule action
Applications List<string>
array of rule applications
AuditComment string
rule comment
Category Pulumi.AzureNative.Cloudngfw.Outputs.CategoryResponse
rule category
DecryptionRuleType string
enable or disable decryption
Description string
rule description
Destination Pulumi.AzureNative.Cloudngfw.Outputs.DestinationAddrResponse
destination address
EnableLogging string
enable or disable logging
Etag string
etag info
InboundInspectionCertificate string
inbound Inspection Certificate
NegateDestination string
cidr should not be 'any'
NegateSource string
cidr should not be 'any'
Protocol string
any, application-default, TCP:number, UDP:number
ProtocolPortList List<string>
prot port list
RuleState string
state of this rule
Source Pulumi.AzureNative.Cloudngfw.Outputs.SourceAddrResponse
source address
Tags List<Pulumi.AzureNative.Cloudngfw.Outputs.TagInfoResponse>
tag for rule
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Priority int
ProvisioningState string
Provisioning state of the resource.
RuleName string
rule name
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ActionType string
rule action
Applications []string
array of rule applications
AuditComment string
rule comment
Category CategoryResponse
rule category
DecryptionRuleType string
enable or disable decryption
Description string
rule description
Destination DestinationAddrResponse
destination address
EnableLogging string
enable or disable logging
Etag string
etag info
InboundInspectionCertificate string
inbound Inspection Certificate
NegateDestination string
cidr should not be 'any'
NegateSource string
cidr should not be 'any'
Protocol string
any, application-default, TCP:number, UDP:number
ProtocolPortList []string
prot port list
RuleState string
state of this rule
Source SourceAddrResponse
source address
Tags []TagInfoResponse
tag for rule
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
priority Integer
provisioningState String
Provisioning state of the resource.
ruleName String
rule name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actionType String
rule action
applications List<String>
array of rule applications
auditComment String
rule comment
category CategoryResponse
rule category
decryptionRuleType String
enable or disable decryption
description String
rule description
destination DestinationAddrResponse
destination address
enableLogging String
enable or disable logging
etag String
etag info
inboundInspectionCertificate String
inbound Inspection Certificate
negateDestination String
cidr should not be 'any'
negateSource String
cidr should not be 'any'
protocol String
any, application-default, TCP:number, UDP:number
protocolPortList List<String>
prot port list
ruleState String
state of this rule
source SourceAddrResponse
source address
tags List<TagInfoResponse>
tag for rule
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
priority number
provisioningState string
Provisioning state of the resource.
ruleName string
rule name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actionType string
rule action
applications string[]
array of rule applications
auditComment string
rule comment
category CategoryResponse
rule category
decryptionRuleType string
enable or disable decryption
description string
rule description
destination DestinationAddrResponse
destination address
enableLogging string
enable or disable logging
etag string
etag info
inboundInspectionCertificate string
inbound Inspection Certificate
negateDestination string
cidr should not be 'any'
negateSource string
cidr should not be 'any'
protocol string
any, application-default, TCP:number, UDP:number
protocolPortList string[]
prot port list
ruleState string
state of this rule
source SourceAddrResponse
source address
tags TagInfoResponse[]
tag for rule
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
priority int
provisioning_state str
Provisioning state of the resource.
rule_name str
rule name
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
action_type str
rule action
applications Sequence[str]
array of rule applications
audit_comment str
rule comment
category CategoryResponse
rule category
decryption_rule_type str
enable or disable decryption
description str
rule description
destination DestinationAddrResponse
destination address
enable_logging str
enable or disable logging
etag str
etag info
inbound_inspection_certificate str
inbound Inspection Certificate
negate_destination str
cidr should not be 'any'
negate_source str
cidr should not be 'any'
protocol str
any, application-default, TCP:number, UDP:number
protocol_port_list Sequence[str]
prot port list
rule_state str
state of this rule
source SourceAddrResponse
source address
tags Sequence[TagInfoResponse]
tag for rule
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
priority Number
provisioningState String
Provisioning state of the resource.
ruleName String
rule name
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actionType String
rule action
applications List<String>
array of rule applications
auditComment String
rule comment
category Property Map
rule category
decryptionRuleType String
enable or disable decryption
description String
rule description
destination Property Map
destination address
enableLogging String
enable or disable logging
etag String
etag info
inboundInspectionCertificate String
inbound Inspection Certificate
negateDestination String
cidr should not be 'any'
negateSource String
cidr should not be 'any'
protocol String
any, application-default, TCP:number, UDP:number
protocolPortList List<String>
prot port list
ruleState String
state of this rule
source Property Map
source address
tags List<Property Map>
tag for rule

Supporting Types

CategoryResponse

Feeds This property is required. List<string>
feed list
UrlCustom This property is required. List<string>
custom URL
Feeds This property is required. []string
feed list
UrlCustom This property is required. []string
custom URL
feeds This property is required. List<String>
feed list
urlCustom This property is required. List<String>
custom URL
feeds This property is required. string[]
feed list
urlCustom This property is required. string[]
custom URL
feeds This property is required. Sequence[str]
feed list
url_custom This property is required. Sequence[str]
custom URL
feeds This property is required. List<String>
feed list
urlCustom This property is required. List<String>
custom URL

DestinationAddrResponse

Cidrs List<string>
special value 'any'
Countries List<string>
list of countries
Feeds List<string>
list of feeds
FqdnLists List<string>
fqdn list
PrefixLists List<string>
prefix list
Cidrs []string
special value 'any'
Countries []string
list of countries
Feeds []string
list of feeds
FqdnLists []string
fqdn list
PrefixLists []string
prefix list
cidrs List<String>
special value 'any'
countries List<String>
list of countries
feeds List<String>
list of feeds
fqdnLists List<String>
fqdn list
prefixLists List<String>
prefix list
cidrs string[]
special value 'any'
countries string[]
list of countries
feeds string[]
list of feeds
fqdnLists string[]
fqdn list
prefixLists string[]
prefix list
cidrs Sequence[str]
special value 'any'
countries Sequence[str]
list of countries
feeds Sequence[str]
list of feeds
fqdn_lists Sequence[str]
fqdn list
prefix_lists Sequence[str]
prefix list
cidrs List<String>
special value 'any'
countries List<String>
list of countries
feeds List<String>
list of feeds
fqdnLists List<String>
fqdn list
prefixLists List<String>
prefix list

SourceAddrResponse

Cidrs List<string>
special value 'any'
Countries List<string>
list of countries
Feeds List<string>
list of feeds
PrefixLists List<string>
prefix list
Cidrs []string
special value 'any'
Countries []string
list of countries
Feeds []string
list of feeds
PrefixLists []string
prefix list
cidrs List<String>
special value 'any'
countries List<String>
list of countries
feeds List<String>
list of feeds
prefixLists List<String>
prefix list
cidrs string[]
special value 'any'
countries string[]
list of countries
feeds string[]
list of feeds
prefixLists string[]
prefix list
cidrs Sequence[str]
special value 'any'
countries Sequence[str]
list of countries
feeds Sequence[str]
list of feeds
prefix_lists Sequence[str]
prefix list
cidrs List<String>
special value 'any'
countries List<String>
list of countries
feeds List<String>
list of feeds
prefixLists List<String>
prefix list

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
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
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
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
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
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
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
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
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
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
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
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
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TagInfoResponse

Key This property is required. string
tag name
Value This property is required. string
tag value
Key This property is required. string
tag name
Value This property is required. string
tag value
key This property is required. String
tag name
value This property is required. String
tag value
key This property is required. string
tag name
value This property is required. string
tag value
key This property is required. str
tag name
value This property is required. str
tag value
key This property is required. String
tag name
value This property is required. String
tag value

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi