JobDefinitionsOperations interface
Interface representing a JobDefinitions operations.
Properties
| create |
Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. |
| delete | |
| get | Gets a Job Definition resource. |
| list | Lists all Job Definitions in a Project. |
| start |
Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution. |
| stop |
Requests the Agent of any active instance of this Job Definition to stop. |
| update | Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged. |
Property Details
createOrUpdate
Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
createOrUpdate: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinition, options?: JobDefinitionsCreateOrUpdateOptionalParams) => Promise<JobDefinition>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinition, options?: JobDefinitionsCreateOrUpdateOptionalParams) => Promise<JobDefinition>
delete
delete: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>
get
Gets a Job Definition resource.
get: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsGetOptionalParams) => Promise<JobDefinition>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsGetOptionalParams) => Promise<JobDefinition>
list
Lists all Job Definitions in a Project.
list: (resourceGroupName: string, storageMoverName: string, projectName: string, options?: JobDefinitionsListOptionalParams) => PagedAsyncIterableIterator<JobDefinition, JobDefinition[], PageSettings>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, options?: JobDefinitionsListOptionalParams) => PagedAsyncIterableIterator<JobDefinition, JobDefinition[], PageSettings>
startJob
Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
startJob: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStartJobOptionalParams) => Promise<JobRunResourceId>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStartJobOptionalParams) => Promise<JobRunResourceId>
stopJob
Requests the Agent of any active instance of this Job Definition to stop.
stopJob: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStopJobOptionalParams) => Promise<JobRunResourceId>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsStopJobOptionalParams) => Promise<JobRunResourceId>
update
Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
update: (resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinitionUpdateParameters, options?: JobDefinitionsUpdateOptionalParams) => Promise<JobDefinition>Property Value
(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, jobDefinition: JobDefinitionUpdateParameters, options?: JobDefinitionsUpdateOptionalParams) => Promise<JobDefinition>