scheduled_query_rule

Creates, updates, deletes, gets or lists a scheduled_query_rule resource.

Overview

Name	scheduled_query_rule
Type	Resource
Id	azure.monitor.scheduled_query_rule

Fields

The following fields are returned by SELECT queries:

get_nsp

Name	Datatype	Description
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.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.monitor.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.monitor.models.ResourceAssociation
systemData	object	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".

list_nsp

Name	Datatype	Description
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.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.monitor.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.monitor.models.ResourceAssociation
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_nsp	select	resource_group_name, rule_name, network_security_perimeter_configuration_name, subscription_id		Gets a network security perimeter configuration.
list_nsp	select	resource_group_name, rule_name, subscription_id		Gets a list of NSP configurations for specified scheduled query rule.
reconcile_nsp	exec	resource_group_name, rule_name, network_security_perimeter_configuration_name, subscription_id		Reconcile network security perimeter configuration for ScheduledQueryRule resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
network_security_perimeter_configuration_name	string	The name for a network security perimeter configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_name	string	The name of the rule. Required.
subscription_id	string

SELECT examples

get_nsp

Gets a network security perimeter configuration.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.monitor.scheduled_query_rule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND network_security_perimeter_configuration_name = '{{ network_security_perimeter_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_nsp

Gets a list of NSP configurations for specified scheduled query rule.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.monitor.scheduled_query_rule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

reconcile_nsp

Reconcile network security perimeter configuration for ScheduledQueryRule resource.

EXEC azure.monitor.scheduled_query_rule.reconcile_nsp 
@resource_group_name='{{ resource_group_name }}' --required, 
@rule_name='{{ rule_name }}' --required, 
@network_security_perimeter_configuration_name='{{ network_security_perimeter_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;