Connect-MS365

1.0.0

en-us/Connect-MS365-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>Connect-MS365</command:name>

      <command:verb>Connect</command:verb>

      <command:noun>MS365</command:noun>

      <maml:description>

        <maml:para>Connects to a given online service of Microsoft.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Connects to a given online service of Microsoft. One or multiple service names can be chosen. Supports connection handling for - Microsoft Online (MSOL) - aka AzureAD v1</maml:para>

      <maml:para>- Exchange Online (EOL)</maml:para>

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

      <maml:para>- SharePoint Online (SPO)</maml:para>

      <maml:para>- Security and Compliance Center (SCC)</maml:para>

      <maml:para>- Azure ActiveDirectory (AAD) v2</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Connect-MS365</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>Service</maml:name>

          <maml:Description>

            <maml:para>Specifies the service to connect to. May be a list of multiple services to use.</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="SPOOrg">

          <maml:name>SPOOrgName</maml:name>

          <maml:Description>

            <maml:para>spoorg parameter for connection to SPO service needed by connect cmdlet to assemble admin Url</maml:para>

          </maml:Description>

          <command:parameterValue required="true" 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="4" aliases="none">

          <maml:name>MFA</maml:name>

          <maml:Description>

            <maml:para>Toggles MFA usage. Not requesting PSCredential object.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Connect-MS365</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>Service</maml:name>

          <maml:Description>

            <maml:para>Specifies the service to connect to. May be a list of multiple services to use.</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="SPOOrg">

          <maml:name>SPOOrgName</maml:name>

          <maml:Description>

            <maml:para>spoorg parameter for connection to SPO service needed by connect cmdlet to assemble admin Url</maml:para>

          </maml:Description>

          <command:parameterValue required="true" 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="4" aliases="none">

          <maml:name>Credential</maml:name>

          <maml:Description>

            <maml:para>Credential parameter to receive previously created PSCredential object. Primarily needed for testing calls</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>PSCredential</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="2" aliases="none">

        <maml:name>Service</maml:name>

        <maml:Description>

          <maml:para>Specifies the service to connect to. May be a list of multiple services to use.</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="SPOOrg">

        <maml:name>SPOOrgName</maml:name>

        <maml:Description>

          <maml:para>spoorg parameter for connection to SPO service needed by connect cmdlet to assemble admin Url</maml:para>

        </maml:Description>

        <command:parameterValue required="true" 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="4" aliases="none">

        <maml:name>MFA</maml:name>

        <maml:Description>

          <maml:para>Toggles MFA usage. Not requesting PSCredential object.</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="4" aliases="none">

        <maml:name>Credential</maml:name>

        <maml:Description>

          <maml:para>Credential parameter to receive previously created PSCredential object. Primarily needed for testing calls</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>PSCredential</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None. You cannot pipe objects to Add-Extension.</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>// &lt;OBJECTTYPE&gt;. TBD.</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>Description: Connect to Microsoft Online without using MFA</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service MSOL</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to Microsoft Online by using MFA</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service MSOL -MFA</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to Microsoft Online and Exchange Online by using MFA</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service MSOL,EOL -MFA</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to SharePoint Online without MFA to connect to MyName-admin.sharepoint.com</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service SPO -SPOOrgName MyName</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to SharePoint Online with MFA to connect to MyName-admin.sharepoint.com</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service SPO -SPOOrgName MyName -MFA</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to Security and Compliance Center with MFA</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service SCC -MFA</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>Description: Connect to Azure ActiveDirectory with MFA</dev:code>

        <dev:remarks>

          <maml:para>Connect-MS365 -Service AAD -MFA</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>https://github.com/blindzero/Connect-MS365</maml:linkText>

        <maml:uri>https://github.com/blindzero/Connect-MS365</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>