Edit

Share via

Get-AzureRmAutomationDscCompilationJob

  • Reference
Module:
AzureRM.Automation

Gets DSC compilation jobs in Automation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: Get all DSC compilation jobs

PS C:\>Get-AzureRmAutomationDscCompilationJob -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

PS C:\>Get-AzureRmAutomationDscCompilationJob -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

PS C:\>Get-AzureRmAutomationDscCompilationJob -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.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationName

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

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndTime

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

Type:Nullable<T>[DateTimeOffset]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

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

Type:Guid
Aliases:JobId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StartTime

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

Type:Nullable<T>[DateTimeOffset]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Type:String
Accepted values:Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating, New
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Guid

String

Outputs

CompilationJob