diff --git a/exchange/exchange-ps/exchange/Get-MailboxExtendedProperty.md b/exchange/exchange-ps/exchange/Get-MailboxExtendedProperty.md new file mode 100644 index 0000000000..7de6f13005 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxExtendedProperty.md @@ -0,0 +1,96 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxextendedproperty +applicable: Exchange Online +title: Get-MailboxExtendedProperty +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxExtendedProperty + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailboxExtendedProperty cmdlet to view extended mailbox properties in cloud-based mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxExtendedProperty [[-Identity] ] [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxExtendedProperty -Identity chris@contoso.onmicrosoft.com +``` + +This example returns all extended mailbox properties in the specified mailbox. + +### Example 1 +```powershell +Get-MailboxExtendedProperty -Identity 665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\OfficeGraphSharingActivityUserOptoutModifiedDate +``` + +This example uses the output of the first example to return information about the OfficeGraphSharingActivityUserOptoutModifiedDate extended property in the mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox extended property that you want to view. + +To view all available extended properties in a mailbox, specify a unique identifier for the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- GUID +- User ID or user principal name (UPN) + +To view a specific extended property in a mailbox, use the following syntax: `:\`: + +- \: 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 `\\`. For example, `665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4`. +- \: The GUID value is available in the PropertyNamespace property in the output of the Get-MailboxExtendedProperty cmdlet. For example `00062008-0000-0000-c000-000000000046`. +- \: 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`. In the output of the Identity property, the PropertyId value is shown in hexadecimal. For example, the PropertyId value 33324 is shown as 0x822c in the Identity property. + +For example: + +`665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\OfficeGraphSharingActivityUserOptoutModifiedDate` + +`665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\33324` + +`665ea11f-b2af-5751-b04c-9848e903ce47\fb59ba52-663f-4d02-9b34-2e733c53fbd4:00062008-0000-0000-c000-000000000046\0x822c` + +```yaml +Type: MailboxExtendedPropertyId +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxExtendedPropertyCleanupRequest.md b/exchange/exchange-ps/exchange/Get-MailboxExtendedPropertyCleanupRequest.md new file mode 100644 index 0000000000..0ce02563c7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxExtendedPropertyCleanupRequest.md @@ -0,0 +1,68 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxextendedpropertycleanuprequest +applicable: Exchange Online +title: Get-MailboxExtendedPropertyCleanupRequest +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxExtendedPropertyCleanupRequest + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailboxExtendedPropertyCleanupRequest cmdlet to view extended mailbox property clean-up requests in cloud-based mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxExtendedPropertyCleanupRequest [-Identity] [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox extended property clean-up request that you want to view. + +Identity returned by the New-MailboxExtendedPropertyCleanupRequest with the format SOMETHING\SOMETHING\SOMETHING + +```yaml +Type: StoreIntegrityCheckIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MailboxExtendedPropertyCleanupRequest.md b/exchange/exchange-ps/exchange/New-MailboxExtendedPropertyCleanupRequest.md new file mode 100644 index 0000000000..8e708707c7 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxExtendedPropertyCleanupRequest.md @@ -0,0 +1,183 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxextendedpropertycleanuprequest +applicable: Exchange Online +title: New-MailboxExtendedPropertyCleanupRequest +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-MailboxExtendedPropertyCleanupRequest + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-MailboxExtendedPropertyCleanupRequest cmdlet to create extended mailbox property clean-up requests in cloud-based mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MailboxExtendedPropertyCleanupRequest [[-Identity] ] -Properties + [-Confirm] + [-DetectOnly] + [-WhatIf] + [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox extended property that you want to create a clean-up request for. + +```yaml +Type: MailboxExtendedPropertyId +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Properties +The Properties parameter specifies the mailbox property to inspect or remove. + +You can specify a comma separated list of properties without spaces. + +If a named property has a namespace GUID, a string name that doesn't contain `#`, and an integer type, use the following syntax + +`s#GUID#Name#Type` + +Specify the property type with the corresponding integer value: + +- 0: Unspecified +- 1: Null +- 2: Short +- 3: Int16 +- 3: Int32 +- 4: Float +- 5: Double +- 5: Real64 +- 6: Currency +- 7: AppTime +- 10: Error +- 11: Boolean +- 13: Object +- 20: Long +- 20: Int64 +- 30: AnsiString +- 30: String8 +- 31: String +- 31: Unicode +- 64: SysTime +- 72: Guid +- 258: Binary +- 4098: ShortArray +- 4099: IntArray +- 4100: FloatArray +- 4101: DoubleArray +- 4102: CurrencyArray +- 4103: AppTimeArray +- 4109: ObjectArray +- 4116: LongArray +- 4126: AnsiStringArray +- 4127: StringArray +- 4160: SysTimeArray +- 4168: GuidArray +- 4354: BinaryArray + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +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. + +- 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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectOnly +When enabled, we just search these properties and report any corruptions found. + +When disabled properties are removed from the elements they are found in. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExtendedPropertyCleanupRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxExtendedPropertyCleanupRequest.md new file mode 100644 index 0000000000..c4a7ab630a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxExtendedPropertyCleanupRequest.md @@ -0,0 +1,106 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxextendedpropertycleanuprequest +applicable: Exchange Online +title: Remove-MailboxExtendedPropertyCleanupRequest +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MailboxExtendedPropertyCleanupRequest + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-MailboxExtendedPropertyCleanupRequest cmdlet to remove extended mailbox property clean-up requests from cloud-based mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxExtendedPropertyCleanupRequest [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox extended property clean-up request that you want to remove. + +Identity returned by the Get-MailboxExtendedPropertyCleanupRequest with the format SOMETHING\SOMETHING\SOMETHING + +```yaml +Type: StoreIntegrityCheckIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +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. + +- 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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 8ead57cb12..dd45492c3d 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -1141,6 +1141,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailboxExportRequestStatistics](Get-MailboxExportRequestStatistics.md) +### [Get-MailboxExtendedProperty](Get-MailboxExtendedProperty.md) + +### [Get-MailboxExtendedPropertyCleanupRequest](Get-MailboxExtendedPropertyCleanupRequest.md) + ### [Get-MailboxFolder](Get-MailboxFolder.md) ### [Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) @@ -1193,6 +1197,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-MailboxExportRequest](New-MailboxExportRequest.md) +### [New-MailboxExtendedPropertyCleanupRequest](New-MailboxExtendedPropertyCleanupRequest.md) + ### [New-MailboxFolder](New-MailboxFolder.md) ### [New-MailboxImportRequest](New-MailboxImportRequest.md) @@ -1215,6 +1221,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-MailboxExportRequest](Remove-MailboxExportRequest.md) +### [Remove-MailboxExtendedPropertyCleanupRequest](Remove-MailboxExtendedPropertyCleanupRequest.md) + ### [Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) ### [Remove-MailboxImportRequest](Remove-MailboxImportRequest.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index b6691a949e..c95c5271d6 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -555,6 +555,8 @@ "Get-MailboxCalendarFolder": "mailboxes", "Get-MailboxExportRequest": "mailboxes", "Get-MailboxExportRequestStatistics": "mailboxes", + "Get-MailboxExtendedProperty": "mailboxes", + "Get-MailboxExtendedPropertyCleanupRequest": "mailboxes", "Get-MailboxFolder": "mailboxes", "Get-MailboxFolderPermission": "mailboxes", "Get-MailboxFolderStatistics": "mailboxes", @@ -581,6 +583,7 @@ "New-InboxRule": "mailboxes", "New-Mailbox": "mailboxes", "New-MailboxExportRequest": "mailboxes", + "New-MailboxExtendedPropertyCleanupRequest": "mailboxes", "New-MailboxFolder": "mailboxes", "New-MailboxImportRequest": "mailboxes", "New-MailboxRestoreRequest": "mailboxes", @@ -592,6 +595,7 @@ "Remove-InboxRule": "mailboxes", "Remove-Mailbox": "mailboxes", "Remove-MailboxExportRequest": "mailboxes", + "Remove-MailboxExtendedPropertyCleanupRequest": "mailboxes", "Remove-MailboxFolderPermission": "mailboxes", "Remove-MailboxImportRequest": "mailboxes", "Remove-MailboxPermission": "mailboxes",