compute_policies

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

Overview

Name	compute_policies
Type	Resource
Id	azure.datalake_analytics.compute_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
maxDegreeOfParallelismPerJob	integer	The maximum degree of parallelism per job this user can use to submit jobs.
minPriorityPerJob	integer	The minimum priority per job this user can use to submit jobs.
objectId	string	The AAD object identifier for the entity to create a policy for.
objectType	string	The type of AAD object the object identifier refers to. Known values are: "User", "Group", and "ServicePrincipal".
type	string	The resource type.

list_by_account

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
maxDegreeOfParallelismPerJob	integer	The maximum degree of parallelism per job this user can use to submit jobs.
minPriorityPerJob	integer	The minimum priority per job this user can use to submit jobs.
objectId	string	The AAD object identifier for the entity to create a policy for.
objectType	string	The type of AAD object the object identifier refers to. Known values are: "User", "Group", and "ServicePrincipal".
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, compute_policy_name, subscription_id		Gets the specified Data Lake Analytics compute policy.
list_by_account	select	resource_group_name, account_name, subscription_id		Lists the Data Lake Analytics compute policies within the specified Data Lake Analytics account. An account supports, at most, 50 policies.
create_or_update	insert	resource_group_name, account_name, compute_policy_name, subscription_id, properties		Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies.
update	update	resource_group_name, account_name, compute_policy_name, subscription_id		Updates the specified compute policy.
create_or_update	replace	resource_group_name, account_name, compute_policy_name, subscription_id, properties		Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies.
delete	delete	resource_group_name, account_name, compute_policy_name, subscription_id		Deletes the specified compute policy from the specified Data Lake Analytics account.

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
account_name	string	The name of the Data Lake Analytics account. Required.
compute_policy_name	string	The name of the compute policy to delete. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string

SELECT examples

get

Gets the specified Data Lake Analytics compute policy.

SELECT
id,
name,
maxDegreeOfParallelismPerJob,
minPriorityPerJob,
objectId,
objectType,
type
FROM azure.datalake_analytics.compute_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND compute_policy_name = '{{ compute_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Lists the Data Lake Analytics compute policies within the specified Data Lake Analytics account. An account supports, at most, 50 policies.

SELECT
id,
name,
maxDegreeOfParallelismPerJob,
minPriorityPerJob,
objectId,
objectType,
type
FROM azure.datalake_analytics.compute_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies.

INSERT INTO azure.datalake_analytics.compute_policies (
properties,
resource_group_name,
account_name,
compute_policy_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ compute_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: compute_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the compute_policies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the compute_policies resource.
  - name: compute_policy_name
    value: "{{ compute_policy_name }}"
    description: Required parameter for the compute_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the compute_policies resource.
  - name: properties
    value:
      objectId: "{{ objectId }}"
      objectType: "{{ objectType }}"
      maxDegreeOfParallelismPerJob: {{ maxDegreeOfParallelismPerJob }}
      minPriorityPerJob: {{ minPriorityPerJob }}

UPDATE examples

update

Updates the specified compute policy.

UPDATE azure.datalake_analytics.compute_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND compute_policy_name = '{{ compute_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_update

Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies.

REPLACE azure.datalake_analytics.compute_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND compute_policy_name = '{{ compute_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the specified compute policy from the specified Data Lake Analytics account.

DELETE FROM azure.datalake_analytics.compute_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND compute_policy_name = '{{ compute_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;