New-AzStorageMoverJobDefinition
Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
Syntax
New-AzStorageMoverJobDefinition
-Name <String>
-ProjectName <String>
-ResourceGroupName <String>
-StorageMoverName <String>
[-SubscriptionId <String>]
-CopyMode <CopyMode>
-SourceName <String>
-TargetName <String>
[-AgentName <String>]
[-Description <String>]
[-SourceSubpath <String>]
[-TargetSubpath <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzStorageMoverJobDefinition
-Name <String>
-ProjectName <String>
-ResourceGroupName <String>
-StorageMoverName <String>
[-SubscriptionId <String>]
-JobDefinition <IJobDefinition>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
Examples
Example 1: Create a job definition
New-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -AgentName myAgent -SourceName myNfsEndpoint -TargetName myContainerEndpoint -CopyMode "Additive" -Description "job definition"
AgentName : myAgent
AgentResourceId :
CopyMode : Additive
Description : job definition
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageM
overs/myStorageMover/projects/myProject/jobDefinitions/myJob
LatestJobRunName :
LatestJobRunResourceId :
LatestJobRunStatus :
Name : myJob
ProvisioningState : Succeeded
SourceName : myNfsEndpoint
SourceResourceId :
SourceSubpath :
SystemDataCreatedAt : 7/26/2022 6:14:43 AM
SystemDataCreatedBy : xxxxxxxxxxxxxxxxxxxx
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 7/26/2022 6:14:43 AM
SystemDataLastModifiedBy : xxxxxxxxxxxxxxxxxxxx
SystemDataLastModifiedByType : User
TargetName : myContainerEndpoint
TargetResourceId :
TargetSubpath :
Type : microsoft.storagemover/storagemovers/projects/jobdefinitionsThis command creates a job definition.
Parameters
-AgentName
Name of the Agent to assign for new Job Runs of this Job Definition.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CopyMode
Strategy to use for copy.
| Type: | CopyMode |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
A description for the Job Definition.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobDefinition
The Job Definition resource. To construct, see NOTES section for JOBDEFINITION properties and create a hash table.
| Type: | IJobDefinition |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the Job Definition resource.
| Type: | String |
| Aliases: | JobDefinitionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectName
The name of the Project resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceName
The name of the source Endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceSubpath
The subpath to use when reading from the source Endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageMoverName
The name of the Storage Mover resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetName
The name of the target Endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetSubpath
The subpath to use when writing to the target Endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |