DscCompilationJobOperations interface

Package:

@azure/arm-automation

Interface representing a DscCompilationJobOperations.

Methods

beginCreate(string, string, string, DscCompilationJobCreateParameters, DscCompilationJobCreateOptionalParams)	Creates the Dsc compilation job of the configuration.
beginCreateAndWait(string, string, string, DscCompilationJobCreateParameters, DscCompilationJobCreateOptionalParams)	Creates the Dsc compilation job of the configuration.
get(string, string, string, DscCompilationJobGetOptionalParams)	Retrieve the Dsc configuration compilation job identified by job id.
getStream(string, string, string, string, DscCompilationJobGetStreamOptionalParams)	Retrieve the job stream identified by job stream id.
listByAutomationAccount(string, string, DscCompilationJobListByAutomationAccountOptionalParams)	Retrieve a list of dsc compilation jobs.

Method Details

beginCreate(string, string, string, DscCompilationJobCreateParameters, DscCompilationJobCreateOptionalParams)

Creates the Dsc compilation job of the configuration.

function beginCreate(resourceGroupName: string, automationAccountName: string, compilationJobName: string, parameters: DscCompilationJobCreateParameters, options?: DscCompilationJobCreateOptionalParams): Promise<PollerLike<PollOperationState<DscCompilationJob>, DscCompilationJob>>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

compilationJobName

string

The DSC configuration Id.

parameters

DscCompilationJobCreateParameters

The parameters supplied to the create compilation job operation.

options

DscCompilationJobCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<DscCompilationJob>, DscCompilationJob>>

beginCreateAndWait(string, string, string, DscCompilationJobCreateParameters, DscCompilationJobCreateOptionalParams)

Creates the Dsc compilation job of the configuration.

function beginCreateAndWait(resourceGroupName: string, automationAccountName: string, compilationJobName: string, parameters: DscCompilationJobCreateParameters, options?: DscCompilationJobCreateOptionalParams): Promise<DscCompilationJob>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

compilationJobName

string

The DSC configuration Id.

parameters

DscCompilationJobCreateParameters

The parameters supplied to the create compilation job operation.

options

DscCompilationJobCreateOptionalParams

The options parameters.

Returns

Promise<DscCompilationJob>

get(string, string, string, DscCompilationJobGetOptionalParams)

Retrieve the Dsc configuration compilation job identified by job id.

function get(resourceGroupName: string, automationAccountName: string, compilationJobName: string, options?: DscCompilationJobGetOptionalParams): Promise<DscCompilationJob>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

compilationJobName

string

The DSC configuration Id.

options

DscCompilationJobGetOptionalParams

The options parameters.

Returns

Promise<DscCompilationJob>

getStream(string, string, string, string, DscCompilationJobGetStreamOptionalParams)

Retrieve the job stream identified by job stream id.

function getStream(resourceGroupName: string, automationAccountName: string, jobId: string, jobStreamId: string, options?: DscCompilationJobGetStreamOptionalParams): Promise<JobStream>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

jobId

string

The job id.

jobStreamId

string

The job stream id.

options

DscCompilationJobGetStreamOptionalParams

The options parameters.

Returns

Promise<JobStream>

listByAutomationAccount(string, string, DscCompilationJobListByAutomationAccountOptionalParams)

Retrieve a list of dsc compilation jobs.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: DscCompilationJobListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<DscCompilationJob, DscCompilationJob[], PageSettings>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options

DscCompilationJobListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DscCompilationJob, DscCompilationJob[], PageSettings>