RunbookOperations class
Class representing a RunbookOperations.
Constructors
| Runbook |
Create a RunbookOperations. |
Methods
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
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
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
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
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<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
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
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<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
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
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
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
The callback