azure.azcollection.azure_rm_monitorscheduledqueryrules module – Create, update and delete Scheduled query rules

action

dictionary

The actions that will activate when the condition is met

azns_action

dictionary

Azure action group reference

action_group

list / elements=string

The list of the Action Group IDs

email_subject

string

Custom subject override for all email ids in Azure action group

odata_type

string

Specifies the action

Choices:

• "AlertingAction"
• "LogToMetricAction"
• "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"

severity

integer

Severity of the alert

Choices:

• 0
• 1
• 2
• 3
• 4

trigger

dictionary

The trigger condition that results in the alert rule being.

metric_trigger

dictionary

The trigger condition that results in the alert rule being.

metric_column

string

Evaluation of metric on a particular column.

metric_trigger_type

string

Metric Trigger Type.

Choices:

• "Consecutive"
• "Total"

threshold

float

The threshold of the metric trigger.

threshold_operator

string

Evaluation operation for Metric.

Choices:

• "GreaterThanOrEqual"
• "GreaterThan"
• "LessThan"
• "Equal"

threshold

float

Result or count threshold based on which rule should be triggered.

threshold_operator

string

Result or count threshold based on which rule should be triggered.

Choices:

• "GreaterThanOrEqual"
• "GreaterThan"
• "LessThan"

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

• false
• true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables.

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

auto_mitigate

boolean

The flag that indicates whether the alert should be automatically resolved or not.

Choices:

• false
• true

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

• "ignore"
• "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

description

string

The description of the Log Search rule.

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

• false ← (default)
• true

display_name

string

The display name of the alert rule.

enabled

string

The flag which indicates whether the Log Search rule is enabled.

Choices:

• "False"
• "True"

location

string

Location of the scheduled query rule

Scheduled query rules are usually reside at the location of your log analytics workspace.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

The name of the scheduled query rule you’re creating/changing

oidc_token

string

added in azure.azcollection 3.17.0

Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.

This token is exchanged with Azure AD using OIDC federated identity.

Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.

Can also be set via the AZURE_FEDERATED_TOKEN environment variable.

oidc_token_file_path

path

added in azure.azcollection 3.17.0

Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.

The file must contain only raw token.

This method is commonly used in platforms that materialize OIDC tokens as files

Can also be set via the AZURE_FEDERATED_TOKEN_FILE environment variable.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group

schedule

dictionary

Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction.

frequency_in_minutes

integer

Frequency (in minutes) at which rule condition should be evaluated.

time_window_in_minutes

integer

Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

secret

string

Azure client secret. Use when authenticating with a Service Principal.

source

dictionary

Data Source against which rule will Query Data.

authorized_resources

list / elements=string

List of Resource referred into query.

data_source_id

string

The resource uri over which log search query is to be run.

query

string

Log search query. Required for action type - AlertingAction.

query_type

string

Set value to ‘ResultCount’.

Choices:

• "ResultCount"

state

string

State of the scheduled query rule

Use present for creating/updating a scheduled query rule.

Use absent for deleting a scheduled query rule.

Choices:

• "present" ← (default)
• "absent"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

scheduledqueryrule

dictionary

Details of the scheduled query rule

Is null on state==absent (scheduled query rule does not exist or will be deleted)

Assumes you make legal changes in check mode

Returned: always

Sample: {"action": {"azns_action": {"action_group": ["/subscriptions/<sub-id>/resourceGroups/myrg/providers/microsoft.insights/actionGroups/action_group_name"], "email_subject": ""}, "odata_type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", "severity": "2", "trigger": {"metric_trigger": {"metric_column": "InstanceName,_ResourceId", "metric_trigger_type": "Total", "threshold": 1.0, "threshold_operator": "GreaterThanOrEqual"}, "threshold": 10.0, "threshold_operator": "LessThan"}}, "auto_mitigate": true, "created_with_api_version": "2018-04-16", "description": "Monitoring: Disks/logical volumes with less than 10% free space", "display_name": "scheduled_query_alert_name", "enabled": "true", "id": "/subscriptions/<sub-id>/resourceGroups/myrg/providers/microsoft.insights/scheduledqueryrules/scheduled_query_alert_name", "last_updated_time": "2025-10-30T16:07:30.773011Z", "location": "eastus", "name": "scheduled_query_alert_name", "provisioning_state": "Succeeded", "schedule": {"frequency_in_minutes": 5, "time_window_in_minutes": 5}, "source": {"authorized_resources": [], "data_source_id": "/subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.OperationalInsights/workspaces/log_analytics_workspace_name", "query": "actual query", "query_type": "ResultCount"}, "tags": {}, "type": "Microsoft.Insights/scheduledQueryRules"}