Skip to content

Commit 4b22bae

Browse files
⚙️ remove ms.service from global frontmatter (SharePoint#8238)
- missed this entry in a previous commit 393ff42 - update docs to add missing `ms.service` or `ms.prod`, fixing acrolinx warnings - use global settings in docfx.json, set values on specific files otherwise
1 parent 9de8d4d commit 4b22bae

File tree

1,780 files changed

+10788
-18540
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,780 files changed

+10788
-18540
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Application Lifecycle Management (ALM) APIs
33
description: ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant.
4-
ms.date: 06/07/2022
5-
ms.prod: sharepoint
4+
ms.date: 06/28/2022
5+
ms.subservice: migration-tool
66
ms.assetid: fdf7ecb2-8851-425b-b058-3285fba77b68
77
ms.localizationpriority: high
88
---

docs/apis/export-amr-api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: "SharePoint Migration Export (Asynchronous Metadata Read) API"
33
description: This document targets ISVs and any third-party vendors/developers who are developing and maintaining a migration tool.
4-
ms.date: 07/31/2020
4+
ms.date: 06/28/2022
55
ms.author: jhendr
66
author: JoanneHendrickson
77
manager: pamgreen
88
audience: ITPro
9+
ms.subservice: migration-tool
910
ms.topic: article
1011
ms.localizationpriority: high
1112
ms.collection:

docs/apis/migrate-webparts-with-migrationapi.md

Lines changed: 228 additions & 237 deletions
Large diffs are not rendered by default.

docs/apis/migration-api-azure-container-and-queue.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: SPO provided Migration Azure container and queue
3+
description: "One of the Main requirement for using our Migration API is the usage of an Azure container as a temporary storage. We now provide a default container that can be used for using the migration API."
4+
ms.date: 06/28/2022
35
ms.author: jhendr
46
author: JoanneHendrickson
57
manager: pamgreen
6-
ms.date: 04/23/2020
7-
description: "One of the Main requirement for using our Migration API is the usage of an Azure container as a temporary storage. We now provide a default container that can be used for using the migration API."
8+
ms.subservice: migration-tool
89
ms.localizationpriority: medium
910
---
10-
1111
# SPO provided Migration Azure container and queue
1212

1313
Microsoft’s Migration API requires the use of an Azure container for temporary storage. To simplify the process, you are now provided with a default container while using the migration API. If you choose, you can still provide your own Azure container.
@@ -18,13 +18,13 @@ For the Migration API to accept a Migration Job coming from a SPO provided Azure
1818

1919
## Advantages
2020

21-
|Advantage|Description|
22-
|:-----|:-----|
23-
|Cost of Azure container goes to SPO|Since we are providing the containers, those containers are now part of the basic SharePoint online Offering. Every tenant who signs up for SharePoint Online will get this for free).|
24-
|Containers and queues are unique per request and not reused|Once a container is given to a customer this container will not be reused or shared.|
25-
|Containers and queue are automatically deleted|As per the standard SharePoint Online Compliance, we will destroy the container within 30 to 90 days automatically.|
26-
|Containers and queues are in the customer’s datacenter ___location|We make sure to provision containers that are in the same physical ___location than their SharePoint online tenant.|
27-
|They are obtainable programmatically|There is no need to interact with Azure unless the user chooses.
21+
| Advantage | Description |
22+
| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23+
| Cost of Azure container goes to SPO | Since we are providing the containers, those containers are now part of the basic SharePoint online Offering. Every tenant who signs up for SharePoint Online will get this for free). |
24+
| Containers and queues are unique per request and not reused | Once a container is given to a customer this container will not be reused or shared. |
25+
| Containers and queue are automatically deleted | As per the standard SharePoint Online Compliance, we will destroy the container within 30 to 90 days automatically. |
26+
| Containers and queues are in the customer’s datacenter ___location | We make sure to provision containers that are in the same physical ___location than their SharePoint online tenant. |
27+
| They are obtainable programmatically | There is no need to interact with Azure unless the user chooses. |
2828

2929
## How to use it
3030

@@ -34,16 +34,16 @@ For the Migration API to accept a Migration Job coming from a SPO provided Azure
3434
public SPProvisionedMigrationContainersInfo ProvisionMigrationContainers()
3535
```
3636

37-
The call will return an object that contains two strings containing two SAS tokens for accessing the two required containers and a byte array for the AES256CBC encryption.
37+
The call will return an object that contains two strings containing two SAS tokens for accessing the two required containers and a byte array for the AES256CBC encryption.
3838

3939
This key will need to be used when encrypting the data. We forget the key once we give it out, therefore you must keep it to pass it again for the Submit Migration Job call.
4040

4141
```csharp
42-
Uri DataContainerUri
42+
Uri DataContainerUri
4343

4444
Uri MetadataContainer Uri
4545

46-
byte[] EncryptionKey
46+
byte[] EncryptionKey
4747
```
4848

4949
### Getting Queue
@@ -66,10 +66,9 @@ Once those calls have been made, the rest of the flow remains the same for using
6666

6767
### Required endpoints for goverment cloud
6868

69-
If your tenant is hosted in a government cloud (GCC), you must have the proper endpoints set when calling the API.
70-
*Example:* usgovcloudapi.net
69+
If your tenant is hosted in a government cloud (GCC), you must have the proper endpoints set when calling the API. For example: `usgovcloudapi.net`.
7170

72-
|**Required Endpoint**|**Why**|
73-
|:-----|:-----|
74-
|https://<span>*.blob.core.usgovcloudapi.</span>net|Migration API Azure Government requirement|
75-
|https://<span>*.queue.core.usgovcloudapi.</span>net|Migration API Azure Government requirement|
71+
| **Required Endpoint** | **Why** |
72+
| :--------------------------------------- | :----------------------------------------- |
73+
| `https://*.blob.core.usgovcloudapi.net` | Migration API Azure Government requirement |
74+
| `https://*.queue.core.usgovcloudapi.net` | Migration API Azure Government requirement |

docs/apis/migration-api-encryption.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
title: OneDrive for Business and SharePoint Online Migration API – Encryption
3+
description: "How to pass encrypted content at rest to the API securely."
4+
ms.date: 6/20/2022
35
ms.author: jhendr
46
author: JoanneHendrickson
57
manager: pamgreen
6-
ms.date: 6/20/2018
7-
description: "How to pass encrypted content at rest to the API securely."
8+
ms.subservice: migration-tool
89
ms.localizationpriority: medium
910
---
1011

@@ -20,18 +21,19 @@ Content
2021

2122
- Files
2223
- Manifest
23-
- Metadata
24-
- Permissions
25-
- List items
26-
- Taxonomy
27-
- Logs (created by SharePoint Online to report back on the migration results)
24+
- Metadata
25+
- Permissions
26+
- List items
27+
- Taxonomy
28+
- Logs (created by SharePoint Online to report back on the migration results)
2829
- Queue
29-
- Real time reportig on the progress
30+
- Real time reportig on the progress
3031

3132
## What is the encryption feature?
3233

33-
When using the encryption parameter, everything listed above will be encrypted at rest and the key will need to be preserved in order to read the logs and the real time progress.
34-
The main benefits is making the content useless for a malicious user who would manage to breach into the Azure container.
34+
When using the encryption parameter, everything listed above will be encrypted at rest and the key will need to be preserved in order to read the logs and the real time progress.
35+
36+
The main benefits is making the content useless for a malicious user who would manage to breach into the Azure container.
3537

3638
This comes with a small cost of performance. This feature is optional when using the API and it is recommended to only use it for the most confidential information since it does reduce the speed of the migration by a small portion. Microsoft destroys the key once the migration job is finished and there is no way to recover the key if lost, not even from support.
3739

@@ -58,10 +60,10 @@ Example:
5860

5961
## Extra requirement
6062

61-
For the encryption, each file must be encrypted and have an IV assigned to it. The encryption method should follow the AES CBC 256 Standard. A unique, cryptographically-random IV must be generated for every file including the manifests in the package and should be stored as a property on each files. Use the AesCryptoServiceProvider.GenerateIV method to generate a unique random IV for each file.
63+
For the encryption, each file must be encrypted and have an IV assigned to it. The encryption method should follow the AES CBC 256 Standard. A unique, cryptographically-random IV must be generated for every file including the manifests in the package and should be stored as a property on each files. Use the AesCryptoServiceProvider.GenerateIV method to generate a unique random IV for each file.
6264

63-
- Name = [IV]
64-
- Value = [Base64encoded byte array of the IV]
65+
- **Name**: [IV]
66+
- **Value**: [Base64encoded byte array of the IV]
6567

6668
## Reading the queue when encrypted
6769

@@ -72,13 +74,13 @@ It is important to remember the Job ID. Without the specific key used for the jo
7274
Here is the JSON content in the queue message
7375

7476
```json
75-
{"Label", "Encrypted"},
76-
{"JobId", "[JobId value]"},
77-
{"IV", "[IV value in base64format]"},
78-
{"Content", "[encrypted message in base64string]"}
77+
{"Label": "Encrypted"},
78+
{"JobId": "[JobId value]"},
79+
{"IV": "[IV value in base64format]"},
80+
{"Content": "[encrypted message in base64string]"}
7981
```
8082

8183
Once the messages are decrypted, they will be the same as the API without encryption.
8284

83-
>[!NOTE]
84-
>The **Migration** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data ___location is not in the German data center.
85+
> [!NOTE]
86+
> The **Migration** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data ___location is not in the German data center.

0 commit comments

Comments
 (0)