policies

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

Overview

Name	policies
Type	Resource
Id	azure.dev_test_labs.policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
createdDate	string (date-time)	The creation date of the policy.
description	string	The description of the policy.
evaluatorType	string	The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Known values are: "AllowedValuesPolicy" and "MaxValuePolicy".
factData	string	The fact data of the policy.
factName	string	The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Known values are: "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost", "EnvironmentTemplate", and "ScheduleEditPermission".
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
status	string	The status of the policy. Known values are: "Enabled" and "Disabled".
tags	object	The tags of the resource.
threshold	string	The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
createdDate	string (date-time)	The creation date of the policy.
description	string	The description of the policy.
evaluatorType	string	The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Known values are: "AllowedValuesPolicy" and "MaxValuePolicy".
factData	string	The fact data of the policy.
factName	string	The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Known values are: "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost", "EnvironmentTemplate", and "ScheduleEditPermission".
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
status	string	The status of the policy. Known values are: "Enabled" and "Disabled".
tags	object	The tags of the resource.
threshold	string	The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, policy_set_name, name, subscription_id	$expand	Get policy.
list	select	resource_group_name, lab_name, policy_set_name, subscription_id	$expand, $filter, $top, $orderby	List policies in a given policy set.
create_or_update	insert	resource_group_name, lab_name, policy_set_name, name, subscription_id		Create or replace an existing policy.
update	update	resource_group_name, lab_name, policy_set_name, name, subscription_id		Allows modifying tags of policies. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, policy_set_name, name, subscription_id		Create or replace an existing policy.
delete	delete	resource_group_name, lab_name, policy_set_name, name, subscription_id		Delete policy.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the policy. Required.
policy_set_name	string	The name of the policy set. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=description)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get policy.

SELECT
id,
name,
createdDate,
description,
evaluatorType,
factData,
factName,
location,
provisioningState,
status,
tags,
threshold,
type,
uniqueIdentifier
FROM azure.dev_test_labs.policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND policy_set_name = '{{ policy_set_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List policies in a given policy set.

SELECT
id,
name,
createdDate,
description,
evaluatorType,
factData,
factName,
location,
provisioningState,
status,
tags,
threshold,
type,
uniqueIdentifier
FROM azure.dev_test_labs.policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND policy_set_name = '{{ policy_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing policy.

INSERT INTO azure.dev_test_labs.policies (
location,
tags,
properties,
resource_group_name,
lab_name,
policy_set_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ policy_set_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the policies resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the policies resource.
  - name: policy_set_name
    value: "{{ policy_set_name }}"
    description: Required parameter for the policies resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the policies resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      description: "{{ description }}"
      status: "{{ status }}"
      factName: "{{ factName }}"
      factData: "{{ factData }}"
      threshold: "{{ threshold }}"
      evaluatorType: "{{ evaluatorType }}"

UPDATE examples

update

Allows modifying tags of policies. All other properties will be ignored.

UPDATE azure.dev_test_labs.policies
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND policy_set_name = '{{ policy_set_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing policy.

REPLACE azure.dev_test_labs.policies
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND policy_set_name = '{{ policy_set_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete policy.

DELETE FROM azure.dev_test_labs.policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND policy_set_name = '{{ policy_set_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;