en-US/PSCompliance-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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-LaComplianceCase</command:name> <command:verb>Get</command:verb> <command:noun>LaComplianceCase</command:noun> <maml:description><maml:para>Retrieve Office 365 Compliance Cases, holds and hold queries </maml:para> </maml:description> </command:details> <maml:description><maml:para>All Office 365 Compliance Cases are returned from the Office 365 Security & Compliance Center. Additionally, each case's hold (Exchange and/or SharePoint) are returned. </maml:para> <maml:para>Make sure you are first connected to the Office 365 compliance service. Simply use Get-LaConnected, e.g. Get-LaConnected -Tenant Contoso -Compliance </maml:para> <maml:para>Credit: https://support.office.com/en-us/article/Create-a-report-on-holds-in-eDiscovery-cases-in-Office-365-cca08d26-6fbf-4b2c-b102-b226e4cd7381 </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaComplianceCase</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaComplianceCase</dev:code> <dev:remarks><maml:para>User is prompted for path for output. Simply enter a path and not the file name: </maml:para> <maml:para>This is what the user will see: Enter a file path to save the report to a .csv file: </maml:para> <maml:para>Enter the following, for example: c:\scripts\test </maml:para> <maml:para>This is what the user will see: Enter a file path to save the report to a .csv file: </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaCompliancePolicy</command:name> <command:verb>Get</command:verb> <command:noun>LaCompliancePolicy</command:noun> <maml:description><maml:para>Report on each Office 365 Retention Policies, Label Polices (including Auto-Applied Label Policies) and the Labels linked to each (policy). </maml:para> </maml:description> </command:details> <maml:description><maml:para>Report on each Office 365 Retention Policies, Label Polices (including Auto-Applied Label Policies) and the Labels linked to each (policy). </maml:para> <maml:para>Make sure you are first connected to the Office 365 compliance service. Simply use Get-LaConnected, e.g. Get-LaConnected -Tenant Contoso -Compliance </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaCompliancePolicy</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaConnected -Tenant Contoso -Compliance Get-LaCompliancePolicy | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LaConnected -Tenant Contoso -Compliance Get-LaCompliancePolicy | Export-Csv ./labelsandpols.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaCompliancePolicyLocation</command:name> <command:verb>Get</command:verb> <command:noun>LaCompliancePolicyLocation</command:noun> <maml:description><maml:para>Reports on all Label Policies and Office 365 Retention Policies located in the Security and Compliance Center </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on all Label Policies and Office 365 Retention Policies located in the Security and Compliance Center Label Policies contain labels that are applied by end-users or with Auto-Apply (E5 license required). Note: Auto-Apply is by keyword or by Sensitive Data Types (Sensitive Data Types is only for OneDrive and SharePoint) Office 365 Retention Policies are applied by administrators. For Label Policies, this reports which users are presented with which labels. For Office 365 Retention Policies, this reports on where administrators have chosen to apply this policy. </maml:para> <maml:para>The Label or Retention Policies are set to (either include OR exclude) 4 different workflows. </maml:para> <maml:para>1. Exchange Email 2. SharePoint Sites 3. OneDrive Accounts 4. Office 365 Groups </maml:para> <maml:para>A Label or Retention Policy can contain either a set of inclusions or exclusions to one thru four of the above workflows. It is worth noting, a Label or Retention Policy cannot exclude the mailbox of USER01 and include the mailbox of USER02. </maml:para> <maml:para>So, when excluding certain mailboxes or sites for example, all other mailboxes or sites are included. In contrast, When including certain mailbox or sites, all other mailboxes or site are excluded. </maml:para> <maml:para>This function will display each policy and the included locations or the excluded locations of all 4 workflows. </maml:para> <maml:para>If the Location column displays, "ALL", then all locations of that workflow are included. For example, all mailboxes or all sharePoint sites. The location column will otherwise display a specific location, for example, a specific mailbox or specific SharePoint site. </maml:para> <maml:para>The ContentLocation column can have one of 8 possibilities (all of which are fairly self-explanatory): </maml:para> <maml:para>1. Exchange 2. SharePoint 3. OneDrive 4. Groups 5. Exchange_Exception 6. SharePoint_Exception 7. OneDrive_Exception 8. Groups_Exception </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaCompliancePolicyLocation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>All</maml:name> <maml:Description><maml:para>{{All Locations}} </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>Exchange</maml:name> <maml:Description><maml:para>{{Exchange Mailbox Locations}} </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>SharePoint</maml:name> <maml:Description><maml:para>{{SharePoint Locations}} </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>OneDrive</maml:name> <maml:Description><maml:para>{{OneDrive Locations}} </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>Skype</maml:name> <maml:Description><maml:para>{{Skype Locations}} </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>Groups</maml:name> <maml:Description><maml:para>{{Office 365 Modern Groups Locations}} </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>WithExceptions</maml:name> <maml:Description><maml:para>{{Included Location Exceptions}} </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>OnlyExceptions</maml:name> <maml:Description><maml:para>{{Only Include Locations Exceptions}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>All</maml:name> <maml:Description><maml:para>{{All Locations}} </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>Exchange</maml:name> <maml:Description><maml:para>{{Exchange Mailbox Locations}} </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>SharePoint</maml:name> <maml:Description><maml:para>{{SharePoint Locations}} </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>OneDrive</maml:name> <maml:Description><maml:para>{{OneDrive Locations}} </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>Skype</maml:name> <maml:Description><maml:para>{{Skype Locations}} </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>Groups</maml:name> <maml:Description><maml:para>{{Office 365 Modern Groups Locations}} </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>WithExceptions</maml:name> <maml:Description><maml:para>{{Included Location Exceptions}} </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>OnlyExceptions</maml:name> <maml:Description><maml:para>{{Only Include Locations Exceptions}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaCompliancePolicyLocation -All -WithExceptions | Out-GridView</dev:code> <dev:remarks><maml:para>This will display everything, so this is a good command to start with </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LaCompliancePolicyLocation -Exchange -OnlyExceptions | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-LaCompliancePolicyLocation -SharePoint -WithExceptions | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-LaCompliancePolicyLocation -SharePoint -OnlyExceptions | Export-Csv ./sharepointexceptions.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaComplianceSearch</command:name> <command:verb>Get</command:verb> <command:noun>LaComplianceSearch</command:noun> <maml:description><maml:para>Reports on Compliance Searches (the predecessor to Get-MailboxSearch) </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on Compliance Searches in the Office 365 Security & Compliance Center. The command New-ComplianceSearch does not put any mailboxes on hold, therefor this only reports on searches. Holds are all now created through eDiscovery cases in the Office 365 Security & Compliance Center. Again, this report simply reports on "Searches" </maml:para> <maml:para>Make sure you are first connected to the Office 365 compliance service. Simply use Get-LaConnected, e.g. Get-LaConnected -Tenant Contoso -Compliance </maml:para> <maml:para>** If run with the All switch, it will output all the searches, one per row and a column for each location (all locations of Exchange, SharePoint & PublicFolders) ** this report will report on everything </maml:para> <maml:para>If run with no switches, it will output all included Exchange mailboxes with each search name If run with the SharePoint switch, it will output all included SharePoint Sites with each search name If run with the PublicFolder switch, it will output if All or None of the Public Folders are searched with each search name </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaComplianceSearch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SharePoint</maml:name> <maml:Description><maml:para>{{SharePoint Locations}} </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>PublicFolder</maml:name> <maml:Description><maml:para>{{PublicFolder Locations}} </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>All</maml:name> <maml:Description><maml:para>{{All Locations}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SharePoint</maml:name> <maml:Description><maml:para>{{SharePoint Locations}} </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>PublicFolder</maml:name> <maml:Description><maml:para>{{PublicFolder Locations}} </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>All</maml:name> <maml:Description><maml:para>{{All Locations}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaComplianceSearch | Export-Csv ./Exchangecompliancesearch.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LaComplianceSearch -SharePoint | Export-Csv ./SharePointSearches.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-LaComplianceSearch -OneDrive | Export-Csv ./OneDriveSearches.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-LaComplianceSearch -PublicFolder | Export-Csv ./PublicFolderSearches.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-LaComplianceSearch -All | Export-Csv ./AllSearchesAllLocations.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaComplianceValue</command:name> <command:verb>Get</command:verb> <command:noun>LaComplianceValue</command:noun> <maml:description><maml:para>Reports on all mailboxes that have the values specified Specifically reports on either those mailboxes with these parameters (and those without, depending on what you specify): </maml:para> <maml:para>1. LitigationHoldEnabled 2. ArchiveEnabled 3. RetainDeletedItemsFor30Days 4. UseDatabaseRetentionDefaults 5. SingleItemRecoveryEnabled 6. InactiveMailboxes </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on all mailboxes that have the values specified at runtime. Either choose to Included or Exclude the value specified in the results that are returned. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaComplianceValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Filter</maml:name> <maml:Description><maml:para>{{Set on whether to Include or Exclude the Value}} </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Include</command:parameterValue> <command:parameterValue required="false" variableLength="false">Exclude</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>{{Choose the value that is to be included or excluded from the results}} </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">LitigationHoldEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">ArchiveEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">RetainDeletedItemsFor30Days</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseDatabaseRetentionDefaults</command:parameterValue> <command:parameterValue required="false" variableLength="false">SingleItemRecoveryEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">InactiveMailboxes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Filter</maml:name> <maml:Description><maml:para>{{Set on whether to Include or Exclude the Value}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>{{Choose the value that is to be included or excluded from the results}} </maml:para> </maml:Description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</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>Get-LaComplianceValue -Filter Exclude -Value LitigationHoldEnabled | Export-Csv ./onlythoseWITHOUTLitHold.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that do not have Litigation Hold enabled </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2</maml:title> <dev:code>Get-LaComplianceValue -Filter Include -Value LitigationHoldEnabled | Export-Csv ./onlythoseWITHLitHold.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that do have Litigation Hold enabled </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3</maml:title> <dev:code>Get-LaComplianceValue -Filter Exclude -Value ArchiveEnabled | Export-Csv ./onlythoseWITHOUTArchiveEnabled.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that do not have an archive mailbox </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4</maml:title> <dev:code>Get-LaComplianceValue -Filter Exclude -Value RetainDeletedItemsFor30Days | Export-Csv ./onlythosewithRetDelItemsLessthan30days.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that have RetainDeletedItemsFor set at less than 30 days </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 5</maml:title> <dev:code>Get-LaComplianceValue -Filter Exclude -Value UseDatabaseRetentionDefaults | Export-Csv ./onlythosewithUseDatabaseRetentionDefaultsSettoTrue.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that have UseDatabaseRetentionDefaults set to true </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 6</maml:title> <dev:code>Get-LaComplianceValue -Filter Exclude -Value SingleItemRecoveryEnabled | Export-Csv ./onlythoseWITHOUTSingleItemRecoveryEnabled.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on only those mailboxes that do not have SingleItemRecovery set to Enabled </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 7</maml:title> <dev:code>Get-LaComplianceValue -Filter Include -Value InactiveMailboxes | Export-Csv ./onlyInactiveMailboxes.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on all Inactive Mailboxes. Provides a more comprehensive report of many important parameters on each inactive mailbox </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 8</maml:title> <dev:code>Get-LaComplianceValue -Filter Exclude -Value InactiveMailboxes | Export-Csv ./onlyActiveMailboxes.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>Reports on all Mailboxes except Inactive Mailboxes. Provides a more comprehensive report of many important parameters on each mailbox </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaInPlaceHold</command:name> <command:verb>Get</command:verb> <command:noun>LaInPlaceHold</command:noun> <maml:description><maml:para>Reports on in-place holds from the legacy, Exchange specific, "Compliance Management > in-place eDiscovery & hold" </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on in-place holds from the legacy, Exchange specific, "Compliance Management > in-place eDiscovery & hold" This does not report on each mailbox that is on hold - Use Get-LaMailboxInPlaceHold to report on that (however that command provides only the legacy holds). To report on modern holds, use Get-LaComplianceCase to report on in-place holds from the new "Security and Compliance Center". </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaInPlaceHold</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaInPlaceHold | Export-Csv ./LegacyHolds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LaInPlaceHold | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxFolderSize</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxFolderSize</command:noun> <maml:description><maml:para>Retrieves each mailbox's: 1. entire TotalItemSize 2. and more specifically, TotalItemSize for just the RecoverableItems folder </maml:para> </maml:description> </command:details> <maml:description><maml:para>Requires mandatory value(s) from the pipeline. Specifically, objects that contain the mailbox's UserPrincipalName. A CSV is not mandatory as a command could pass the necessary information from the pipeline. However, a CSV could certainly be used to break up large data sets. </maml:para> <maml:para>Note: This function executes two commands per mailbox and could be subject to Office 365 throttling. Therefor, for large tenants it is best to break up mailboxes into CSV's of 5,000 or less UPNs. For best results, no more than 2 concurrent sessions of this function should be run. It may be necessary to contact Office 365 support to have some throttling reduced. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxFolderSize</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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:inputTypes> <command:returnValues></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 -identity user01@contoso.com | Select UserPrincipalName | Get-LaFolderSize</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaFolderSize | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaFolderSize | Export-Csv ./FolderSizes.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Import-Csv ./upns.csv | Get-LaFolderSize | Export-Csv ./FolderSizes.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>A CSV could look like this UserPrincipalName user01@contoso.com user02@contoso.com</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxInPlaceHold</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxInPlaceHold</command:noun> <maml:description><maml:para>Reports on the legacy In-Place Holds for each mailbox </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on the legacy In-Place Holds for each mailbox. For easy sorting and readability, if a mailbox has more than one In-Place Hold, the mailbox and the corresponding hold is listed, one per row. In other words, if a mailbox has 3 legacy holds, that mailbox will appear on three rows. </maml:para> <maml:para>Mailbox UPNs should be passed from the pipeline as demonstrated in the examples below. </maml:para> <maml:para>Individual mailboxes, all mailboxes, all mailboxes in a department are all possibilities. </maml:para> <maml:para>Also demonstrated in an example below is importing mailboxes (UPNs) from a CSV </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxInPlaceHold</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <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>WithoutInPlaceHold</maml:name> <maml:Description><maml:para>{{Gather users that have no in-place holds}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WithoutInPlaceHold</maml:name> <maml:Description><maml:para>{{Gather users that have no in-place holds}} </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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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 | Select UserPrincipalName | Get-LaMailboxInPlaceHold | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxInPlaceHold | Export-Csv .\legacyholds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Import-Csv .\upns.csv | Get-LaMailboxInPlaceHold | Export-Csv .\legacyHoldsbyMailbox.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-MsolUser -All -Department 'Human Resources' | Select UserPrincipalName | Get-LaMailboxInPlaceHold | Export-Csv .\HRsHolds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>A CSV could look like this UserPrincipalName user01@contoso.com user02@contoso.com</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxLitigationHold</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxLitigationHold</command:noun> <maml:description><maml:para>Reports on all mailboxes and whether or not they are on Litigation Hold. </maml:para> <maml:para>Additionally, can report on all mailboxes that do not have litigation hold enabled. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on all mailboxes and whether or not they are on Litigation Hold. </maml:para> <maml:para>Additionally, can report on all mailboxes that do not have litigation hold enabled. </maml:para> <maml:para>Mailbox UPNs should be passed from the pipeline as demonstrated in the examples below. </maml:para> <maml:para>Individual mailboxes, all mailboxes, all mailboxes in a department are all possibilities. </maml:para> <maml:para>Also demonstrated in an example below is importing mailboxes (UPNs) from a CSV </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxLitigationHold</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <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>LitigationHoldDisabledOnly</maml:name> <maml:Description><maml:para>{{Reports on Mailboxes the have Litigation Hold Disabled}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LitigationHoldDisabledOnly</maml:name> <maml:Description><maml:para>{{Reports on Mailboxes the have Litigation Hold Disabled}} </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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type><maml:name>Object[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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 | Select UserPrincipalName | Get-LaMailboxLitigationHold | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxLitigationHold | Export-Csv .\litigationholds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxLitigationHold -LitigationHoldDisabledOnly | Export-Csv .\litigationholds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>This example only reports on those that do NOT have Litigation Hold Enabled (notice the switch -LitigationHoldDisabledOnly) </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Import-Csv .\upns.csv | Get-LaMailboxLitigationHold | Export-Csv .\litholds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-MsolUser -All -Department 'Human Resources' | Select UserPrincipalName | Get-LaMailboxLitigationHold | Export-Csv .\HRlitigationholds.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>A CSV could look like this UserPrincipalName user01@contoso.com user02@contoso.com</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxMFA</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxMFA</command:noun> <maml:description><maml:para>Reports on several key indicators of the Managed Folder Assistant against one or more mailboxes or mailbox archives. Also, it can start the Managed Folder Assistant for one more or more mailboxes. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on several key indicators of the Managed Folder Assistant against one or more mailboxes or mailbox archives. Also, it can start the Managed Folder Assistant for one more or more mailboxes. </maml:para> <maml:para>Mailbox UPNs should be passed from the pipeline as demonstrated in the examples below. </maml:para> <maml:para>Individual mailboxes, all mailboxes, all mailboxes in a department are all possibilities. </maml:para> <maml:para>Also demonstrated in an example below is importing mailboxes (UPNs) from a CSV </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxMFA</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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>{{Reports on Archive Mailbox}} </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>StartMFA</maml:name> <maml:Description><maml:para>{{Actually Starts the MFA for Mailboxes passed at pipeline}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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>{{Reports on Archive Mailbox}} </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>StartMFA</maml:name> <maml:Description><maml:para>{{Actually Starts the MFA for Mailboxes passed at pipeline}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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 | Select UserPrincipalName | Get-LaMailboxMFA | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxMFA -Archive | Export-Csv .\MFAstatsForARCHIVEmailbox.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para>This command reports on the Managed Folder Assistant statistics for ARCHIVE mailboxes. Hence, the -Archive switch. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Mailbox -identity "user01@contoso.com" | Select UserPrincipalName | Get-LaMailboxMFA -StartMFA</dev:code> <dev:remarks><maml:para>This command starts the Managed Folder Assistant and could be subject to Microsoft throttling </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-MsolUser -All -Department 'Human Resources' | Select UserPrincipalName | Get-LaMailboxMFA -StartMFA</dev:code> <dev:remarks><maml:para>This command starts the Managed Folder Assistant and could be subject to Microsoft throttling </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxMFA | Export-Csv .\MFAstats.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Import-Csv .\upns.csv | Get-LaMailboxMFA | Export-Csv .\MFAstats.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Import-Csv .\upns.csv | Get-LaMailboxMFA | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>Get-MsolUser -All -Department 'Human Resources' | Select UserPrincipalName | Get-LaMailboxMFA | Export-Csv .\HRsMFAstats.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <dev:code>A CSV could look like this UserPrincipalName user01@contoso.com user02@contoso.com</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxOldestItem</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxOldestItem</command:noun> <maml:description><maml:para>Reports on the oldest item in a mailbox(es) </maml:para> <maml:para>3 methods to search for the oldest item </maml:para> <maml:para>1. Without any switches, searches entire mailbox not including the recoverable items folders 2. With -IncludeRecoverableItems switch, searches entire mailbox including recoverable items folders 3. With -RecoverableItemsOnly switch, searches only the recoverable items folders </maml:para> </maml:description> </command:details> <maml:description><maml:para>Users Additionally, each case's hold (Exchange and/or SharePoint) are returned. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxOldestItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs are passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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>IncludeRecoverableItems</maml:name> <maml:Description><maml:para>{{Include Recoverable Items Folder in the search for the oldest item}} </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>RecoverableItemsOnly</maml:name> <maml:Description><maml:para>{{Recoverable Items Folders are the only folders searched while looking for the oldest item in the mailbox}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeRecoverableItems</maml:name> <maml:Description><maml:para>{{Include Recoverable Items Folder in the search for the oldest item}} </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>RecoverableItemsOnly</maml:name> <maml:Description><maml:para>{{Recoverable Items Folders are the only folders searched while looking for the oldest item in the mailbox}} </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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"><maml:name>userprincipalname</maml:name> <maml:Description><maml:para>{{UPNs are passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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:inputTypes> <command:returnValues></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>Import-Csv .\upns.csv | Get-LaMailboxOldestItem | Out-GridView</dev:code> <dev:remarks><maml:para>Reports on the oldest item in the mailbox not including the recoverable items folders </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Get-LaMailboxOldestItem -IncludeRecoverableItems</dev:code> <dev:remarks><maml:para>Reports on the oldest item in the mailbox including the recoverable items folders </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Recipient -Filter "Department -eq 'Human Resources'" -RecipientType mailuser | Get-LaMailboxOldestItem -RecoverableItemsOnly</dev:code> <dev:remarks><maml:para>Reports on the oldest item in the mailbox - only searches in the recoverable items folders </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaMailboxRetentionPolicy</command:name> <command:verb>Get</command:verb> <command:noun>LaMailboxRetentionPolicy</command:noun> <maml:description><maml:para>Reports on which retention policy a mailbox or mailboxes have. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on which retention policy a mailbox or mailboxes have. Mailbox UPNs should be passed from the pipeline as demonstrated in the examples below. </maml:para> <maml:para>Individual mailboxes, all mailboxes, all mailboxes in a department are all possibilities. </maml:para> <maml:para>Also demonstrated in an example below is importing mailboxes (UPNs) from a CSV </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaMailboxRetentionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>list</maml:name> <maml:Description><maml:para>{{UPNs passed from the pipeline}} </maml:para> </maml:Description> <command:parameterValue required="true" 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:inputTypes> <command:returnValues></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 | Select UserPrincipalName | Get-LaMailboxRetentionPolicy | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Mailbox -ResultSize unlimited | Select UserPrincipalName | Get-LaMailboxRetentionPolicy | Export-Csv .\retentionpolicyofmailboxes.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Import-Csv .\upns.csv | Get-LaMailboxRetentionPolicy | Export-Csv .\ListofMailboxesandtheirRetentionPolicy.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-MsolUser -All -Department 'Human Resources' | Select UserPrincipalName | Get-LaMailboxRetentionPolicy | Export-Csv .\HRdeptRetentionPolicy.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>A CSV could look like this UserPrincipalName user01@contoso.com user02@contoso.com</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaRetention</command:name> <command:verb>Get</command:verb> <command:noun>LaRetention</command:noun> <maml:description><maml:para>Reports on Exchange Retention Policies, Retention Policy Tags and Retention Policy Tag Links </maml:para> </maml:description> </command:details> <maml:description><maml:para>Reports on Exchange Retention Policies, Retention Policy Tags and Retention Policy Tag Links </maml:para> <maml:para>This function will display all Retention Policy Tags and to which Retention Policy they are linked </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaRetention</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaRetention | Export-Csv ./Retention.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LaRetention | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></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-LaRetentionCount</command:name> <command:verb>Get</command:verb> <command:noun>LaRetentionCount</command:noun> <maml:description><maml:para>Retrieves the count of mailboxes with each retention policy </maml:para> </maml:description> </command:details> <maml:description><maml:para>The report will display each retention policy and how many mailboxes are assigned that particular policy </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LaRetentionCount</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></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-LaRetentionCount | Out-GridView</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2</maml:title> <dev:code>Get-LaRetentionCount | Export-Csv .\countofpoliciesassigned.csv -NoTypeInformation</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> </helpItems> |