JobSteps interface
Interface representing a JobSteps.
Methods
| create |
Creates or updates a job step. This will implicitly create a new job version. |
| delete(string, string, string, string, string, Job |
Deletes a job step. This will implicitly create a new job version. |
| get(string, string, string, string, string, Job |
Gets a job step in a job's current version. |
| get |
Gets the specified version of a job step. |
| list |
Gets all job steps for a job's current version. |
| list |
Gets all job steps in the specified job version. |
Method Details
createOrUpdate(string, string, string, string, string, JobStep, JobStepsCreateOrUpdateOptionalParams)
Creates or updates a job step. This will implicitly create a new job version.
function createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, parameters: JobStep, options?: JobStepsCreateOrUpdateOptionalParams): Promise<JobStep>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job.
- stepName
-
string
The name of the job step.
- parameters
- JobStep
The requested state of the job step.
The options parameters.
Returns
Promise<JobStep>
delete(string, string, string, string, string, JobStepsDeleteOptionalParams)
Deletes a job step. This will implicitly create a new job version.
function delete(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, options?: JobStepsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job.
- stepName
-
string
The name of the job step to delete.
- options
- JobStepsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, JobStepsGetOptionalParams)
Gets a job step in a job's current version.
function get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, options?: JobStepsGetOptionalParams): Promise<JobStep>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job.
- stepName
-
string
The name of the job step.
- options
- JobStepsGetOptionalParams
The options parameters.
Returns
Promise<JobStep>
getByVersion(string, string, string, string, number, string, JobStepsGetByVersionOptionalParams)
Gets the specified version of a job step.
function getByVersion(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobVersion: number, stepName: string, options?: JobStepsGetByVersionOptionalParams): Promise<JobStep>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job.
- jobVersion
-
number
The version of the job to get.
- stepName
-
string
The name of the job step.
The options parameters.
Returns
Promise<JobStep>
listByJob(string, string, string, string, JobStepsListByJobOptionalParams)
Gets all job steps for a job's current version.
function listByJob(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobStepsListByJobOptionalParams): PagedAsyncIterableIterator<JobStep, JobStep[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job to get.
- options
- JobStepsListByJobOptionalParams
The options parameters.
Returns
listByVersion(string, string, string, string, number, JobStepsListByVersionOptionalParams)
Gets all job steps in the specified job version.
function listByVersion(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobVersion: number, options?: JobStepsListByVersionOptionalParams): PagedAsyncIterableIterator<JobStep, JobStep[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- jobAgentName
-
string
The name of the job agent.
- jobName
-
string
The name of the job to get.
- jobVersion
-
number
The version of the job to get.
The options parameters.