Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. logz
  5. getTagRule
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.logz.getTagRule

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

Capture logs and metrics of Azure resources based on ARM tags. Azure REST API version: 2022-01-01-preview.

Using getTagRule

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 getTagRule(args: GetTagRuleArgs, opts?: InvokeOptions): Promise<GetTagRuleResult>
function getTagRuleOutput(args: GetTagRuleOutputArgs, opts?: InvokeOptions): Output<GetTagRuleResult>
Copy
def get_tag_rule(monitor_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 rule_set_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTagRuleResult
def get_tag_rule_output(monitor_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[GetTagRuleResult]
Copy
func LookupTagRule(ctx *Context, args *LookupTagRuleArgs, opts ...InvokeOption) (*LookupTagRuleResult, error)
func LookupTagRuleOutput(ctx *Context, args *LookupTagRuleOutputArgs, opts ...InvokeOption) LookupTagRuleResultOutput
Copy

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

public static class GetTagRule 
{
    public static Task<GetTagRuleResult> InvokeAsync(GetTagRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetTagRuleResult> Invoke(GetTagRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTagRuleResult> getTagRule(GetTagRuleArgs args, InvokeOptions options)
public static Output<GetTagRuleResult> getTagRule(GetTagRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:logz:getTagRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String
monitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
string
monitor_name
This property is required.
Changes to this property will trigger replacement.
str
Monitor resource name
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.
rule_set_name
This property is required.
Changes to this property will trigger replacement.
str
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String

getTagRule Result

The following output properties are available:

Id string
The id of the rule set.
Name string
Name of the rule set.
Properties Pulumi.AzureNative.Logz.Outputs.MonitoringTagRulesPropertiesResponse
Definition of the properties for a TagRules resource.
SystemData Pulumi.AzureNative.Logz.Outputs.SystemDataResponse
The system metadata relating to this resource
Type string
The type of the rule set.
Id string
The id of the rule set.
Name string
Name of the rule set.
Properties MonitoringTagRulesPropertiesResponse
Definition of the properties for a TagRules resource.
SystemData SystemDataResponse
The system metadata relating to this resource
Type string
The type of the rule set.
id String
The id of the rule set.
name String
Name of the rule set.
properties MonitoringTagRulesPropertiesResponse
Definition of the properties for a TagRules resource.
systemData SystemDataResponse
The system metadata relating to this resource
type String
The type of the rule set.
id string
The id of the rule set.
name string
Name of the rule set.
properties MonitoringTagRulesPropertiesResponse
Definition of the properties for a TagRules resource.
systemData SystemDataResponse
The system metadata relating to this resource
type string
The type of the rule set.
id str
The id of the rule set.
name str
Name of the rule set.
properties MonitoringTagRulesPropertiesResponse
Definition of the properties for a TagRules resource.
system_data SystemDataResponse
The system metadata relating to this resource
type str
The type of the rule set.
id String
The id of the rule set.
name String
Name of the rule set.
properties Property Map
Definition of the properties for a TagRules resource.
systemData Property Map
The system metadata relating to this resource
type String
The type of the rule set.

Supporting Types

FilteringTagResponse

Action string
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
Name string
The name (also known as the key) of the tag.
Value string
The value of the tag.
Action string
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
Name string
The name (also known as the key) of the tag.
Value string
The value of the tag.
action String
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
name String
The name (also known as the key) of the tag.
value String
The value of the tag.
action string
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
name string
The name (also known as the key) of the tag.
value string
The value of the tag.
action str
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
name str
The name (also known as the key) of the tag.
value str
The value of the tag.
action String
Valid actions for a filtering tag. Exclusion takes priority over inclusion.
name String
The name (also known as the key) of the tag.
value String
The value of the tag.

LogRulesResponse

FilteringTags List<Pulumi.AzureNative.Logz.Inputs.FilteringTagResponse>
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
SendAadLogs bool
Flag specifying if AAD logs should be sent for the Monitor resource.
SendActivityLogs bool
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
SendSubscriptionLogs bool
Flag specifying if subscription logs should be sent for the Monitor resource.
FilteringTags []FilteringTagResponse
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
SendAadLogs bool
Flag specifying if AAD logs should be sent for the Monitor resource.
SendActivityLogs bool
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
SendSubscriptionLogs bool
Flag specifying if subscription logs should be sent for the Monitor resource.
filteringTags List<FilteringTagResponse>
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
sendAadLogs Boolean
Flag specifying if AAD logs should be sent for the Monitor resource.
sendActivityLogs Boolean
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
sendSubscriptionLogs Boolean
Flag specifying if subscription logs should be sent for the Monitor resource.
filteringTags FilteringTagResponse[]
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
sendAadLogs boolean
Flag specifying if AAD logs should be sent for the Monitor resource.
sendActivityLogs boolean
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
sendSubscriptionLogs boolean
Flag specifying if subscription logs should be sent for the Monitor resource.
filtering_tags Sequence[FilteringTagResponse]
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
send_aad_logs bool
Flag specifying if AAD logs should be sent for the Monitor resource.
send_activity_logs bool
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
send_subscription_logs bool
Flag specifying if subscription logs should be sent for the Monitor resource.
filteringTags List<Property Map>
List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.
sendAadLogs Boolean
Flag specifying if AAD logs should be sent for the Monitor resource.
sendActivityLogs Boolean
Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
sendSubscriptionLogs Boolean
Flag specifying if subscription logs should be sent for the Monitor resource.

MonitoringTagRulesPropertiesResponse

ProvisioningState This property is required. string
Flag specifying if the resource provisioning state as tracked by ARM.
SystemData This property is required. Pulumi.AzureNative.Logz.Inputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
LogRules Pulumi.AzureNative.Logz.Inputs.LogRulesResponse
Set of rules for sending logs for the Monitor resource.
ProvisioningState This property is required. string
Flag specifying if the resource provisioning state as tracked by ARM.
SystemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
LogRules LogRulesResponse
Set of rules for sending logs for the Monitor resource.
provisioningState This property is required. String
Flag specifying if the resource provisioning state as tracked by ARM.
systemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
logRules LogRulesResponse
Set of rules for sending logs for the Monitor resource.
provisioningState This property is required. string
Flag specifying if the resource provisioning state as tracked by ARM.
systemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
logRules LogRulesResponse
Set of rules for sending logs for the Monitor resource.
provisioning_state This property is required. str
Flag specifying if the resource provisioning state as tracked by ARM.
system_data This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
log_rules LogRulesResponse
Set of rules for sending logs for the Monitor resource.
provisioningState This property is required. String
Flag specifying if the resource provisioning state as tracked by ARM.
systemData This property is required. Property Map
Metadata pertaining to creation and last modification of the resource.
logRules Property Map
Set of rules for sending logs for the Monitor resource.

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.

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