Skip to content

Commit 239a705

Browse files
authored
Merge branch 'master' into patch-1
2 parents f45c1dd + cb99e97 commit 239a705

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDataEncryptionPolicy.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.reviewer:
1414

1515
## SYNOPSIS
1616

17-
.
17+
Validates the encryption of a Group Site, Team Site, or OneDrive for Business site if a Customer Key has been registered for the site.
1818

1919
## SYNTAX
2020

@@ -24,7 +24,9 @@ Get-SPOSiteDataEncryptionPolicy [-Identity] <SpoSitePipeBind> [<CommonParameters
2424

2525
## DESCRIPTION
2626

27-
.
27+
When a Customer Key has been configured in the Azure tenant, it is possible to set and subsequently verify the encryption status of a SharePoint Online or OneDrive for Business site. This cmdlet verifies the encryption status of the particular site.
28+
29+
This cmdlet will return an error if the Azure tenant has not been configured with a Customer Key. See the Related Links section for more information on how to configure the Customer Key.
2830

2931
## EXAMPLES
3032

@@ -34,13 +36,13 @@ Get-SPOSiteDataEncryptionPolicy [-Identity] <SpoSitePipeBind> [<CommonParameters
3436
Get-SPOSiteDataEncryptionPolicy https://contoso.sharepoint.com/sites/Research
3537
```
3638

37-
.
39+
Verifies the encryption of the site https://contoso.sharepoint.com/sites/Research.
3840

3941
## PARAMETERS
4042

4143
### -Identity
4244

43-
.
45+
The URL of the Site Collection.
4446

4547
```yaml
4648
Type: SpoSitePipeBind
@@ -58,4 +60,28 @@ Accept wildcard characters: False
5860
5961
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
6062
61-
## NOTES
63+
## OUTPUTS
64+
### System.String
65+
66+
The URI of the primary key.
67+
68+
### System.String
69+
70+
The URI of the secondary key.
71+
72+
### System.Object
73+
74+
The encryption status for the geo. Possible states include:
75+
76+
* Unregistered: Customer Key encryption has not yet been applied.
77+
* Registering: Customer Key encryption has been applied and your files are in the process of being encrypted. If your geo is in this state, you'll also be shown information on what percentage of sites in the geo are complete so that you can monitor encryption progress.
78+
* Registered: Customer Key encryption has been applied, and all files in all sites have been encrypted.
79+
* Rolling: A key roll is in progress. If your geo is in this state, you'll also be shown information on what percentage of sites have completed the key roll operation so that you can monitor progress.
80+
81+
## RELATED LINKS
82+
83+
[Register-SPODataEncryptionPolicy](https://docs.microsoft.com/powershell/module/sharepoint-online/register-spodataencryptionpolicy)
84+
85+
[Controlling your data in Office 365 using Customer Key](https://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key)
86+
87+
[Office 365: Setting up Customer Key for SharePoint Online and OneDrive for Business](https://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key#office-365-setting-up-customer-key-for-sharepoint-online-and-onedrive-for-business)

0 commit comments

Comments
 (0)