azure_rm_monitorscheduledqueryrules

Create, update and delete Scheduled query rules

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_monitorscheduledqueryrules

Synopsis

Create, update and delete Scheduled query rules

Parameters

Name	Type	Required	Default	Description
action	dict			The actions that will activate when the condition is met
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	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.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
auto_mitigate	bool			The flag that indicates whether the alert should be automatically resolved or not.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
description	string			The description of the Log Search rule.
disable_instance_discovery	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
display_name	string			The display name of the alert rule.
enabled	string			The flag which indicates whether the Log Search rule is enabled.
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	yes		The name of the scheduled query rule you’re creating/changing
oidc_token	string			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 C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			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 C(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	yes		The name of the resource group
schedule	dict			Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
source	dict			Data Source against which rule will Query Data.
state	string		`present`	State of the scheduled query rule
Use C(present) for creating/updating a scheduled query rule.
Use C(absent) for deleting a scheduled query rule.
subscription_id	string			Your Azure subscription Id.
tags	dict			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			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
x509_certificate_path	string			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.

Example

yaml

- name: Add a scheduled query rule
  azure.azcollection.azure_rm_monitorscheduledqueryrules:
    state: present
    resource_group: myrg
    name: scheduled_query_rule_name
    location: eastus
    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
          threshold_operator: GreaterThanOrEqual
        threshold: 10
        threshold_operator: LessThan
    auto_mitigate: true
    description: 'Monitoring: Disks/logical volumes with less than 10% free space'
    display_name: Free_Space_Severity_2_Percentage
    enabled: "true"
    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: >
        Perf
        | where CounterName == "% Free Space"
        | where InstanceName != "total"
        | summarize AggregatedValue = max(CounterValue) by bin(TimeGenerated, 5m), _ResourceId, InstanceName
      query_type: ResultCount


- name: Add tag to existing scheduled query rule
  azure.azcollection.azure_rm_monitorscheduledqueryrules:
    state: present
    name: scheduled_query_rule_name
    resource_group: myrg
    append_tags: true
    tags:
      ThisIsAnAddedExampleTag: ExampleValue

- name: Delete a scheduled query rule
  azure.azcollection.azure_rm_monitorscheduledqueryrules:
    state: absent
    name: scheduled_query_rule_name
    resource_group: myrg