JobDefinitions interface
Interface representing a JobDefinitions.
Methods
Method Details
beginDelete(string, string, string, string, JobDefinitionsDeleteOptionalParams)
Deletes a Job Definition resource.
function beginDelete(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, JobDefinitionsDeleteOptionalParams)
Deletes a Job Definition resource.
function beginDeleteAndWait(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, string, string, JobDefinition, JobDefinitionsCreateOrUpdateOptionalParams)
Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
function createOrUpdate(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinition, options?: JobDefinitionsCreateOrUpdateOptionalParams): Promise<JobDefinition>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
- jobDefinition
- JobDefinition
The Job Definition resource.
The options parameters.
Returns
Promise<JobDefinition>
get(string, string, string, string, JobDefinitionsGetOptionalParams)
Gets a Job Definition resource.
function get(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsGetOptionalParams): Promise<JobDefinition>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
- options
- JobDefinitionsGetOptionalParams
The options parameters.
Returns
Promise<JobDefinition>
list(string, string, string, JobDefinitionsListOptionalParams)
Lists all Job Definitions in a Project.
function list(resourceGroupName: string, storageMoverName: string, projectName: string, options?: JobDefinitionsListOptionalParams): PagedAsyncIterableIterator<JobDefinition, JobDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- options
- JobDefinitionsListOptionalParams
The options parameters.
Returns
startJob(string, string, string, string, JobDefinitionsStartJobOptionalParams)
Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
function startJob(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStartJobOptionalParams): Promise<JobRunResourceId>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
The options parameters.
Returns
Promise<JobRunResourceId>
stopJob(string, string, string, string, JobDefinitionsStopJobOptionalParams)
Requests the Agent of any active instance of this Job Definition to stop.
function stopJob(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStopJobOptionalParams): Promise<JobRunResourceId>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
The options parameters.
Returns
Promise<JobRunResourceId>
update(string, string, string, string, JobDefinitionUpdateParameters, JobDefinitionsUpdateOptionalParams)
Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
function update(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinitionUpdateParameters, options?: JobDefinitionsUpdateOptionalParams): Promise<JobDefinition>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- projectName
-
string
The name of the Project resource.
- jobDefinitionName
-
string
The name of the Job Definition resource.
- jobDefinition
- JobDefinitionUpdateParameters
The Job Definition resource.
The options parameters.
Returns
Promise<JobDefinition>