Skip to content

Commit 0865a20

Browse files
authored
Merge pull request #211856 from stevenmatthew/jobDef
Update: job-definition - added Portal procedure
2 parents ff3a37d + b4dbc1a commit 0865a20

14 files changed

+78
-6
lines changed

articles/storage-mover/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ items:
3232
href: agent-register.md
3333
- name: Manage projects
3434
href: project-manage.md
35+
- name: Create job definitions
36+
href: job-definition-create.md
3537
- name: Decommission
3638
items:
3739
- name: Unregister an agent

articles/storage-mover/job-definition-create.md

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: stevenmatthew
55
ms.author: shaas
66
ms.service: storage-mover
77
ms.topic: how-to
8-
ms.date: 09/14/2022
8+
ms.date: 09/20/2022
99
---
1010

1111
<!--
@@ -18,7 +18,7 @@ REVIEW Stephen/Fabian: Reviewed - Stephen
1818
REVIEW Engineering: not reviewed
1919
EDIT PASS: started
2020
21-
Initial doc score: 100 (413 words and 0 issues)
21+
Initial doc score: 100 (1532 words and 0 issues)
2222
2323
!########################################################
2424
-->
@@ -42,9 +42,77 @@ There are three prerequisites to the definition the migration of your source sha
4242

4343
## Create and start a job definition
4444

45-
A job definition is created within a project resource. If you've followed the examples contained in previous articles, you may have an existing project within a previously deployed storage mover resource.
45+
A job definition is created within a project resource. Creating a job definition requires you to select or configure a project, a source and target storage endpoint, and a job name. If you've followed the examples contained in previous articles, you may have an existing project within a previously deployed storage mover resource. Follow the steps below to add a job definition to a project.
4646

47-
Creating a job definition requires you to decide on a project, a source storage endpoint, a target storage endpoint, and a name. Refer to the [resource naming convention](../azure-resource-manager/management/resource-name-rules.md#microsoftstoragesync) to choose a supported name. Storage endpoints are separate resources in your storage mover and must be created first, before you can create a job definition that only references them.
47+
Storage endpoints are separate resources in your storage mover. Endpoints must be created before they can be referenced by a job definition.
48+
49+
Refer to the [resource naming convention](../azure-resource-manager/management/resource-name-rules.md#microsoftstoragesync) for help with choosing supported resource names.
50+
51+
### [Azure portal](#tab/portal)
52+
53+
1. Navigate to the **Project explorer** page within the [Azure portal](https://portal.azure.com) to view a list of available projects. If no projects exist, or you need to create a new project, you can follow the steps included in the [Manage Azure Storage Mover projects](project-manage.md) article.
54+
55+
:::image type="content" source="media/job-definition-create/project-explorer-sml.png" alt-text="Screen capture of the Project Explorer's Overview tab within the Azure portal." lightbox="media/job-definition-create/project-explorer-lrg.png":::
56+
57+
From within the project explorer pane or the results list, select the name of an available project. The project's properties and job summary data are displayed in the **details** pane. Any existing job definitions defined for the project will also be displayed. The status of any deployed jobs will also be shown.
58+
59+
In the actions menu within the project's details pane, select **Create job definition** to open the **Create a migration job** window. If no job definitions exist within the project, you can also select **Create a job definition** near the bottom of the pane, as shown in the example below.
60+
61+
:::image type="content" source="media/job-definition-create/project-selected-sml.png" alt-text="Screen capture of the Project Explorer's Overview tab within the Azure portal highlighting the use of filters." lightbox="media/job-definition-create/project-selected-lrg.png":::
62+
63+
1. In the **Basics** tab of the **Create a migration job** window, enter a value in the required **Name** field. You may also add an optional description value of less than 1024 characters. Finally, in the **Migration agent** section, select the agent to perform the data migration and then select **Next** to open the **Source** tab. You should choose an agent located as near your data source as possible. The selected agent should also have resources appropriate to the size and complexity of the job. You can assign a different agent to your job at a later time if desired.
64+
65+
:::image type="content" source="media/job-definition-create/tab-basics-sml.png" alt-text="Screen capture of the migration job's Basics tab, showing the location of the data fields." lightbox="media/job-definition-create/tab-basics-lrg.png":::
66+
67+
1. In the **Source** tab, select an option within the **Source endpoint** field.
68+
69+
If you want to use a source endpoint you've previously defined, choose the **Select an existing endpoint** option. Next, select the **Select an existing endpoint as a source** link to open the source endpoint pane. This pane displays a detailed list of your previously defined endpoints. Select the appropriate endpoint and select **Select** to return to the **Source** tab and populate the **Existing source endpoint** field.
70+
71+
:::image type="content" source="media/job-definition-create/endpoint-source-existing-sml.png" alt-text="Screen capture of the Source tab illustrating the location of the Existing Source Endpoint field." border="false" lightbox="media/job-definition-create/endpoint-source-existing-lrg.png":::
72+
73+
To define a new source endpoint from which to migrate, select the **Create a new endpoint** option. Next, provide values for the required **Host name or IP**, **Share name**, and **Protocol version** fields. You may also add an optional description value of less than 1024 characters.
74+
75+
:::image type="content" source="media/job-definition-create/endpoint-source-new-sml.png" alt-text="Screen capture of the Source tab illustrating the location of the New Source Endpoint fields." lightbox="media/job-definition-create/endpoint-source-new-lrg.png":::
76+
77+
By default, migration jobs will start from the root of your share. However, if your use case involves copying data from a specific path within your source share, you can provide the path in the **Sub-path** field. Supplying this value will start the data migration from the location you've specified. If the sub path you've specified isn't found, no data will be copied.
78+
79+
Prior to creating an endpoint and a job resource, it's important to verify that the path you've provided is correct and that the data is accessible. You're unable to modify endpoints or job resources after they're created. If the specified path is wrong, you'll need to delete the resources and re-create them.
80+
81+
Values for host, share name, and subpath are concatenated to form the full migration source path. The path is displayed in the **Full path** field within the **Verify full path** section. Copy the path provided and verify that you're able to access it before committing your changes.
82+
83+
After you've confirmed that the share is accessible, select **Next** to save your source endpoint settings and begin defining your target.
84+
85+
1. In the **Target** tab, select an option for the **Target endpoint** field.
86+
87+
As with the source endpoint, choose the **Select an existing endpoint reference** option if you want to use a previously defined endpoint. Next, select the **Select an existing endpoint as a target** link to open the target endpoint pane. A detailed list of your previously defined endpoints is displayed. First, select the desired endpoint, then **Select** to populate the **Existing source endpoint** field and return to the **Source** tab.
88+
89+
:::image type="content" source="media/job-definition-create/endpoint-target-existing-sml.png" alt-text="Screen capture of the Target tab illustrating the location of the Existing Target Endpoint field." border="false" lightbox="media/job-definition-create/endpoint-target-existing-lrg.png":::
90+
91+
Similarly, to define a new target endpoint, choose the **Create a new endpoint** option. Next, select values from the drop-down lists for the required **Subscription**, **Storage account**, and **Container** fields. You may also add an optional description value of less than 1024 characters.
92+
93+
:::image type="content" source="media/job-definition-create/endpoint-target-new-sml.png" alt-text="Screen capture of the Target tab illustrating the location of the New Target Endpoint fields." lightbox="media/job-definition-create/endpoint-target-new-lrg.png":::
94+
95+
A target subpath value can be used to specify a location within the target container where your migrated data will be copied. The subpath value is relative to the container's root. Omitting the subpath value will result in the data being copied to the root, while providing a unique value will generate a new subfolder.
96+
97+
After ensuring the accuracy of your settings, select **Next** to continue.
98+
99+
1. Within the **Settings** tab, take note of the settings associated with the **Copy mode** and **Migration outcomes**. The service's **copy mode** will affect the behavior of the migration engine when files or folders change between copy iterations.
100+
101+
The current release of Azure Storage Mover only supports **merge** mode.
102+
103+
- Files will be kept in the target, even if they don’t exist in the source.
104+
- Files with matching names and paths will be updated to match the source.
105+
- Folder renames between copies may lead to duplicate content in the target.
106+
107+
**Migration outcomes** are based upon the specific storage types of the source and target endpoints. For example, because blob storage only supports "virtual" folders, source files in folders will have their paths prepended to their names and placed in a flat list within a blob container. Empty folders will be represented as an empty blob in the target. Source folder metadata will be persisted in the custom metadata field of a blob, as they are with files.
108+
109+
After viewing the effects of the copy mode and migration outcomes, select **Next** to review the values from the previous tabs.
110+
111+
1. Review the settings for job name and description, and source and target storage endpoint settings. Use the **Previous** and **Next** options to navigate through the tabs and correct any mistakes, if needed. Finally, select **Create** to provision the job definition.
112+
113+
:::image type="content" source="media/job-definition-create/review-sml.png" alt-text="Screen capture of the Review tab illustrating the location of the fields and settings." lightbox="media/job-definition-create/review-lrg.png":::
114+
115+
### [PowerShell](#tab/powershell)
48116

49117
You'll need to use several cmdlets to create a new job definition.
50118

@@ -122,8 +190,10 @@ Start-AzStorageMoverJobDefinition `
122190
123191
```
124192

193+
---
194+
125195
## Next steps
126196

127-
Advance to the next article to learn how to create...
197+
Now that you've created a job definition with source and target endpoints, learn how to estimate the time required to perform your migration job. Learn about Azure Storage Mover performance targets by visiting the article suggested below.
128198
> [!div class="nextstepaction"]
129-
> [Prepare Haushaltswaffeln for Fabian and Stephen](service-overview.md)
199+
> [Azure Storage Mover scale and performance targets](performance-targets.md)
110 KB
Loading
28.7 KB
Loading
94.1 KB
Loading
25.7 KB
Loading
111 KB
Loading
28.5 KB
Loading
115 KB
Loading
30.2 KB
Loading

0 commit comments

Comments
 (0)