Skip to content

Commit 1807686

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#7083 from MicrosoftDocs/DAREP-chrisda
Darep-chrisda to Master
2 parents 79853c1 + 09c2f40 commit 1807686

8 files changed

+856
-0
lines changed

‎exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
external help file: Microsoft.Exchange.WebClient-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy
4+
applicable: Exchange Online
5+
title: Get-M365DataAtRestEncryptionPolicy
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-M365DataAtRestEncryptionPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-M365DataAtRestEncryptionPolicy cmdlet to view existing Microsoft 365 data at rest encryption policies.
18+
19+
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
Get-M365DataAtRestEncryptionPolicy [[-Identity] <DataEncryptionPolicyIdParameter>]
27+
[-Confirm]
28+
[-DomainController <Fqdn>]
29+
[-WhatIf]
30+
[<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
Get-M365DataAtRestEncryptionPolicy
41+
```
42+
43+
This example returns a summary list of all data at rest encryption policies.
44+
45+
### Example 2
46+
```powershell
47+
Get-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" | Format-List
48+
```
49+
50+
This example returns detailed information about the policy named Contoso Corporate.
51+
52+
## PARAMETERS
53+
54+
### -Identity
55+
The Identity parameter specifies the data at rest encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example:
56+
57+
- Name
58+
- Distinguished name (DN)
59+
- GUID
60+
61+
```yaml
62+
Type: DataEncryptionPolicyIdParameter
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: Exchange Online
66+
67+
Required: False
68+
Position: 0
69+
Default value: None
70+
Accept pipeline input: True (ByPropertyName, ByValue)
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Confirm
75+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
76+
77+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
78+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
79+
80+
```yaml
81+
Type: SwitchParameter
82+
Parameter Sets: (All)
83+
Aliases: cf
84+
Applicable: Exchange Online
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -DomainController
94+
This parameter is reserved for internal Microsoft use.
95+
96+
```yaml
97+
Type: Fqdn
98+
Parameter Sets: (All)
99+
Aliases:
100+
Applicable: Exchange Online
101+
102+
Required: False
103+
Position: Named
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -WhatIf
110+
This parameter is reserved for internal Microsoft use.
111+
112+
```yaml
113+
Type: SwitchParameter
114+
Parameter Sets: (All)
115+
Aliases: wi
116+
Applicable: Exchange Online
117+
118+
Required: False
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
### CommonParameters
126+
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).
127+
128+
## INPUTS
129+
130+
###
131+
132+
## OUTPUTS
133+
134+
###
135+
136+
## NOTES
137+
138+
## RELATED LINKS

‎exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
external help file: Microsoft.Exchange.WebClient-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicyassignment
4+
applicable: Exchange Online
5+
title: Get-M365DataAtRestEncryptionPolicyAssignment
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-M365DataAtRestEncryptionPolicyAssignment
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-M365DataAtRestEncryptionPolicyAssignment cmdlet to view existing Microsoft 365 data at rest encryption policy assignments.
18+
19+
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
Get-M365DataAtRestEncryptionPolicyAssignment [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
```powershell
36+
Get-M365DataAtRestEncryptionPolicyAssignment
37+
```
38+
39+
This example returns a summary list of all data at rest encryption policy assignments.
40+
41+
### Example 2
42+
```powershell
43+
Get-M365DataAtRestEncryptionPolicyAssignment | Format-List
44+
```
45+
46+
This example returns detailed information for all data at rest encryption policy assignments.
47+
48+
### CommonParameters
49+
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).
50+
51+
## INPUTS
52+
53+
###
54+
55+
## OUTPUTS
56+
57+
###
58+
59+
## NOTES
60+
61+
## RELATED LINKS

‎exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
---
2+
external help file: Microsoft.Exchange.WebClient-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy
4+
applicable: Exchange Online
5+
title: New-M365DataAtRestEncryptionPolicy
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# New-M365DataAtRestEncryptionPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the New-M365DataAtRestEncryptionPolicy cmdlet to
18+
19+
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
New-M365DataAtRestEncryptionPolicy [-Name] <String> -AzureKeyIDs <MultiValuedProperty>
27+
[-Confirm]
28+
[-Description <String>]
29+
[-DomainController <Fqdn>]
30+
[-Enabled <Boolean>]
31+
[-WhatIf]
32+
[<CommonParameters>]
33+
```
34+
35+
## DESCRIPTION
36+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```powershell
42+
New-M365DataAtRestEncryptionPolicy -Name "US Mailboxes" -AzureKeyIDs "https://contoso.vault.azure.net/keys/key1/",https://contoso.vault.azure.net/keys/key2/" -Description "Root key for mailboxes located in US territories"
43+
```
44+
45+
This example creates a data at rest encryption policy named US Mailboxes with the specified Azure Key Vault keys and description.
46+
47+
## PARAMETERS
48+
49+
### -Name
50+
The Name parameter specifies a unique name for the data at rest encryption policy. If the value contains spaces, enclose the value in quotation marks (").
51+
52+
```yaml
53+
Type: String
54+
Parameter Sets: (All)
55+
Aliases:
56+
Applicable: Exchange Online
57+
58+
Required: True
59+
Position: 0
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -AzureKeyIDs
66+
The AzureKeyIDs parameter specifies the URL of the encryption key in the Azure Key Vault that's used for encryption. For example, `https://contoso.vault.azure.net/keys/key1/`.
67+
68+
You can specify multiple values separated by commas using the following syntax: `"AzureKeyID1","AzureKeyID2",..."AzureKeyIDN"`.
69+
70+
```yaml
71+
Type: MultiValuedProperty
72+
Parameter Sets: (All)
73+
Aliases:
74+
Applicable: Exchange Online
75+
76+
Required: True
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### -Confirm
84+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
85+
86+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
87+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
88+
89+
```yaml
90+
Type: SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases: cf
93+
Applicable: Exchange Online
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -Description
103+
The Description parameter specifies an optional description for the policy.
104+
105+
```yaml
106+
Type: String
107+
Parameter Sets: (All)
108+
Aliases:
109+
Applicable: Exchange Online
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### -DomainController
119+
This parameter is reserved for internal Microsoft use.
120+
121+
```yaml
122+
Type: Fqdn
123+
Parameter Sets: (All)
124+
Aliases:
125+
Applicable: Exchange Online
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### -Enabled
135+
The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are:
136+
137+
- $true: The policy is enabled. This is the default value.
138+
- $false: The policy is disabled.
139+
140+
```yaml
141+
Type: Boolean
142+
Parameter Sets: (All)
143+
Aliases:
144+
Applicable: Exchange Online
145+
146+
Required: False
147+
Position: Named
148+
Default value: None
149+
Accept pipeline input: False
150+
Accept wildcard characters: False
151+
```
152+
153+
### -WhatIf
154+
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
155+
156+
```yaml
157+
Type: SwitchParameter
158+
Parameter Sets: (All)
159+
Aliases: wi
160+
Applicable: Exchange Online
161+
162+
Required: False
163+
Position: Named
164+
Default value: None
165+
Accept pipeline input: False
166+
Accept wildcard characters: False
167+
```
168+
169+
### CommonParameters
170+
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).
171+
172+
## INPUTS
173+
174+
###
175+
176+
## OUTPUTS
177+
178+
###
179+
180+
## NOTES
181+
182+
## RELATED LINKS

0 commit comments

Comments
 (0)