RunbookOperations interface

Package:

@azure/arm-automation

Interface representing a RunbookOperations.

Methods

beginPublish(string, string, string, RunbookPublishOptionalParams)	Publish runbook draft.
beginPublishAndWait(string, string, string, RunbookPublishOptionalParams)	Publish runbook draft.
createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RunbookCreateOrUpdateOptionalParams)	Create the runbook identified by runbook name.
delete(string, string, string, RunbookDeleteOptionalParams)	Delete the runbook by name.
get(string, string, string, RunbookGetOptionalParams)	Retrieve the runbook identified by runbook name.
getContent(string, string, string, RunbookGetContentOptionalParams)	Retrieve the content of runbook identified by runbook name.
listByAutomationAccount(string, string, RunbookListByAutomationAccountOptionalParams)	Retrieve a list of runbooks.
update(string, string, string, RunbookUpdateParameters, RunbookUpdateOptionalParams)	Update the runbook identified by runbook name.

Method Details

beginPublish(string, string, string, RunbookPublishOptionalParams)

Publish runbook draft.

function beginPublish(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RunbookPublishOptionalParams): Promise<PollerLike<PollOperationState<RunbookPublishHeaders>, RunbookPublishHeaders>>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The parameters supplied to the publish runbook operation.

options

RunbookPublishOptionalParams

The options parameters.

Returns

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

beginPublishAndWait(string, string, string, RunbookPublishOptionalParams)

Publish runbook draft.

function beginPublishAndWait(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RunbookPublishOptionalParams): Promise<RunbookPublishHeaders>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The parameters supplied to the publish runbook operation.

options

RunbookPublishOptionalParams

The options parameters.

Returns

Promise<RunbookPublishHeaders>

createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RunbookCreateOrUpdateOptionalParams)

Create the runbook identified by runbook name.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookCreateOrUpdateParameters, options?: RunbookCreateOrUpdateOptionalParams): Promise<Runbook>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

parameters

RunbookCreateOrUpdateParameters

The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.

options

RunbookCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Runbook>

delete(string, string, string, RunbookDeleteOptionalParams)

Delete the runbook by name.

function delete(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RunbookDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options

RunbookDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RunbookGetOptionalParams)

Retrieve the runbook identified by runbook name.

function get(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RunbookGetOptionalParams): Promise<Runbook>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options

RunbookGetOptionalParams

The options parameters.

Returns

Promise<Runbook>

getContent(string, string, string, RunbookGetContentOptionalParams)

Retrieve the content of runbook identified by runbook name.

function getContent(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RunbookGetContentOptionalParams): Promise<RunbookGetContentResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options

RunbookGetContentOptionalParams

The options parameters.

Returns

Promise<RunbookGetContentResponse>

listByAutomationAccount(string, string, RunbookListByAutomationAccountOptionalParams)

Retrieve a list of runbooks.

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

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options

RunbookListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Runbook, Runbook[], PageSettings>

update(string, string, string, RunbookUpdateParameters, RunbookUpdateOptionalParams)

Update the runbook identified by runbook name.

function update(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookUpdateParameters, options?: RunbookUpdateOptionalParams): Promise<Runbook>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

parameters

RunbookUpdateParameters

The update parameters for runbook.

options

RunbookUpdateOptionalParams

The options parameters.

Returns

Promise<Runbook>