SmallsOnline.TeamsAttendance.Pwsh

1.0.1

en-US/SmallsOnline.TeamsAttendance.Pwsh-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>Export-ExoTeamsAttendance</command:name>
      <command:verb>Export</command:verb>
      <command:noun>ExoTeamsAttendance</command:noun>
      <maml:description>
        <maml:para>Export gathered Teams attendance reports.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Export Teams attendance reports collected with `Get-ExoTeamsAttendance` to CSV or XLSX files.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Export-ExoTeamsAttendance</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
          <maml:name>MeetingAttendanceItem</maml:name>
          <maml:description>
            <maml:para>Meeting attendance items returned from `Get-ExoTeamsAttendance`.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">MeetingAttendance[]</command:parameterValue>
          <dev:type>
            <maml:name>MeetingAttendance[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>OutputDirectory</maml:name>
          <maml:description>
            <maml:para>The directory to output the files to.</maml:para>
          </maml:description>
          <command:parameterValue required="true" 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="2" aliases="none">
          <maml:name>AsCsv</maml:name>
          <maml:description>
            <maml:para>Export the reports as CSV files instead of XLSX files.</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="2" aliases="none">
        <maml:name>AsCsv</maml:name>
        <maml:description>
          <maml:para>Export the reports as CSV files instead of XLSX files.</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 (ByValue)" position="0" aliases="none">
        <maml:name>MeetingAttendanceItem</maml:name>
        <maml:description>
          <maml:para>Meeting attendance items returned from `Get-ExoTeamsAttendance`.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">MeetingAttendance[]</command:parameterValue>
        <dev:type>
          <maml:name>MeetingAttendance[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>OutputDirectory</maml:name>
        <maml:description>
          <maml:para>The directory to output the files to.</maml:para>
        </maml:description>
        <command:parameterValue required="true" 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>SmallsOnline.TeamsAttendance.Lib.Models.MeetingAttendance[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Connect-ExchangeOnline
PS C:\&gt; Connect-MgGraph
PS C:\&gt; $meetingRecords = Get-ExoTeamsAttendance -MeetingOrganizerUpn "jwinger1@greendalecc.edu" -StartDate "2023-06-01" -EndDate "2023-06-10"
PS C:\&gt; $meetingRecords | Export-ExoTeamsAttendance -OutputDirectory ".\jwinger1-meetings\"</dev:code>
        <dev:remarks>
          <maml:para>Get the meetings organized by 'jwinger1@greendalecc.edu' and the attendees of the meetings between 2023-06-01 to 2023-06-10. Then export the reports to the directory `.\jwinger1-meetings` as XLSX files.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Connect-ExchangeOnline
PS C:\&gt; Connect-MgGraph
PS C:\&gt; $meetingRecords = Get-ExoTeamsAttendance -MeetingOrganizerUpn "jwinger1@greendalecc.edu" -StartDate "2023-06-01" -EndDate "2023-06-10"
PS C:\&gt; $meetingRecords | Export-ExoTeamsAttendance -OutputDirectory ".\jwinger1-meetings\" -AsCsv</dev:code>
        <dev:remarks>
          <maml:para>Get the meetings organized by 'jwinger1@greendalecc.edu' and the attendees of the meetings between 2023-06-01 to 2023-06-10. Then export the reports to the directory `.\jwinger1-meetings` as CSV files.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <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-ExoTeamsAttendance</command:name>
      <command:verb>Get</command:verb>
      <command:noun>ExoTeamsAttendance</command:noun>
      <maml:description>
        <maml:para>Get Teams meeting attendance records from audit logs.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get Teams meeting attendance records based off of audit log entries in Microsoft 365's "Unified Audit Log".</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-ExoTeamsAttendance</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>MeetingOrganizerUpn</maml:name>
          <maml:description>
            <maml:para>The UserPrincipalName of the user who organized the meetings.</maml:para>
          </maml:description>
          <command:parameterValue required="true" 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="2" aliases="none">
          <maml:name>StartDate</maml:name>
          <maml:description>
            <maml:para>The start date for the search.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
          <dev:type>
            <maml:name>DateOnly</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
          <maml:name>EndDate</maml:name>
          <maml:description>
            <maml:para>The end date for the search.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
          <dev:type>
            <maml:name>DateOnly</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">
          <maml:name>TimeZone</maml:name>
          <maml:description>
            <maml:para>The TimeZoneInfo object to convert the output times to. Defaults to your local system's timezone.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">TimeZoneInfo</command:parameterValue>
          <dev:type>
            <maml:name>TimeZoneInfo</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>[System.TimeZoneInfo]::Local</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-ExoTeamsAttendance</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>MeetingOrganizerUpn</maml:name>
          <maml:description>
            <maml:para>The UserPrincipalName of the user who organized the meetings.</maml:para>
          </maml:description>
          <command:parameterValue required="true" 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="2" aliases="none">
          <maml:name>StartDate</maml:name>
          <maml:description>
            <maml:para>The start date for the search.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
          <dev:type>
            <maml:name>DateOnly</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
          <maml:name>EndDate</maml:name>
          <maml:description>
            <maml:para>The end date for the search.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
          <dev:type>
            <maml:name>DateOnly</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">
          <maml:name>TimeZoneId</maml:name>
          <maml:description>
            <maml:para>The ID of the timezone to convert the output times to.</maml:para>
          </maml:description>
          <command:parameterValue required="true" 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="1" aliases="none">
        <maml:name>MeetingOrganizerUpn</maml:name>
        <maml:description>
          <maml:para>The UserPrincipalName of the user who organized the meetings.</maml:para>
        </maml:description>
        <command:parameterValue required="true" 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="2" aliases="none">
        <maml:name>StartDate</maml:name>
        <maml:description>
          <maml:para>The start date for the search.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
        <dev:type>
          <maml:name>DateOnly</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
        <maml:name>EndDate</maml:name>
        <maml:description>
          <maml:para>The end date for the search.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DateOnly</command:parameterValue>
        <dev:type>
          <maml:name>DateOnly</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">
        <maml:name>TimeZone</maml:name>
        <maml:description>
          <maml:para>The TimeZoneInfo object to convert the output times to. Defaults to your local system's timezone.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">TimeZoneInfo</command:parameterValue>
        <dev:type>
          <maml:name>TimeZoneInfo</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>[System.TimeZoneInfo]::Local</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">
        <maml:name>TimeZoneId</maml:name>
        <maml:description>
          <maml:para>The ID of the timezone to convert the output times to.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>SmallsOnline.TeamsAttendance.Lib.Models.MeetingAttendance[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>You will need to run 'Connect-ExchangeOnline' and 'Connect-MgGraph' before running this command, otherwise it will immediately throw an error.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Connect-ExchangeOnline
PS C:\&gt; Connect-MgGraph
PS C:\&gt; Get-ExoTeamsAttendance -MeetingOrganizerUpn "jwinger1@greendalecc.edu" -StartDate "2023-06-01" -EndDate "2023-06-10"</dev:code>
        <dev:remarks>
          <maml:para>Get the meetings organized by 'jwinger1@greendalecc.edu' and the attendees of the meetings between 2023-06-01 to 2023-06-10. Meeting join/leave times will be converted to the local system's timezone.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Connect-ExchangeOnline
PS C:\&gt; Connect-MgGraph
PS C:\&gt; Get-ExoTeamsAttendance -MeetingOrganizerUpn "jwinger1@greendalecc.edu" -StartDate "2023-06-01" -EndDate "2023-06-10" -TimeZoneId "Pacific Standard Time"</dev:code>
        <dev:remarks>
          <maml:para>Get the meetings organized by 'jwinger1@greendalecc.edu' and the attendees of the meetings between 2023-06-01 to 2023-06-10. Meeting join/leave times will be converted to 'Pacific Standard Time'.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>