Share via

RunbookOperations class

  • Reference
Package:
@azure/arm-automation

Class representing a RunbookOperations.

Constructors

RunbookOperations(AutomationClientContext)

Create a RunbookOperations.

Methods

beginPublish(string, string, string, RequestOptionsBase)

Publish runbook draft.
createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RequestOptionsBase)

Create the runbook identified by runbook name.
createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RequestOptionsBase, ServiceCallback<Runbook>)
createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, ServiceCallback<Runbook>)
deleteMethod(string, string, string, RequestOptionsBase)

Delete the runbook by name.
deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, string, ServiceCallback<void>)
get(string, string, string, RequestOptionsBase)

Retrieve the runbook identified by runbook name.
get(string, string, string, RequestOptionsBase, ServiceCallback<Runbook>)
get(string, string, string, ServiceCallback<Runbook>)
getContent(string, string, string, RequestOptionsBase)

Retrieve the content of runbook identified by runbook name.
getContent(string, string, string, RequestOptionsBase, ServiceCallback<void>)
getContent(string, string, string, ServiceCallback<void>)
listByAutomationAccount(string, string, RequestOptionsBase)

Retrieve a list of runbooks.
listByAutomationAccount(string, string, RequestOptionsBase, ServiceCallback<RunbookListResult>)
listByAutomationAccount(string, string, ServiceCallback<RunbookListResult>)
listByAutomationAccountNext(string, RequestOptionsBase)

Retrieve a list of runbooks.
listByAutomationAccountNext(string, RequestOptionsBase, ServiceCallback<RunbookListResult>)
listByAutomationAccountNext(string, ServiceCallback<RunbookListResult>)
publish(string, string, string, RequestOptionsBase)

Publish runbook draft.
update(string, string, string, RunbookUpdateParameters, RequestOptionsBase)

Update the runbook identified by runbook name.
update(string, string, string, RunbookUpdateParameters, RequestOptionsBase, ServiceCallback<Runbook>)
update(string, string, string, RunbookUpdateParameters, ServiceCallback<Runbook>)

Constructor Details

RunbookOperations(AutomationClientContext)

Create a RunbookOperations.

new RunbookOperations(client: AutomationClientContext)

Parameters

client
AutomationClientContext

Reference to the service client.

Method Details

beginPublish(string, string, string, RequestOptionsBase)

Publish runbook draft.

function beginPublish(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RequestOptionsBase): Promise<LROPoller>

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
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RequestOptionsBase)

Create the runbook identified by runbook name.

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

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
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookCreateOrUpdateResponse>

Promise<Models.RunbookCreateOrUpdateResponse>

createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, RequestOptionsBase, ServiceCallback<Runbook>) 

function createOrUpdate(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookCreateOrUpdateParameters, options: RequestOptionsBase, callback: ServiceCallback<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
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Runbook>

The callback

createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters, ServiceCallback<Runbook>) 

function createOrUpdate(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookCreateOrUpdateParameters, callback: ServiceCallback<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.

callback

ServiceCallback<Runbook>

The callback

deleteMethod(string, string, string, RequestOptionsBase)

Delete the runbook by name.

function deleteMethod(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, automationAccountName: string, runbookName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, string, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, automationAccountName: string, runbookName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

callback

ServiceCallback<void>

The callback

get(string, string, string, RequestOptionsBase)

Retrieve the runbook identified by runbook name.

function get(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RequestOptionsBase): Promise<RunbookGetResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookGetResponse>

Promise<Models.RunbookGetResponse>

get(string, string, string, RequestOptionsBase, ServiceCallback<Runbook>) 

function get(resourceGroupName: string, automationAccountName: string, runbookName: string, options: RequestOptionsBase, callback: ServiceCallback<Runbook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Runbook>

The callback

get(string, string, string, ServiceCallback<Runbook>) 

function get(resourceGroupName: string, automationAccountName: string, runbookName: string, callback: ServiceCallback<Runbook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

callback

ServiceCallback<Runbook>

The callback

getContent(string, string, string, RequestOptionsBase)

Retrieve the content of runbook identified by runbook name.

function getContent(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RequestOptionsBase): 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
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookGetContentResponse>

Promise<Models.RunbookGetContentResponse>

getContent(string, string, string, RequestOptionsBase, ServiceCallback<void>) 

function getContent(resourceGroupName: string, automationAccountName: string, runbookName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

getContent(string, string, string, ServiceCallback<void>) 

function getContent(resourceGroupName: string, automationAccountName: string, runbookName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

runbookName

string

The runbook name.

callback

ServiceCallback<void>

The callback

listByAutomationAccount(string, string, RequestOptionsBase)

Retrieve a list of runbooks.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: RequestOptionsBase): Promise<RunbookListByAutomationAccountResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookListByAutomationAccountResponse>

Promise<Models.RunbookListByAutomationAccountResponse>

listByAutomationAccount(string, string, RequestOptionsBase, ServiceCallback<RunbookListResult>) 

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options: RequestOptionsBase, callback: ServiceCallback<RunbookListResult>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<RunbookListResult>

The callback

listByAutomationAccount(string, string, ServiceCallback<RunbookListResult>) 

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, callback: ServiceCallback<RunbookListResult>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

callback

ServiceCallback<RunbookListResult>

The callback

listByAutomationAccountNext(string, RequestOptionsBase)

Retrieve a list of runbooks.

function listByAutomationAccountNext(nextPageLink: string, options?: RequestOptionsBase): Promise<RunbookListByAutomationAccountNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookListByAutomationAccountNextResponse>

Promise<Models.RunbookListByAutomationAccountNextResponse>

listByAutomationAccountNext(string, RequestOptionsBase, ServiceCallback<RunbookListResult>) 

function listByAutomationAccountNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<RunbookListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<RunbookListResult>

The callback

listByAutomationAccountNext(string, ServiceCallback<RunbookListResult>) 

function listByAutomationAccountNext(nextPageLink: string, callback: ServiceCallback<RunbookListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<RunbookListResult>

The callback

publish(string, string, string, RequestOptionsBase)

Publish runbook draft.

function publish(resourceGroupName: string, automationAccountName: string, runbookName: string, options?: RequestOptionsBase): Promise<RunbookPublishResponse>

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
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookPublishResponse>

Promise<Models.RunbookPublishResponse>

update(string, string, string, RunbookUpdateParameters, RequestOptionsBase)

Update the runbook identified by runbook name.

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

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
RequestOptionsBase

The optional parameters

Returns

Promise<RunbookUpdateResponse>

Promise<Models.RunbookUpdateResponse>

update(string, string, string, RunbookUpdateParameters, RequestOptionsBase, ServiceCallback<Runbook>) 

function update(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookUpdateParameters, options: RequestOptionsBase, callback: ServiceCallback<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
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Runbook>

The callback

update(string, string, string, RunbookUpdateParameters, ServiceCallback<Runbook>) 

function update(resourceGroupName: string, automationAccountName: string, runbookName: string, parameters: RunbookUpdateParameters, callback: ServiceCallback<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.

callback

ServiceCallback<Runbook>

The callback