Skip to content

Commit ceeb31b

Browse files
chrisdachrisda
committed
Created
1 parent dff5844 commit ceeb31b

6 files changed

+463
-0
lines changed

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

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
external help file:
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxextendedproperty
4+
applicable: Exchange Online
5+
title: Get-MailboxExtendedProperty
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-MailboxExtendedProperty
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-MailboxExtendedProperty cmdlet to view extended mailbox properties in cloud-based mailboxes.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-MailboxExtendedProperty [[-Identity] <MailboxExtendedPropertyId>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
Get-MailboxExtendedProperty -Identity [email protected]
35+
```
36+
37+
This example returns all extended mailbox properties in the specified mailbox.
38+
39+
### Example 1
40+
```powershell
41+
Get-MailboxExtendedProperty -Identity 665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\OfficeGraphSharingActivityUserOptoutModifiedDate
42+
```
43+
44+
This example uses the output of the first example to return information about the OfficeGraphSharingActivityUserOptoutModifiedDate extended property in the mailbox.
45+
46+
## PARAMETERS
47+
48+
### -Identity
49+
The Identity parameter specifies the mailbox extended property that you want to view.
50+
51+
To view all available extended properties in a mailbox, specify a unique identifier for the mailbox. For example:
52+
53+
- Name
54+
- Alias
55+
- Distinguished name (DN)
56+
- Email address
57+
- GUID
58+
- User ID or user principal name (UPN)
59+
60+
To view a specific extended property in a mailbox, use the following syntax: `<MailboxLocation>:<PropertyNamespace>\<PropertyName | PropertyId>`:
61+
62+
- \<MailboxLocation\>: The value is available in the MailboxLocation property in the output of the Get-MailboxExtendedProperty cmdlet, is the same for all properties in the mailbox, and uses the syntax `<GUID1>\\<GUID2>`. For example, `665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4`.
63+
- \<PropertyNameSpace\>: The GUID value is available in the PropertyNamespace property in the output of the Get-MailboxExtendedProperty cmdlet. For example `00062008-0000-0000-c000-000000000046`.
64+
- \<PropertyName \| PropertyId\>: The value is available in the PropertyName or PropertyId property in the output of the Get-MailboxExtendedProperty cmdlet. Only PropertyName or PropertyId is available on an extended property (one or the other, not both). For example, `OfficeGraphSharingActivityUserOptoutModifiedDate` or `33324`.
65+
66+
For example:
67+
68+
`665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\OfficeGraphSharingActivityUserOptoutModifiedDate`
69+
70+
`665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\33324`
71+
72+
```yaml
73+
Type: MailboxExtendedPropertyId
74+
Parameter Sets: (All)
75+
Aliases:
76+
Applicable: Exchange Online
77+
78+
Required: False
79+
Position: 0
80+
Default value: None
81+
Accept pipeline input: True (ByPropertyName, ByValue)
82+
Accept wildcard characters: False
83+
```
84+
85+
### CommonParameters
86+
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).
87+
88+
## INPUTS
89+
90+
## OUTPUTS
91+
92+
## NOTES
93+
94+
## RELATED LINKS

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

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
external help file:
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxextendedpropertycleanuprequest
4+
applicable: Exchange Online
5+
title: Get-MailboxExtendedPropertyCleanupRequest
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-MailboxExtendedPropertyCleanupRequest
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-MailboxExtendedPropertyCleanupRequest cmdlet to view extended mailbox property clean-up requests in cloud-based mailboxes.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-MailboxExtendedPropertyCleanupRequest [-Identity] <StoreIntegrityCheckIdParameter> [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
{{ Add example code here }}
35+
```
36+
37+
{{ Add example description here }}
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The Identity parameter specifies the mailbox extended property request that you want to view.
43+
44+
Identity returned by the New-MailboxExtendedPropertyCleanupRequest with the format SOMETHING\SOMETHING\SOMETHING
45+
46+
```yaml
47+
Type: StoreIntegrityCheckIdParameter
48+
Parameter Sets: (All)
49+
Aliases:
50+
Applicable: Exchange Online
51+
52+
Required: True
53+
Position: 0
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### CommonParameters
60+
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).
61+
62+
## INPUTS
63+
64+
## OUTPUTS
65+
66+
## NOTES
67+
68+
## RELATED LINKS

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

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
external help file:
3+
online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxextendedpropertycleanuprequest
4+
applicable: Exchange Online
5+
title: New-MailboxExtendedPropertyCleanupRequest
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# New-MailboxExtendedPropertyCleanupRequest
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the New-MailboxExtendedPropertyCleanupRequest cmdlet to create extended mailbox property clean-up requests in cloud-based mailboxes.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
New-MailboxExtendedPropertyCleanupRequest [[-Identity] <MailboxExtendedPropertyId>] -Properties <String>
25+
[-Confirm]
26+
[-DetectOnly]
27+
[-WhatIf]
28+
[<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
32+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```powershell
38+
{{ Add example code here }}
39+
```
40+
41+
{{ Add example description here }}
42+
43+
## PARAMETERS
44+
45+
### -Identity
46+
The Identity parameter specifies the mailbox extended property request that you want to create.
47+
48+
```yaml
49+
Type: MailboxExtendedPropertyId
50+
Parameter Sets: (All)
51+
Aliases:
52+
Applicable: Exchange Online
53+
54+
Required: False
55+
Position: 0
56+
Default value: None
57+
Accept pipeline input: True (ByPropertyName, ByValue)
58+
Accept wildcard characters: False
59+
```
60+
61+
### -Properties
62+
The Properties parameter specifies the mailbox property to inspect or remove.
63+
64+
You can specify a comma separated list of properties without spaces.
65+
66+
If a named property has a namespace GUID, a string name that doesn't contain `#`, and an integer type, use the following syntax
67+
68+
`s#GUID#Name#Type`
69+
70+
Specify the property type with the corresponding integer value:
71+
72+
- 0: Unspecified
73+
- 1: Null
74+
- 2: Short
75+
- 3: Int16
76+
- 3: Int32
77+
- 4: Float
78+
- 5: Double
79+
- 5: Real64
80+
- 6: Currency
81+
- 7: AppTime
82+
- 10: Error
83+
- 11: Boolean
84+
- 13: Object
85+
- 20: Long
86+
- 20: Int64
87+
- 30: AnsiString
88+
- 30: String8
89+
- 31: String
90+
- 31: Unicode
91+
- 64: SysTime
92+
- 72: Guid
93+
- 258: Binary
94+
- 4098: ShortArray
95+
- 4099: IntArray
96+
- 4100: FloatArray
97+
- 4101: DoubleArray
98+
- 4102: CurrencyArray
99+
- 4103: AppTimeArray
100+
- 4109: ObjectArray
101+
- 4116: LongArray
102+
- 4126: AnsiStringArray
103+
- 4127: StringArray
104+
- 4160: SysTimeArray
105+
- 4168: GuidArray
106+
- 4354: BinaryArray
107+
108+
```yaml
109+
Type: String
110+
Parameter Sets: (All)
111+
Aliases:
112+
Applicable: Exchange Online
113+
114+
Required: True
115+
Position: Named
116+
Default value: None
117+
Accept pipeline input: False
118+
Accept wildcard characters: False
119+
```
120+
121+
### -Confirm
122+
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.
123+
124+
- 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`.
125+
- 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.
126+
127+
```yaml
128+
Type: SwitchParameter
129+
Parameter Sets: (All)
130+
Aliases: cf
131+
Applicable: Exchange Online
132+
133+
Required: False
134+
Position: Named
135+
Default value: None
136+
Accept pipeline input: False
137+
Accept wildcard characters: False
138+
```
139+
140+
### -DetectOnly
141+
When enabled, we just search these properties and report any corruptions found.
142+
143+
When disabled properties are removed from the elements they are found in.
144+
145+
```yaml
146+
Type: SwitchParameter
147+
Parameter Sets: (All)
148+
Aliases:
149+
Applicable: Exchange Online
150+
151+
Required: False
152+
Position: Named
153+
Default value: None
154+
Accept pipeline input: False
155+
Accept wildcard characters: False
156+
```
157+
158+
### -WhatIf
159+
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.
160+
161+
```yaml
162+
Type: SwitchParameter
163+
Parameter Sets: (All)
164+
Aliases: wi
165+
Applicable: Exchange Online
166+
167+
Required: False
168+
Position: Named
169+
Default value: None
170+
Accept pipeline input: False
171+
Accept wildcard characters: False
172+
```
173+
174+
### CommonParameters
175+
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).
176+
177+
## INPUTS
178+
179+
## OUTPUTS
180+
181+
## NOTES
182+
183+
## RELATED LINKS

0 commit comments

Comments
 (0)