dsc_compilation_jobs

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

Overview

Name	dsc_compilation_jobs
Type	Resource
Id	azure.automation.dsc_compilation_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the properties of the Dsc Compilation job.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the properties of the Dsc Compilation job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, compilationJobName, subscriptionId		Retrieve the Dsc configuration compilation job identified by job id.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter	Retrieve a list of dsc compilation jobs.
create	insert	resourceGroupName, automationAccountName, compilationJobName, subscriptionId, data__properties		Creates the Dsc compilation job of the configuration.

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
automationAccountName	string	The name of the automation account.
compilationJobName	string	The DSC configuration Id.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The filter to apply on the operation.

SELECT examples

get

Retrieve the Dsc configuration compilation job identified by job id.

SELECT
properties
FROM azure.automation.dsc_compilation_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND compilationJobName = '{{ compilationJobName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of dsc compilation jobs.

SELECT
properties
FROM azure.automation.dsc_compilation_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates the Dsc compilation job of the configuration.

INSERT INTO azure.automation.dsc_compilation_jobs (
data__properties,
data__name,
data__location,
data__tags,
resourceGroupName,
automationAccountName,
compilationJobName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ compilationJobName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: dsc_compilation_jobs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dsc_compilation_jobs resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the dsc_compilation_jobs resource.
    - name: compilationJobName
      value: string
      description: Required parameter for the dsc_compilation_jobs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the dsc_compilation_jobs resource.
    - name: properties
      value: object
      description: |
        Gets or sets the list of compilation job properties.
    - name: name
      value: string
      description: |
        Gets or sets name of the resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the resource.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.