JobOperations interface
Interface representing a JobOperations.
Methods
| create(string, string, string, Job |
Create a job of the runbook. |
| get(string, string, string, Job |
Retrieve the job identified by job name. |
| get |
Retrieve the job output identified by job name. |
| get |
Retrieve the runbook content of the job identified by job name. |
| list |
Retrieve a list of jobs. |
| resume(string, string, string, Job |
Resume the job identified by jobName. |
| stop(string, string, string, Job |
Stop the job identified by jobName. |
| suspend(string, string, string, Job |
Suspend the job identified by job name. |
Method Details
create(string, string, string, JobCreateParameters, JobCreateOptionalParams)
Create a job of the runbook.
function create(resourceGroupName: string, automationAccountName: string, jobName: string, parameters: JobCreateParameters, options?: JobCreateOptionalParams): Promise<Job>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
- parameters
- JobCreateParameters
The parameters supplied to the create job operation.
- options
- JobCreateOptionalParams
The options parameters.
Returns
Promise<Job>
get(string, string, string, JobGetOptionalParams)
Retrieve the job identified by job name.
function get(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobGetOptionalParams): Promise<Job>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
- options
- JobGetOptionalParams
The options parameters.
Returns
Promise<Job>
getOutput(string, string, string, JobGetOutputOptionalParams)
Retrieve the job output identified by job name.
function getOutput(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobGetOutputOptionalParams): Promise<JobGetOutputResponse>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The name of the job to be created.
- options
- JobGetOutputOptionalParams
The options parameters.
Returns
Promise<JobGetOutputResponse>
getRunbookContent(string, string, string, JobGetRunbookContentOptionalParams)
Retrieve the runbook content of the job identified by job name.
function getRunbookContent(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobGetRunbookContentOptionalParams): Promise<JobGetRunbookContentResponse>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
The options parameters.
Returns
Promise<JobGetRunbookContentResponse>
listByAutomationAccount(string, string, JobListByAutomationAccountOptionalParams)
Retrieve a list of jobs.
function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: JobListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<JobCollectionItem, JobCollectionItem[], PageSettings>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
The options parameters.
Returns
resume(string, string, string, JobResumeOptionalParams)
Resume the job identified by jobName.
function resume(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobResumeOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
- options
- JobResumeOptionalParams
The options parameters.
Returns
Promise<void>
stop(string, string, string, JobStopOptionalParams)
Stop the job identified by jobName.
function stop(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
- options
- JobStopOptionalParams
The options parameters.
Returns
Promise<void>
suspend(string, string, string, JobSuspendOptionalParams)
Suspend the job identified by job name.
function suspend(resourceGroupName: string, automationAccountName: string, jobName: string, options?: JobSuspendOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of an Azure Resource group.
- automationAccountName
-
string
The name of the automation account.
- jobName
-
string
The job name.
- options
- JobSuspendOptionalParams
The options parameters.
Returns
Promise<void>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for