xEXOUserAvailability

0.1.8.0

en-US/Get-OSCEXOUserAvailability-Help.xml

                                <?xml version="1.0" encoding="UTF-8"?>

<helpItems xmlns="http://msh" schema="maml">

  <command:command xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:maml="http://schemas.microsoft.com/maml/2004/10">

    <command:details>

      <command:name>Get-OSCEXOUserAvailability </command:name>

      <maml:description>

        <maml:para>Returns the availability information for specific Office 365 Exchange Online users.</maml:para>

      </maml:description>

      <maml:copyright>

        <maml:para></maml:para>

      </maml:copyright>

      <command:verb>Get</command:verb>

      <command:noun>OSCEXOUserAvailability</command:noun>

      <dev:version></dev:version>

    </command:details>

    <maml:description>

      <maml:para>The Get-OSCEXOUserAvailability will attempt to return the availability information for specific Office 365 Exchange Online users.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-OSCEXOUserAvailability </maml:name>

        <command:parameter globbing="false" variableLength="false" position="1" required="true" pipelineInput="true">

          <maml:name>Identity</maml:name>

          <maml:description>

            <maml:para>Specifies alias or email address of an Office 365 user.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

        </command:parameter>

        <command:parameter globbing="false" variableLength="false" position="2" required="false" pipelineInput="false">

          <maml:name>StartDate</maml:name>

          <maml:description>

            <maml:para>Specifies the start date of a time range.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue>

        </command:parameter>

        <command:parameter globbing="false" variableLength="false" position="3" required="false" pipelineInput="false">

          <maml:name>EndDate</maml:name>

          <maml:description>

            <maml:para>Specifies the end date of a time range.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter globbing="false" variableLength="false" position="1" required="true" pipelineInput="true">

        <maml:name>Identity</maml:name>

        <maml:description>

          <maml:para>Specifies alias or email address of an Office 365 user.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

        <dev:type>

          <maml:name>string</maml:name>

          <maml:uri></maml:uri>

          <maml:description>

            <maml:para></maml:para>

          </maml:description>

        </dev:type>

        <dev:defaultValue></dev:defaultValue>

      </command:parameter>

      <command:parameter globbing="false" variableLength="false" position="2" required="false" pipelineInput="false">

        <maml:name>StartDate</maml:name>

        <maml:description>

          <maml:para>Specifies the start date of a time range.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue>

        <dev:type>

          <maml:name>datetime</maml:name>

          <maml:uri></maml:uri>

          <maml:description>

            <maml:para></maml:para>

          </maml:description>

        </dev:type>

        <dev:defaultValue>The current date and time</dev:defaultValue>

      </command:parameter>

      <command:parameter globbing="false" variableLength="false" position="3" required="false" pipelineInput="false">

        <maml:name>EndDate</maml:name>

        <maml:description>

          <maml:para>Specifies the end date of a time range.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue>

        <dev:type>

          <maml:name>datetime</maml:name>

          <maml:uri></maml:uri>

          <maml:description>

            <maml:para></maml:para>

          </maml:description>

        </dev:type>

        <dev:defaultValue>The current date and time plus one day</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri></maml:uri>

          <maml:description></maml:description>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSObject </maml:name>

          <maml:uri></maml:uri>

          <maml:description></maml:description>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <command:terminatingErrors></command:terminatingErrors>

    <command:nonTerminatingErrors></command:nonTerminatingErrors>

    <maml:alertSet>

      <maml:title>Explanation for the Value of Subject Column</maml:title>

      <maml:alert>

        <maml:para>

          By default, the subject contains column contains the meeting organizer name for room mailboxes. If you want to see the subject of meeting, please use following command to change the settings of calendar processing for room mailboxes.

Set-CalendarProcessing -Identity 'Room Mailbox Identity' -DeleteSubject $false -AddOrganizerToSubject $false

        </maml:para>

      </maml:alert>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <maml:introduction>

          <maml:para>PS C:\&gt;</maml:para>

        </maml:introduction>

        <dev:code>Get-OSCEXOUserAvailability -Identity "johnd" | FT -AutoSize</dev:code>

        <dev:remarks>

          <maml:para>Description</maml:para>

          <maml:para>-----------</maml:para>

          <maml:para>Returns the availability information of John Doe (johnd). You can only see the free and busy status with the default permission.</maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

        <command:commandLines>

          <command:commandLine>

            <command:commandText></command:commandText>

          </command:commandLine>

        </command:commandLines>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <maml:introduction>

          <maml:para>PS C:\&gt;</maml:para>

        </maml:introduction>

        <dev:code>Get-OSCEXOUserAvailability -Identity "room 103" -StartDate "5/1/2013" -EndDate "5/31/2013" | FT -AutoSize </dev:code>

        <dev:remarks>

          <maml:para>Description</maml:para>

          <maml:para>-----------</maml:para>

          <maml:para>Returns the availability information of Room Mailbox 103 (room 103) in May.</maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

        <command:commandLines>

          <command:commandLine>

            <command:commandText></command:commandText>

          </command:commandLine>

        </command:commandLines>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <maml:introduction>

          <maml:para>PS C:\&gt;</maml:para>

        </maml:introduction>

        <dev:code>"room 101","room 102","room 103" | Get-OSCEXOUserAvailability -StartDate "5/1/2013" -EndDate "5/31/2013" | FT -AutoSize </dev:code>

        <dev:remarks>

          <maml:para>Description</maml:para>

          <maml:para>-----------</maml:para>

          <maml:para>Returns the availability information of multiple room mailbox in May.</maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

        <command:commandLines>

          <command:commandLine>

            <command:commandText></command:commandText>

          </command:commandLine>

        </command:commandLines>

      </command:example>

    </command:examples>

    <maml:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Windows PowerShell Advanced Function</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Getting user free/busy information by using the EWS Managed API</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Set-CalendarProcessing</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </maml:relatedLinks>

  </command:command>

</helpItems>