azure.azcollection.azure_rm_monitorscheduledqueryrules module – Create, update and delete Scheduled query rules
Note
This module is part of the azure.azcollection collection (version 3.11.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_monitorscheduledqueryrules.
New in azure.azcollection 3.11.0
Synopsis
Create, update and delete Scheduled query rules
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
The actions that will activate when the condition is met |
|
Azure action group reference |
|
The list of the Action Group IDs |
|
Custom subject override for all email ids in Azure action group |
|
Specifies the action Choices:
|
|
Severity of the alert Choices:
|
|
The trigger condition that results in the alert rule being. |
|
The trigger condition that results in the alert rule being. |
|
Evaluation of metric on a particular column. |
|
Metric Trigger Type. Choices:
|
|
The threshold of the metric trigger. |
|
Evaluation operation for Metric. Choices:
|
|
Result or count threshold based on which rule should be triggered. |
|
Result or count threshold based on which rule should be triggered. Choices:
|
|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
The flag that indicates whether the alert should be automatically resolved or not. Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
The description of the Log Search rule. |
|
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 Choices:
|
|
The display name of the alert rule. |
|
The flag which indicates whether the Log Search rule is enabled. Choices:
|
|
Location of the scheduled query rule Scheduled query rules are usually reside at the location of your log analytics workspace. |
|
Parent argument. |
|
Parent argument. |
|
The name of the scheduled query rule you’re creating/changing |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group |
|
Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction. |
|
Frequency (in minutes) at which rule condition should be evaluated. |
|
Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes). |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Data Source against which rule will Query Data. |
|
List of Resource referred into query. |
|
The resource uri over which log search query is to be run. |
|
Log search query. Required for action type - AlertingAction. |
|
Set value to ‘ResultCount’. Choices:
|
|
State of the scheduled query rule Use Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
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. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- name: Add a scheduled query rule
azure.azcollection.azure_rm_monitorscheduledqueryrules:
state: present
resource_group: resource_group_name
name: scheduled_query_rule_name
location: eastus
action:
azns_action:
action_group:
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/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: resource_group_name
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: resource_group_name
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
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: |