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>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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</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:para>You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).</maml:para> </maml:description> <command:syntax> <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: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 filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.</maml:para> <maml:para>- <Property> is a filterable property.</maml:para> <maml:para>- -<Comparison Operator> 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://go.microsoft.com/fwlink/p/?LinkId=620712).</maml:para> <maml:para>- <Value> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('<Value>'). Don't use quotation marks with integers or the system values $true, $false, or $null.</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>You can filter by the following properties:</maml:para> <maml:para>- ActiveSyncAllowedDeviceIDs</maml:para> <maml:para>- ActiveSyncBlockedDeviceIDs</maml:para> <maml:para>- ActiveSyncDebugLogging</maml:para> <maml:para>- ActiveSyncEnabled</maml:para> <maml:para>- ActiveSyncMailboxPolicy</maml:para> <maml:para>- ActiveSyncSuppressReadReceipt</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- DistinguishedName</maml:para> <maml:para>- ECPEnabled</maml:para> <maml:para>- EmailAddresses</maml:para> <maml:para>- EwsApplicationAccessPolicy</maml:para> <maml:para>- EwsEnabled</maml:para> <maml:para>- ExchangeVersion</maml:para> <maml:para>- Guid</maml:para> <maml:para>- HasActiveSyncDevicePartnership</maml:para> <maml:para>- Id</maml:para> <maml:para>- ImapEnabled</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- MAPIEnabled</maml:para> <maml:para>- Name</maml:para> <maml:para>- ObjectCategory</maml:para> <maml:para>- ObjectClass</maml:para> <maml:para>- OWAEnabled</maml:para> <maml:para>- OWAforDevicesEnabled</maml:para> <maml:para>- OwaMailboxPolicy</maml:para> <maml:para>- PopEnabled</maml:para> <maml:para>- PrimarySmtpAddress</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- ServerLegacyDN</maml:para> <maml:para>- ServerName</maml:para> <maml:para>- WhenChanged</maml:para> <maml:para>- WhenChangedUTC</maml:para> <maml:para>- WhenCreated</maml:para> <maml:para>- WhenCreatedUTC</maml:para> <maml:para>For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProtocolSettings</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pop</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActiveSync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Mapi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ews</command:parameterValue> </command:parameterValueGroup> <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>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>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: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 that you want to view. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN) Note : This parameter doesn't support Name or Alias values.</maml:para> <maml:para>You can't use this parameter with the Anr 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="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</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 filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.</maml:para> <maml:para>- <Property> is a filterable property.</maml:para> <maml:para>- -<Comparison Operator> 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://go.microsoft.com/fwlink/p/?LinkId=620712).</maml:para> <maml:para>- <Value> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('<Value>'). Don't use quotation marks with integers or the system values $true, $false, or $null.</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>You can filter by the following properties:</maml:para> <maml:para>- ActiveSyncAllowedDeviceIDs</maml:para> <maml:para>- ActiveSyncBlockedDeviceIDs</maml:para> <maml:para>- ActiveSyncDebugLogging</maml:para> <maml:para>- ActiveSyncEnabled</maml:para> <maml:para>- ActiveSyncMailboxPolicy</maml:para> <maml:para>- ActiveSyncSuppressReadReceipt</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- DistinguishedName</maml:para> <maml:para>- ECPEnabled</maml:para> <maml:para>- EmailAddresses</maml:para> <maml:para>- EwsApplicationAccessPolicy</maml:para> <maml:para>- EwsEnabled</maml:para> <maml:para>- ExchangeVersion</maml:para> <maml:para>- Guid</maml:para> <maml:para>- HasActiveSyncDevicePartnership</maml:para> <maml:para>- Id</maml:para> <maml:para>- ImapEnabled</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- MAPIEnabled</maml:para> <maml:para>- Name</maml:para> <maml:para>- ObjectCategory</maml:para> <maml:para>- ObjectClass</maml:para> <maml:para>- OWAEnabled</maml:para> <maml:para>- OWAforDevicesEnabled</maml:para> <maml:para>- OwaMailboxPolicy</maml:para> <maml:para>- PopEnabled</maml:para> <maml:para>- PrimarySmtpAddress</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- ServerLegacyDN</maml:para> <maml:para>- ServerName</maml:para> <maml:para>- WhenChanged</maml:para> <maml:para>- WhenChangedUTC</maml:para> <maml:para>- WhenCreated</maml:para> <maml:para>- WhenCreatedUTC</maml:para> <maml:para>For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProtocolSettings</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pop</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActiveSync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Mapi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ews</command:parameterValue> </command:parameterValueGroup> <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>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>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>{{ Fill UserPrincipalName Description }}</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>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: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>This parameter is reserved for internal Microsoft use.</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 filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.</maml:para> <maml:para>- <Property> is a filterable property.</maml:para> <maml:para>- -<Comparison Operator> 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://go.microsoft.com/fwlink/p/?LinkId=620712).</maml:para> <maml:para>- <Value> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('<Value>'). Don't use quotation marks with integers or the system values $true, $false, or $null.</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>You can filter by the following properties:</maml:para> <maml:para>- ActiveSyncAllowedDeviceIDs</maml:para> <maml:para>- ActiveSyncBlockedDeviceIDs</maml:para> <maml:para>- ActiveSyncDebugLogging</maml:para> <maml:para>- ActiveSyncEnabled</maml:para> <maml:para>- ActiveSyncMailboxPolicy</maml:para> <maml:para>- ActiveSyncSuppressReadReceipt</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- DistinguishedName</maml:para> <maml:para>- ECPEnabled</maml:para> <maml:para>- EmailAddresses</maml:para> <maml:para>- EwsApplicationAccessPolicy</maml:para> <maml:para>- EwsEnabled</maml:para> <maml:para>- ExchangeVersion</maml:para> <maml:para>- Guid</maml:para> <maml:para>- HasActiveSyncDevicePartnership</maml:para> <maml:para>- Id</maml:para> <maml:para>- ImapEnabled</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- MAPIEnabled</maml:para> <maml:para>- Name</maml:para> <maml:para>- ObjectCategory</maml:para> <maml:para>- ObjectClass</maml:para> <maml:para>- OWAEnabled</maml:para> <maml:para>- OWAforDevicesEnabled</maml:para> <maml:para>- OwaMailboxPolicy</maml:para> <maml:para>- PopEnabled</maml:para> <maml:para>- PrimarySmtpAddress</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- ServerLegacyDN</maml:para> <maml:para>- ServerName</maml:para> <maml:para>- WhenChanged</maml:para> <maml:para>- WhenChangedUTC</maml:para> <maml:para>- WhenCreated</maml:para> <maml:para>- WhenCreatedUTC</maml:para> <maml:para>For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN) Note : This parameter doesn't support Name or Alias values.</maml:para> <maml:para>You can't use this parameter with the Anr 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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoCasMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>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>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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para>The following Input parameters are not supported in Get-EXOCasMailbox:</maml:para> <maml:para>- IgnoreDefaultScope</maml:para> <maml:para>- ReadIsOptimizedForAccessibility</maml:para> <maml:para>- SortBy</maml:para> <maml:para>- GetImapProtocolLog</maml:para> <maml:para>- GetPopProtocolLog</maml:para> <maml:para>- SendLogsTo</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </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://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This commandlet returns you a summary list of all the mailboxes in your organization. It returns a minimum set of properties by default.</maml:para> </maml:description> <command:syntax> <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: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 is required to return archive mailboxes 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="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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>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 include active 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>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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Audit</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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddressList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Audit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delivery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Moderation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Move</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PublicFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quota</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Resource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Retention</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SCL</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoftDelete</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StatisticsSeed</command:parameterValue> </command:parameterValueGroup> <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>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>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: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 that you want to view. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN) Note : This parameter doesn't support Name or Alias values.</maml:para> <maml:para>You can't use this parameter with the Anr 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>Archive</maml:name> <maml:Description> <maml:para>The Archive switch is required to return archive mailboxes 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>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</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 indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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>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 include active 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>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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Audit</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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddressList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Audit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delivery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Moderation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Move</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PublicFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quota</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Resource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Retention</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SCL</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoftDelete</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StatisticsSeed</command:parameterValue> </command:parameterValueGroup> <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>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>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>{{ Fill UserPrincipalName Description }}</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>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: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 is required to return archive mailboxes 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>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</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 indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN) Note : This parameter doesn't support Name or Alias values.</maml:para> <maml:para>You can't use this parameter with the Anr 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>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 include active 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>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>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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Audit</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>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>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>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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para>The following Get-Mailbox parameters aren't available in Get-EXOMailbox:</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- Migration</maml:para> <maml:para>- SortBy</maml:para> <maml:para>- Async</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </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-Mailbox -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-Mailbox -PropertySets Archive</dev:code> <dev:remarks> <maml:para>This example returns the list of Properties defined in Archive property set. For a complete list of these properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exomailbox-property-sets).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-Mailbox -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-Mailbox -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://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</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 value of <Mailbox>, 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>Example values for this parameter are john@contoso.com:\Calendar or John:\Marketing\Reports.</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>This parameter is reserved for internal Microsoft use.</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 Office 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="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</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>{{ Fill UserPrincipalName Description }}</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>This parameter is reserved for internal Microsoft use.</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 Office 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, 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 value of <Mailbox>, 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>Example values for this parameter are john@contoso.com:\Calendar or John:\Marketing\Reports.</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</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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/get-exomailboxfolderpermission</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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</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>The Get-ExoMailboxFolderStatistics cmdlet shouldn't be confused with the Get-ExoMailboxStatistics cmdlet.</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 associated with the mailbox or mail user. 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>{{ Fill ExternalDirectoryObjectId Description }}</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 parameter 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)" 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. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>The IncludeAnalysis switch specifies whether to scan all items within a folder and return statistics related to the folder and item size. You don't need to specify a value with this switch.</maml:para> <maml:para>You should use this switch for troubleshooting purposes, because the command might take a long time to complete.</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>{{ Fill IncludeSoftDeletedRecipients Description }}</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="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>{{ Fill UserPrincipalName Description }}</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 associated with the mailbox or mail user. 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>{{ Fill ExternalDirectoryObjectId Description }}</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 parameter 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)" 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. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>The IncludeAnalysis switch specifies whether to scan all items within a folder and return statistics related to the folder and item size. You don't need to specify a value with this switch.</maml:para> <maml:para>You should use this switch for troubleshooting purposes, because the command might take a long time to complete.</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>{{ Fill IncludeSoftDeletedRecipients Description }}</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="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</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>{{ Fill ExternalDirectoryObjectId Description }}</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>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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="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>{{ Fill SoftDeletedMailbox Description }}</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: 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</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>{{ Fill UserPrincipalName Description }}</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>{{ Fill ExternalDirectoryObjectId Description }}</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>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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="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>{{ Fill SoftDeletedMailbox Description }}</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: 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</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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can use the Get-MailboxStatistics cmdlet to return detailed move history and a move report for completed move requests 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 and are numbered incrementally and the last executed 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>{{ Fill DatabaseGuid Description }}</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>{{ Fill ExchangeGuid Description }}</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>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox that you want to return statistics for. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>The IncludeMoveHistory switch specifies whether to return additional information about the mailbox that includes the history of a completed move request, such as status, flags, target database, bad items, start times, end times, duration that the move request was in various stages, and failure codes. 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>IncludeMoveReport</maml:name> <maml:Description> <maml:para>The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages. You don't need to specify a value with this switch.</maml:para> <maml:para>Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis.</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="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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>- Access</maml:para> <maml:para>- Device</maml:para> <maml:para>- Others</maml:para> <maml:para>- Policy</maml:para> <maml:para>- Sync</maml:para> <maml:para>- Wipe</maml:para> <maml:para>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>{{ Fill UserPrincipalName Description }}</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>{{ Fill DatabaseGuid Description }}</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>{{ Fill ExchangeGuid Description }}</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>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox that you want to return statistics for. 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>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>The IncludeMoveHistory switch specifies whether to return additional information about the mailbox that includes the history of a completed move request, such as status, flags, target database, bad items, start times, end times, duration that the move request was in various stages, and failure codes. 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>IncludeMoveReport</maml:name> <maml:Description> <maml:para>The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages. You don't need to specify a value with this switch.</maml:para> <maml:para>Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis.</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="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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>- Access</maml:para> <maml:para>- Device</maml:para> <maml:para>- Others</maml:para> <maml:para>- Policy</maml:para> <maml:para>- Sync</maml:para> <maml:para>- Wipe</maml:para> <maml:para>You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-ExoMailbox property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</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)" 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: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>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>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>{{ Fill ExternalDirectoryObjectId Description }}</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>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>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>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>{{ Fill UserPrincipalName Description }}</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>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: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>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>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>{{ Fill ExternalDirectoryObjectId Description }}</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>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="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>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>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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> <command:syntax> <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: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 indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>For more information about the properties that are included in each property set, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MailboxMove</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> </command:parameterValueGroup> <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>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>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>- TeamMailbox</maml:para> <maml:para>- UserMailbox</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: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. 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>- Canonical DN</maml:para> <maml:para>- Email address</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>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</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 indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>For more information about the properties that are included in each property set, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MailboxMove</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> </command:parameterValueGroup> <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>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>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>- TeamMailbox</maml:para> <maml:para>- UserMailbox</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>{{ Fill UserPrincipalName Description }}</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>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: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>This parameter is reserved for internal Microsoft use.</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 indicates the OPath filter used to filter recipients.</maml:para> <maml:para>For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx).</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="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the recipient object that you want to view. 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>- Canonical DN</maml:para> <maml:para>- Email address</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>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="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. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>For more information about the properties that are included in each property set, see Get-ExoRecipient property sets (https://review.docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets?branch=ExORestModule-chrisda#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>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>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>- TeamMailbox</maml:para> <maml:para>- UserMailbox</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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/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 V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).</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://technet.microsoft.com/library/bb123552.aspx).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</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 filters the results by the target recipient. The user or group specified by the Trustee parameter can operate on this recipient.</maml:para> <maml:para>You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- External contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para>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>- Canonical DN</maml:para> <maml:para>- Email address</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>AccessRights</maml:name> <maml:Description> <maml:para>The AccessRights parameter filters the results by permission.</maml:para> <maml:para>The value value for this parameter is SendAs.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SendAs</command:parameterValue> </command:parameterValueGroup> <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>This parameter is reserved for internal Microsoft use.</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>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 to whom you're granting the permission. The user or group can operate on the recipient specified by the Identity parameter.</maml:para> <maml:para>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 (formerly known as a Windows Live ID)</maml:para> <maml:para>- Security groups</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 name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>{{ Fill UserPrincipalName Description }}</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>AccessRights</maml:name> <maml:Description> <maml:para>The AccessRights parameter filters the results by permission.</maml:para> <maml:para>The value 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>This parameter is reserved for internal Microsoft use.</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="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter filters the results by the target recipient. The user or group specified by the Trustee parameter can operate on this recipient.</maml:para> <maml:para>You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- External contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para>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>- Canonical DN</maml:para> <maml:para>- Email address</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>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 to whom you're granting the permission. The user or group can operate on the recipient specified by the Identity parameter.</maml:para> <maml:para>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 (formerly known as a Windows Live ID)</maml:para> <maml:para>- Security groups</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 name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>- User ID or user principal name (UPN)</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>{{ Fill UserPrincipalName Description }}</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> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></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>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/exchange-ps-v2-module/get-exorecipientpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |