en-US/Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VivaModuleFeaturePolicy</command:name> <command:verb>Add</command:verb> <command:noun>VivaModuleFeaturePolicy</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. Note that:</maml:para> <maml:para>- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant.</maml:para> <maml:para>- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies.</maml:para> <maml:para></maml:para> <maml:para>Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. </maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>Currently, you need to be a member of the Global administrators role to run this cmdlet.</maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VivaModuleFeaturePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFeatureEnabled</maml:name> <maml:description> <maml:para>The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled by the policy.</maml:para> <maml:para>- $false: The feature is not enabled by the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module that you want to add the feature policy for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").</maml:para> <maml:para>Valid characters are English letters, numbers, commas, periods, and spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> <maml:para>This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Everyone</maml:name> <maml:description> <maml:para>The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch.</maml:para> <maml:para>Don't use this switch with the GroupIds or UserIds parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupIds</maml:name> <maml:description> <maml:para>The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. Mail-enabled Microsoft Entra groups ( https://learn.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported. You can enter multiple values separated by commas.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the policy apply to all users in the organization, use the Everyone switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsUserControlEnabled</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.3.0 or later of the module.</maml:para> <maml:para>The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: </maml:para> <maml:para>- $true: User control is enabled by the policy. Users can opt out of the feature.</maml:para> <maml:para>- $false: User control isn't enabled by the policy. Users can't opt of the feature.</maml:para> <maml:para></maml:para> <maml:para>Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the policy apply to all users in the organization, use the Everyone switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFeatureEnabled</maml:name> <maml:description> <maml:para>The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled by the policy.</maml:para> <maml:para>- $false: The feature is not enabled by the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module that you want to add the feature policy for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").</maml:para> <maml:para>Valid characters are English letters, numbers, commas, periods, and spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> <maml:para>This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Everyone</maml:name> <maml:description> <maml:para>The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch.</maml:para> <maml:para>Don't use this switch with the GroupIds or UserIds parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupIds</maml:name> <maml:description> <maml:para>The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. Mail-enabled Microsoft Entra groups ( https://learn.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported. You can enter multiple values separated by commas.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the policy apply to all users in the organization, use the Everyone switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsUserControlEnabled</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.3.0 or later of the module.</maml:para> <maml:para>The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: </maml:para> <maml:para>- $true: User control is enabled by the policy. Users can opt out of the feature.</maml:para> <maml:para>- $false: User control isn't enabled by the policy. Users can't opt of the feature.</maml:para> <maml:para></maml:para> <maml:para>Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the policy apply to all users in the organization, use the Everyone switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureEnabled $false -Everyone</dev:code> <dev:remarks> <maml:para>This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com</dev:code> <dev:remarks> <maml:para>This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the specified groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureEnabled $false -UserIds user1@contoso.com,user2@contoso.com</dev:code> <dev:remarks> <maml:para>This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com</dev:code> <dev:remarks> <maml:para>This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users and group members.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DefaultTenantBriefingConfig</command:name> <command:verb>Get</command:verb> <command:noun>DefaultTenantBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see Configure Briefing email (https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>For more information, see Microsoft Entra built-in roles (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DefaultTenantBriefingConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-DefaultTenantBriefingConfig</dev:code> <dev:remarks> <maml:para>This example returns the default Briefing email configuration for the organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deploy personal insights</maml:linkText> <maml:uri>https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DefaultTenantMyAnalyticsFeatureConfig</command:name> <command:verb>Get</command:verb> <command:noun>DefaultTenantMyAnalyticsFeatureConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-DefaultTenantMyAnalyticsFeatureConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>For more information, see Microsoft Entra built-in roles (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DefaultTenantMyAnalyticsFeatureConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-DefaultTenantMyAnalyticsFeatureConfig</dev:code> <dev:remarks> <maml:para>This example returns the default opt-in or opt-out information for the various Viva Insights settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deploy personal insights</maml:linkText> <maml:uri>https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOCasMailbox</command:name> <command:verb>Get</command:verb> <command:noun>EXOCasMailbox</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOCasMailbox cmdlet to view the Client Access settings that are configured on mailboxes.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Outlook on the web, Exchange ActiveSync, POP3, and IMAP4.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOCasMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any other value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSyncDebugLogging</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetImapProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetPopProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreDefaultScope</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para></maml:para> <maml:para>You don't need to specify a value with this switch.</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadIsOptimizedForAccessibility</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SendLogsTo</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXOCasMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSyncDebugLogging</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetImapProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetPopProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreDefaultScope</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para></maml:para> <maml:para>You don't need to specify a value with this switch.</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadIsOptimizedForAccessibility</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SendLogsTo</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any other value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSyncDebugLogging</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetImapProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetPopProtocolLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreDefaultScope</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para></maml:para> <maml:para>You don't need to specify a value with this switch.</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadIsOptimizedForAccessibility</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SendLogsTo</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Input types</maml:name> </dev:type> <maml:description> <maml:para>The following Get-CasMailbox parameters are not available or supported in Get-EXOCasMailbox:</maml:para> <maml:para>- IgnoreDefaultScope</maml:para> <maml:para>- ReadIsOptimizedForAccessibility</maml:para> <maml:para>- SortBy</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Output types</maml:name> </dev:type> <maml:description> <maml:para>The following properties are removed by design from Get-EXOCasMailbox output:</maml:para> <maml:para>- RunspaceId</maml:para> <maml:para>- Servername</maml:para> <maml:para>- OriginatingServer</maml:para> <maml:para>- IsValid</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOCASMailbox -Identity "JeffHay@contoso.com"</dev:code> <dev:remarks> <maml:para>This example returns the values of the following client access settings for the user with Identity Jeffhay@contoso.com:</maml:para> <maml:para>- ActiveSyncEnabled</maml:para> <maml:para>- EwsEnabled</maml:para> <maml:para>- OWAEnabled</maml:para> <maml:para>- PopEnabled</maml:para> <maml:para>- ImapEnabled</maml:para> <maml:para>- MAPIEnabled</maml:para> <maml:para>- ECPEnabled</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exocasmailbox</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailbox</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailbox</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>By default, this cmdlet returns a summary list (a minimum set of properties) of all mailboxes in your organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Async</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicFolder</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXOMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Async</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicFolder</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Async</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicFolder</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Input types</maml:name> </dev:type> <maml:description> <maml:para>The following Get-Mailbox parameters aren't available or functional in Get-EXOMailbox:</maml:para> <maml:para>- Async</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- Migration</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- SortBy</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Output types</maml:name> </dev:type> <maml:description> <maml:para>The following properties aren't included in the output of Get-EXOMailbox:</maml:para> <maml:para>- RunspaceId</maml:para> <maml:para>- Servername</maml:para> <maml:para>- AdminDisplayVersion</maml:para> <maml:para>- DelayReleaseHoldApplied</maml:para> <maml:para>- EnforcedTimestamps</maml:para> <maml:para>- Description</maml:para> <maml:para>- OriginatingServer</maml:para> <maml:para>- IsValid</maml:para> <maml:para>- ObjectState</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailbox -ResultSize unlimited</dev:code> <dev:remarks> <maml:para>This example returns a summary list of all mailboxes in the organization, and includes the default set of minimum output properties. To return additional properties, use the Properties and/or PropertySets parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailbox -PropertySets Archive</dev:code> <dev:remarks> <maml:para>This example returns the Properties that are defined in Archive property set. For a complete list of these properties, see Get-EXOMailbox property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit</dev:code> <dev:remarks> <maml:para>This example returns a summary list of all mailboxes in the organization, and includes the following properties:</maml:para> <maml:para>- The properties in Archive and Audit property sets.</maml:para> <maml:para>- The Name and DistinguishedName properties.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias</dev:code> <dev:remarks> <maml:para>This example returns the specified properties for the mailbox John@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomailbox</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxFolderPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxFolderPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to retrieve folder level permission in the mailbox.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxFolderPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:<Folder>`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:description> <maml:para>The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID Note : If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:<Folder>`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:description> <maml:para>The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID Note : If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports</dev:code> <dev:remarks> <maml:para>This example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Kim@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the permissions for the same folder in John's mailbox, but only for the user Kim.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MailboxFolderPermission</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-MailboxFolderPermission</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-MailboxFolderPermission</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-MailboxFolderPermission</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxFolderStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxFolderStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOMailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A mailbox can have hidden items that are never visible to the user and are only used by applications. The Get-EXOMailboxFolderStatistics cmdlet can return hidden items for the following values: FolderSize, FolderAndSubfolderSize, ItemsInFolder and ItemsInFolderAndSubfolders.</maml:para> <maml:para>Don't confuse Get-EXOMailboxFolderStatistics cmdlet (folders) with the Get-EXOMailboxStatistics cmdlet (mailboxes).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxFolderStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch.</maml:para> <maml:para>If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiagnosticInfo</maml:name> <maml:description> <maml:para>Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are:</maml:para> <maml:para>- ExternalDirectoryObjectId</maml:para> <maml:para>- Identity</maml:para> <maml:para>- UserPrincipalName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Folderscope</maml:name> <maml:description> <maml:para>The FolderScope parameter specifies the scope of the search by folder type. Valid values include:</maml:para> <maml:para>- All</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Calendar</maml:para> <maml:para>- Clutter</maml:para> <maml:para>- Contacts</maml:para> <maml:para>- ConversationHistory</maml:para> <maml:para>- DeletedItems</maml:para> <maml:para>- Drafts</maml:para> <maml:para>- Inbox</maml:para> <maml:para>- Journal</maml:para> <maml:para>- JunkEmail</maml:para> <maml:para>- LegacyArchiveJournals</maml:para> <maml:para>- ManagedCustomFolder</maml:para> <maml:para>- NonIpmRoot</maml:para> <maml:para>- Notes</maml:para> <maml:para>- Outbox</maml:para> <maml:para>- Personal</maml:para> <maml:para>- RecoverableItems</maml:para> <maml:para>- RssSubscriptions</maml:para> <maml:para>- SentItems</maml:para> <maml:para>- SyncIssues</maml:para> <maml:para>- Tasks</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ElcFolderType</command:parameterValue> <dev:type> <maml:name>ElcFolderType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeAnalysis</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeOldestAndNewestItems</maml:name> <maml:description> <maml:para>The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch.</maml:para> <maml:para>If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiagnosticInfo</maml:name> <maml:description> <maml:para>Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are:</maml:para> <maml:para>- ExternalDirectoryObjectId</maml:para> <maml:para>- Identity</maml:para> <maml:para>- UserPrincipalName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Folderscope</maml:name> <maml:description> <maml:para>The FolderScope parameter specifies the scope of the search by folder type. Valid values include:</maml:para> <maml:para>- All</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Calendar</maml:para> <maml:para>- Clutter</maml:para> <maml:para>- Contacts</maml:para> <maml:para>- ConversationHistory</maml:para> <maml:para>- DeletedItems</maml:para> <maml:para>- Drafts</maml:para> <maml:para>- Inbox</maml:para> <maml:para>- Journal</maml:para> <maml:para>- JunkEmail</maml:para> <maml:para>- LegacyArchiveJournals</maml:para> <maml:para>- ManagedCustomFolder</maml:para> <maml:para>- NonIpmRoot</maml:para> <maml:para>- Notes</maml:para> <maml:para>- Outbox</maml:para> <maml:para>- Personal</maml:para> <maml:para>- RecoverableItems</maml:para> <maml:para>- RssSubscriptions</maml:para> <maml:para>- SentItems</maml:para> <maml:para>- SyncIssues</maml:para> <maml:para>- Tasks</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ElcFolderType</command:parameterValue> <dev:type> <maml:name>ElcFolderType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeAnalysis</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeOldestAndNewestItems</maml:name> <maml:description> <maml:para>The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderStatistics -Identity admin@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns statistics for all mailbox folders. Default is FolderScope All.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderStatistics -Identity admin@contoso.com -FolderScope Calendar -IncludeOldestAndNewestItems</dev:code> <dev:remarks> <maml:para>This example returns statistics only for calendar folders.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-EXOMailbox -ResultSize Unlimited | Get-EXOMailboxFolderStatistics -FolderScope Inbox | Format-Table Identity,ItemsInFolderAndSubfolders,FolderAndSubfolderSize -AutoSize</dev:code> <dev:remarks> <maml:para>This example uses the FolderScope parameter to view Inbox folder statistics for all mailboxes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOMailboxPermission cmdlet to retrieve permissions on a mailbox.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The output of this cmdlet shows the following information:</maml:para> <maml:para>- Identity: The mailbox in question.</maml:para> <maml:para>- User: The security principal (user, security group, Exchange management role group, etc.) that has permission to the mailbox.</maml:para> <maml:para>- AccessRights: The permission that the security principal has on the mailbox. The available values are ChangeOwner (change the owner of the mailbox), ChangePermission (change the permissions on the mailbox), DeleteItem (delete the mailbox), ExternalAccount (indicates the account isn't in the same domain), FullAccess (open the mailbox, access its contents, but can't send mail) and ReadPermission (read the permissions on the mailbox). Whether the permissions are allowed or denied is indicated in the Deny column.</maml:para> <maml:para>- IsInherited: Whether the permission is inherited (True) or directly assigned to the mailbox (False). Permissions are inherited from the mailbox database and/or Active Directory. Typically, directly assigned permissions override inherited permissions.</maml:para> <maml:para>- Deny: Whether the permission is allowed (False) or denied (True). Typically, deny permissions override allow permissions.</maml:para> <maml:para></maml:para> <maml:para>By default, the following permissions are assigned to user mailboxes:</maml:para> <maml:para>- FullAccess and ReadPermission are directly assigned to NT AUTHORITY\SELF. This entry gives a user permission to their own mailbox.</maml:para> <maml:para>- FullAccess is denied to Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permissions prevent these users and group members from opening other users' mailboxes.</maml:para> <maml:para>- ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. Note that these inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries.</maml:para> <maml:para>- FullAccess is inherited by NT AUTHORITY\SYSTEM and ReadPermission is inherited by NT AUTHORITY\NETWORK.</maml:para> <maml:para>- FullAccess and ReadPermission are inherited by Exchange Servers, ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are inherited by Exchange Trusted Subsystem and ReadPermission is inherited by Managed Availability Servers.</maml:para> <maml:para></maml:para> <maml:para>By default, other security groups and role groups inherit permissions to mailboxes based on their location (on-premises Exchange or Microsoft 365).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter.</maml:para> <maml:para>The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- GUID Note : Currently, the value that you provide for this parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter.</maml:para> <maml:para>The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- GUID Note : Currently, the value that you provide for this parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxPermission -Identity john@contoso.com</dev:code> <dev:remarks> <maml:para>This example return the permission the user has on mailboxes</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomailboxpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOMailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can use the detailed move history and a move report output from this cmdlet to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database, are numbered incrementally, and the last run move request is always numbered 0.</maml:para> <maml:para>You can only see move reports and move history for completed move requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DatabaseGuid</maml:name> <maml:description> <maml:para>The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExchangeGuid</maml:name> <maml:description> <maml:para>The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properies filter set to ExchangeGuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeMoveHistory</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeMoveReport</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailboxStatistics property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- All</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailboxStatistics property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:description> <maml:para>The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DatabaseGuid</maml:name> <maml:description> <maml:para>The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExchangeGuid</maml:name> <maml:description> <maml:para>The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properies filter set to ExchangeGuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeMoveHistory</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeMoveReport</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailboxStatistics property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- All</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailboxStatistics property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxStatistics -Identity john@contoso.com</dev:code> <dev:remarks> <maml:para>This example retrieves the mailbox statistics for the specified mailbox. Only the minimum set of properties are returned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxStatistics -Identity john@contoso.com -Properties SystemMessageSize,SystemMessageSizeWarningQuota,SystemMessageCount</dev:code> <dev:remarks> <maml:para>This example retrieves the minimum set of properties and the specified properties for the specified mailbox.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomailboxstatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMobileDeviceStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMobileDeviceStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXOMobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMobileDeviceStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- DeviceID</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSync</maml:name> <maml:description> <maml:para>The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetMailboxLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotificationEmailAddresses</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OWAforDevices</maml:name> <maml:description> <maml:para>The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestApi</maml:name> <maml:description> <maml:para>The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowRecoveryPassword</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UniversalOutlook</maml:name> <maml:description> <maml:para>The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXOMobileDeviceStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Mailbox</maml:name> <maml:description> <maml:para>The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSync</maml:name> <maml:description> <maml:para>The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetMailboxLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotificationEmailAddresses</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OWAforDevices</maml:name> <maml:description> <maml:para>The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestApi</maml:name> <maml:description> <maml:para>The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowRecoveryPassword</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UniversalOutlook</maml:name> <maml:description> <maml:para>The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- DeviceID</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Mailbox</maml:name> <maml:description> <maml:para>The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSync</maml:name> <maml:description> <maml:para>The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GetMailboxLog</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotificationEmailAddresses</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OWAforDevices</maml:name> <maml:description> <maml:para>The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestApi</maml:name> <maml:description> <maml:para>The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowRecoveryPassword</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UniversalOutlook</maml:name> <maml:description> <maml:para>The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the statistics of all devices linked to user with email john.doe@contoso.com</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com -ActiveSync</dev:code> <dev:remarks> <maml:para>This example returns the statistics for active sync devices linked to user with email john.doe@contoso.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXORecipient</command:name> <command:verb>Get</command:verb> <command:noun>EXORecipient</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-ExORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-EXORecipient cmdlet can be used to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXORecipient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the recipient. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para></maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientPreviewFilter</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- SharedWithMailUser</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXORecipient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para></maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientPreviewFilter</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- SharedWithMailUser</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the recipient. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information (https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para></maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientPreviewFilter</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- SharedWithMailUser</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para></maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXORecipient -ResultSize 100</dev:code> <dev:remarks> <maml:para>This example returns the first 100 recipient objects in name sorted order.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXORecipient -Identity john@contosot.com</dev:code> <dev:remarks> <maml:para>This example returns the recipient attribute details for the user john@contoso.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exorecipient</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXORecipientPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXORecipientPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to view/manage information about SendAs permissions that are configured for users in a cloud-based organization. Send As permission allows delegates to use the mailbox to send messages. After this permission is assigned to a delegate, any message that the delegate sends from the mailbox will appear to have been sent by the mailbox owner. However, this permission doesn't allow a delegate to sign in to the user's mailbox. It only allows users to open the mailbox. If this permission is assigned to a group, a message sent by the delegate will appear to have been sent by the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXORecipientPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- Mail contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para></maml:para> <maml:para>For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessRights</maml:name> <maml:description> <maml:para>The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MultiValuedProperty</command:parameterValue> <dev:type> <maml:name>MultiValuedProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Trustee</maml:name> <maml:description> <maml:para>The Trustee parameter filters the results by the user or group who has Send As permissions. You can specify the following types of users or groups:</maml:para> <maml:para>- Mailbox users</maml:para> <maml:para>- Mail users with a Microsoft account</maml:para> <maml:para>- Security groups</maml:para> <maml:para></maml:para> <maml:para>You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- User Principal name (UPN)</maml:para> <maml:para></maml:para> <maml:para>You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrincipalName, or ExternalDirectoryObjectId parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- Mail contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para></maml:para> <maml:para>For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para></maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para></maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessRights</maml:name> <maml:description> <maml:para>The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MultiValuedProperty</command:parameterValue> <dev:type> <maml:name>MultiValuedProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:description> <maml:para>The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID.</maml:para> <maml:para>You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:description> <maml:para>The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Trustee</maml:name> <maml:description> <maml:para>The Trustee parameter filters the results by the user or group who has Send As permissions. You can specify the following types of users or groups:</maml:para> <maml:para>- Mailbox users</maml:para> <maml:para>- Mail users with a Microsoft account</maml:para> <maml:para>- Security groups</maml:para> <maml:para></maml:para> <maml:para>You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Domain\Username</maml:para> <maml:para>- Email address</maml:para> <maml:para>- User Principal name (UPN)</maml:para> <maml:para></maml:para> <maml:para>You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrincipalName, or ExternalDirectoryObjectId parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:description> <maml:para>The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com).</maml:para> <maml:para>You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXORecipientPermission -ResultSize 100</dev:code> <dev:remarks> <maml:para>Above example returns recipient permission for first 100 mailbox users in the name sorted order.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-exorecipientpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MyAnalyticsFeatureConfig</command:name> <command:verb>Get</command:verb> <command:noun>MyAnalyticsFeatureConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user. Note : This cmdlet replaces the Get-UserAnalyticsConfig cmdlet.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MyAnalyticsFeatureConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user you want to view. You identify the user by their email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user you want to view. You identify the user by their email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>c:\users\vikram Get-MyAnalyticsFeatureConfig -Identity vikram@contoso.com UserId : vikram@contoso.com PrivacyMode : opt-in IsDashboardEnabled : true IsAddInEnabled : true IsDigestEmailEnabled : false</dev:code> <dev:remarks> <maml:para>This example and the corresponding output shows the MyAnalytics configuration for the user vikram@contoso.com. MyAnalytics is available to Vikram (the PrivacyMode property value is opt-in). The only feature that's disabled is digest email messages.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UserBriefingConfig</command:name> <command:verb>Get</command:verb> <command:noun>UserBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see Configure Briefing email (https://learn.microsoft.com/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UserBriefingConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to view (for example, lila@contoso.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to view (for example, lila@contoso.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-UserBriefingConfig -Identity lila@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the Briefing configuration for the user lila@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-userbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configure Briefing email</maml:linkText> <maml:uri>https://learn.microsoft.com/Briefing/be-admin</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VivaInsightsSettings</command:name> <command:verb>Get</command:verb> <command:noun>VivaInsightsSettings</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is available only in version 2.0.5 or later of the module.</maml:para> <maml:para>Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Teams Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VivaInsightsSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to view. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are:</maml:para> <maml:para>- Headspace: Represents all features of Headspace.</maml:para> <maml:para>- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to view. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are:</maml:para> <maml:para>- Headspace: Represents all features of Headspace.</maml:para> <maml:para>- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com UserId : roy@contoso.onmicrosoft.com IsInsightsHeadspaceEnabled : True</dev:code> <dev:remarks> <maml:para>This example shows the configuration of Microsoft Viva Insights in Microsoft Teams for the user roy@contoso.onmicrosoft.com. The output of the command shows that the features of Headspace are available to Roy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-vivainsightssettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VivaModuleFeature</command:name> <command:verb>Get</command:verb> <command:noun>VivaModuleFeature</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. This cmdlet provides details about the features, including the feature identifiers and descriptions.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls.</maml:para> <maml:para>You can view all features in a particular Viva module that support feature access controls. To view a specific feature, you can include the FeatureId parameter.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VivaModuleFeature</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the features that you want to view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="positional" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the specific feature in the Viva module that you want to view.</maml:para> <maml:para>You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the features that you want to view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="positional" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the specific feature in the Viva module that you want to view.</maml:para> <maml:para>You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VivaModuleFeature -ModuleId VivaInsights</dev:code> <dev:remarks> <maml:para>This example returns all features in Viva Insights that support feature access controls.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VivaModuleFeature -ModuleId VivaInsights -FeatureId Reflection</dev:code> <dev:remarks> <maml:para>This example returns the details of the Reflection feature in Viva Insights.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VivaModuleFeatureEnablement</command:name> <command:verb>Get</command:verb> <command:noun>VivaModuleFeatureEnablement</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>Currently, you need to be a member of the Global administrators role to run this cmdlet.</maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VivaModuleFeatureEnablement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. Mail-enabled Microsoft Entra groups (https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. Mail-enabled Microsoft Entra groups (https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exchange Online</command:parameterValue> <dev:type> <maml:name>Exchange Online</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity user@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the enablement state of the Reflection feature in Viva Insights for the user@contoso.com user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity group@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the enablement state of the Reflection feature in Viva Insights for the group@contoso.com group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VivaModuleFeaturePolicy</command:name> <command:verb>Get</command:verb> <command:noun>VivaModuleFeaturePolicy</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module.</maml:para> <maml:para>You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>Currently, you need to be a member of the Global administrators role to run this cmdlet.</maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VivaModuleFeaturePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the feature policies that you want to view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</command:parameterValue> <dev:type> <maml:name>Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="positional" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view.</maml:para> <maml:para>To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the feature policies that you want to view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="positional" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view.</maml:para> <maml:para>To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</command:parameterValue> <dev:type> <maml:name>Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection</dev:code> <dev:remarks> <maml:para>This example returns details about all the policies added for the Reflection feature in Viva Insights.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b</dev:code> <dev:remarks> <maml:para>This example returns details about a specific policy added for the Reflection feature in Viva Insights.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VivaModuleFeaturePolicy</command:name> <command:verb>Remove</command:verb> <command:noun>VivaModuleFeaturePolicy</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>Currently, you need to be a member of the Global administrators role to run this cmdlet.</maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VivaModuleFeaturePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove.</maml:para> <maml:para>To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove.</maml:para> <maml:para>To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b</dev:code> <dev:remarks> <maml:para>This example deletes the specified policy for the Reflection feature in Viva Insights.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DefaultTenantBriefingConfig</command:name> <command:verb>Set</command:verb> <command:noun>DefaultTenantBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see Configure Briefing email (https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>For more information, see Microsoft Entra built-in roles (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DefaultTenantBriefingConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabledByDefault</maml:name> <maml:description> <maml:para>The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are:</maml:para> <maml:para>- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email.</maml:para> <maml:para>- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value.</maml:para> <maml:para></maml:para> <maml:para>This setting affects the following users:</maml:para> <maml:para>- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.</maml:para> <maml:para>- New users that you create.</maml:para> <maml:para></maml:para> <maml:para>This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</command:parameterValue> <dev:type> <maml:name>Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabledByDefault</maml:name> <maml:description> <maml:para>The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are:</maml:para> <maml:para>- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email.</maml:para> <maml:para>- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value.</maml:para> <maml:para></maml:para> <maml:para>This setting affects the following users:</maml:para> <maml:para>- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.</maml:para> <maml:para>- New users that you create.</maml:para> <maml:para></maml:para> <maml:para>This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</command:parameterValue> <dev:type> <maml:name>Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in This example sets the default Briefing email configuration for the organization to receive the Briefing email.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deploy personal insights</maml:linkText> <maml:uri>https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DefaultTenantMyAnalyticsFeatureConfig</command:name> <command:verb>Set</command:verb> <command:noun>DefaultTenantMyAnalyticsFeatureConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Set-DefaultTenantMyAnalyticsFeatureConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>For more information, see Microsoft Entra built-in roles (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DefaultTenantMyAnalyticsFeatureConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are:</maml:para> <maml:para>- Add-in</maml:para> <maml:para>- Dashboard</maml:para> <maml:para>- Digest-email</maml:para> <maml:para>- Meeting-effectiveness-survey</maml:para> <maml:para>- Meeting-effectiveness-survey-sampling-rate</maml:para> <maml:para>- Schedule-send</maml:para> <maml:para>- All (all features)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Dashboard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Add-in</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Digest-email</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Meeting-effectiveness-survey</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scheduled-send</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:description> <maml:para>The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled.</maml:para> <maml:para>- $false: The feature is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SamplingRate</maml:name> <maml:description> <maml:para>This parameter is available only in version 3.2.0 or later.</maml:para> <maml:para>The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are:</maml:para> <maml:para>- Add-in</maml:para> <maml:para>- Dashboard</maml:para> <maml:para>- Digest-email</maml:para> <maml:para>- Meeting-effectiveness-survey</maml:para> <maml:para>- Meeting-effectiveness-survey-sampling-rate</maml:para> <maml:para>- Schedule-send</maml:para> <maml:para>- All (all features)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:description> <maml:para>The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled.</maml:para> <maml:para>- $false: The feature is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SamplingRate</maml:name> <maml:description> <maml:para>This parameter is available only in version 3.2.0 or later.</maml:para> <maml:para>The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true</dev:code> <dev:remarks> <maml:para>This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false</dev:code> <dev:remarks> <maml:para>This example disables Viva Insight add-in feature for the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2</dev:code> <dev:remarks> <maml:para>This example sets the meeting effectiveness survey sampling rate to 20%.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deploy personal insights</maml:linkText> <maml:uri>https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-MyAnalyticsFeatureConfig</command:name> <command:verb>Set</command:verb> <command:noun>MyAnalyticsFeatureConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user. Note : This cmdlet replaces the Set-UserAnalyticsConfig cmdlet.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-MyAnalyticsFeatureConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user you want to view. You identify the user by their email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are:</maml:para> <maml:para>- all (this is the default value)</maml:para> <maml:para>- add-in</maml:para> <maml:para>- dashboard</maml:para> <maml:para>- digest-email</maml:para> <maml:para></maml:para> <maml:para>To actually enable or disable a feature that's specified by this parameter, use the IsEnabled parameter in the same command.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">dashboard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">add-in</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">digest-email</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">all</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:description> <maml:para>The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are:</maml:para> <maml:para>- $true: The specified feature is enabled.</maml:para> <maml:para>- $false: The specified feature is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivacyMode</maml:name> <maml:description> <maml:para>The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are:</maml:para> <maml:para>-opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features. -opt-out: MyAnalytics is disabled for the user.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">opt-in</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">opt-out</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user you want to view. You identify the user by their email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are:</maml:para> <maml:para>- all (this is the default value)</maml:para> <maml:para>- add-in</maml:para> <maml:para>- dashboard</maml:para> <maml:para>- digest-email</maml:para> <maml:para></maml:para> <maml:para>To actually enable or disable a feature that's specified by this parameter, use the IsEnabled parameter in the same command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:description> <maml:para>The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are:</maml:para> <maml:para>- $true: The specified feature is enabled.</maml:para> <maml:para>- $false: The specified feature is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivacyMode</maml:name> <maml:description> <maml:para>The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are:</maml:para> <maml:para>-opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features. -opt-out: MyAnalytics is disabled for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-MyAnalyticsFeatureConfig -Identity vikram@contoso.com -PrivacyMode opt-in</dev:code> <dev:remarks> <maml:para>This example makes MyAnalytics and all features available to Vikram.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-MyAnalyticsFeatureConfig -Identity swathy@contoso.com -PrivacyMode opt-in -Feature digest-email -IsEnabled $false</dev:code> <dev:remarks> <maml:para>This example makes MyAnalytics available to Swathy, but disables the digest email feature.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-MyAnalyticsFeatureConfig -Identity akshath@contoso.com -Feature digest-email -IsEnabled $false</dev:code> <dev:remarks> <maml:para>This example disables the digest email feature for Akshath.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UserBriefingConfig</command:name> <command:verb>Set</command:verb> <command:noun>UserBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing email for a user. For more details about configuring the Briefing email, see Configure Briefing email (https://learn.microsoft.com/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Insights Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UserBriefingConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:</maml:para> <maml:para>- $true: The daily briefing message is enabled.</maml:para> <maml:para>- $false: The daily briefing message is disabled. This is the default value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:</maml:para> <maml:para>- $true: The daily briefing message is enabled.</maml:para> <maml:para>- $false: The daily briefing message is disabled. This is the default value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-UserBriefingConfig -Identity lila@contoso.com -Enabled $true</dev:code> <dev:remarks> <maml:para>This example enables the Briefing email for lila@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-userbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configure Briefing email</maml:linkText> <maml:uri>https://learn.microsoft.com/Briefing/be-admin</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VivaInsightsSettings</command:name> <command:verb>Set</command:verb> <command:noun>VivaInsightsSettings</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is available only in version 2.0.5 or later of the module.</maml:para> <maml:para>Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:</maml:para> <maml:para>- Global Administrator</maml:para> <maml:para>- Exchange Administrator</maml:para> <maml:para>- Teams Administrator</maml:para> <maml:para></maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VivaInsightsSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to modify. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:</maml:para> <maml:para>- $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user.</maml:para> <maml:para>- $false: The specified features in Microsoft Viva Insights in Microsoft Teams are disabled for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the feature of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:</maml:para> <maml:para>- Headspace: Represents all features of Headspace.</maml:para> <maml:para>- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">headspace</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity parameter specifies the user that you want to modify. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:</maml:para> <maml:para>- $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user.</maml:para> <maml:para>- $false: The specified features in Microsoft Viva Insights in Microsoft Teams are disabled for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The Feature parameter specifies the feature of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:</maml:para> <maml:para>- Headspace: Represents all features of Headspace.</maml:para> <maml:para>- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com -Enabled $false -Feature headspace</dev:code> <dev:remarks> <maml:para>This example disables access to all the Headspace features in Microsoft Viva Insights in Microsoft Teams for the specified user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/set-vivainsightssettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VivaModuleFeaturePolicy</command:name> <command:verb>Update</command:verb> <command:noun>VivaModuleFeaturePolicy</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module). Note : This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview.</maml:para> <maml:para>Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. Note that:</maml:para> <maml:para>- You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported.</maml:para> <maml:para>- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies.</maml:para> <maml:para></maml:para> <maml:para>Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module.</maml:para> <maml:para>This cmdlet updates the attributes of the policy that you specify. These attributes include:</maml:para> <maml:para>- The policy name (Name parameter).</maml:para> <maml:para>- Whether or not the policy enables the feature (IsFeatureEnabled parameter).</maml:para> <maml:para>- Whether or not the policy enables user controls (IsUserControlEnabled parameter).</maml:para> <maml:para>- Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter).</maml:para> <maml:para></maml:para> <maml:para>You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. Important : Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter overwrite any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups and any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples.</maml:para> <maml:para>You need to use the Connect-ExchangeOnline cmdlet to authenticate.</maml:para> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later.</maml:para> <maml:para>Currently, you need to be a member of the Global administrators role to run this cmdlet.</maml:para> <maml:para>To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs (https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VivaModuleFeaturePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the policy that you want to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update.</maml:para> <maml:para>To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Everyone</maml:name> <maml:description> <maml:para>The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are:</maml:para> <maml:para>- $true: The policy applies to all users. This is the only useful value for this parameter.</maml:para> <maml:para>- $false: Don't use this value.</maml:para> <maml:para></maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>Don't use this parameter with the GroupIds or UserIds parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupIds</maml:name> <maml:description> <maml:para>The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. Mail-enabled Microsoft Entra groups (https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported. You can enter multiple values separated by commas.</maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFeatureEnabled</maml:name> <maml:description> <maml:para>The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled by the policy.</maml:para> <maml:para>- $false: The feature is not enabled by the policy.</maml:para> <maml:para></maml:para> <maml:para>If you don't want to update whether the feature is enabled by the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsUserControlEnabled</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.3.0 or later of the module.</maml:para> <maml:para>The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: </maml:para> <maml:para>- $true: User control is enabled by the policy. Users can opt out of the feature.</maml:para> <maml:para>- $false: User control isn't enabled by the policy. Users can't opt of the feature.</maml:para> <maml:para></maml:para> <maml:para>Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information.</maml:para> <maml:para>If you don't want to update whether the user control is enabled by the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").</maml:para> <maml:para>Valid characters are English letters, numbers, commas, periods, and spaces.</maml:para> <maml:para>If you don't want to update the name of the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas.</maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeatureId</maml:name> <maml:description> <maml:para>The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update.</maml:para> <maml:para>To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleId</maml:name> <maml:description> <maml:para>The ModuleId parameter specifies the Viva module of the policy that you want to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update.</maml:para> <maml:para>To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>- 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`.</maml:para> <maml:para>- 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Everyone</maml:name> <maml:description> <maml:para>The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are:</maml:para> <maml:para>- $true: The policy applies to all users. This is the only useful value for this parameter.</maml:para> <maml:para>- $false: Don't use this value.</maml:para> <maml:para></maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>Don't use this parameter with the GroupIds or UserIds parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupIds</maml:name> <maml:description> <maml:para>The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. Mail-enabled Microsoft Entra groups (https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph)are supported. You can enter multiple values separated by commas.</maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFeatureEnabled</maml:name> <maml:description> <maml:para>The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are:</maml:para> <maml:para>- $true: The feature is enabled by the policy.</maml:para> <maml:para>- $false: The feature is not enabled by the policy.</maml:para> <maml:para></maml:para> <maml:para>If you don't want to update whether the feature is enabled by the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsUserControlEnabled</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.3.0 or later of the module.</maml:para> <maml:para>The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: </maml:para> <maml:para>- $true: User control is enabled by the policy. Users can opt out of the feature.</maml:para> <maml:para>- $false: User control isn't enabled by the policy. Users can't opt of the feature.</maml:para> <maml:para></maml:para> <maml:para>Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information.</maml:para> <maml:para>If you don't want to update whether the user control is enabled by the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").</maml:para> <maml:para>Valid characters are English letters, numbers, commas, periods, and spaces.</maml:para> <maml:para>If you don't want to update the name of the policy, don't use this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas.</maml:para> <maml:para>If you don't want to update who the policy applies to, don't use this parameter.</maml:para> <maml:para>The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify.</maml:para> <maml:para>You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.).</maml:para> <maml:para>To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureEnabled $false</dev:code> <dev:remarks> <maml:para>This example updates the name of the specified policy and makes it so the policy does not enable the feature.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com</dev:code> <dev:remarks> <maml:para>This example updates who the specified policy applies to. The policy now applies only to the specified groups, overwriting the users and groups the policy used to apply to.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com</dev:code> <dev:remarks> <maml:para>This example updates who the specified policy applies to. The policy now applies only to the specified users, overwriting the users and groups the policy used to apply to.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureEnabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com</dev:code> <dev:remarks> <maml:para>This example updates the name of the specified policy, makes it so the policy enables the feature, and updates who the policy applies to. The policy now applies only to the specified users and groups, overwriting the users and groups the policy used to apply to.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/update-vivamodulefeaturepolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exchange PowerShell</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About the Exchange Online PowerShell module</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Role template IDs</maml:linkText> <maml:uri>https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |