Edit

Share via

Get-AzAutomationDscCompilationJob

Module:
Az.Automation Module

Gets DSC compilation jobs in Automation.

Syntax

ByAll (Default) 

Get-AzAutomationDscCompilationJob
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-Status <String>]
    [-StartTime <DateTimeOffset>]
    [-EndTime <DateTimeOffset>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByJobId 

Get-AzAutomationDscCompilationJob
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -Id <Guid>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByConfigurationName 

Get-AzAutomationDscCompilationJob
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -ConfigurationName <String>
    [-Status <String>]
    [-StartTime <DateTimeOffset>]
    [-EndTime <DateTimeOffset>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzAutomationDscCompilationJob cmdlet gets APS Desired State Configuration (DSC) compilation jobs in Azure Automation.

Examples

Example 1: Get all DSC compilation jobs

Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"

This command gets all compilation jobs in the Automation account named Contoso17.

Example 2: Get DSC compilation jobs for a configuration

Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration"

This command gets all compilation jobs for the DSC configuration named ContosoConfiguration in the Automation account named Contoso17.

Example 3: Get a specific DSC compilation job

Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298

This command gets the compilation job with the specified ID in the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of the Automation account that contains DSC compilation jobs that this cmdlet gets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ConfigurationName

Specifies the name of the DSC configuration for which this cmdlet gets compilation jobs.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

ByConfigurationName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EndTime

Specifies an end time. This cmdlet gets compilations jobs that started up to the time that this parameter specifies.

Parameter properties

Type:

Nullable<T>[DateTimeOffset]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAll
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByConfigurationName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the unique ID of the DSC compilation job that this cmdlet gets.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:JobId

Parameter sets

ByJobId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Specifies the name of a resource group in which this cmdlet gets DSC compilation jobs.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StartTime

Specifies a start time. This cmdlet gets jobs that start at or after the time that this parameter specifies.

Parameter properties

Type:

Nullable<T>[DateTimeOffset]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAll
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByConfigurationName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

Specifies the status of jobs that this cmdlet gets. Valid values are:

  • Completed
  • Failed
  • Queued
  • Starting
  • Resuming
  • Running
  • Stopped
  • Stopping
  • Suspended
  • Suspending
  • Activating
  • New

Parameter properties

Type:String
Default value:None
Accepted values:Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating, New
Supports wildcards:False
DontShow:False

Parameter sets

ByAll
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByConfigurationName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Guid

String

Outputs

CompilationJob