en-US/PSCloudConnect-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-LAConnected</command:name> <command:verb>Get</command:verb> <command:noun>LAConnected</command:noun> <maml:description><maml:para>Connects to Office 365 services and/or Azure To install: Install-Module PSCloudConnect -Scope CurrentUser To update to the latest version: Update-Module PSCloudConnect </maml:para> </maml:description> </command:details> <maml:description><maml:para>Connects to Office 365 services and/or Azure. </maml:para> <maml:para>Connects to some or all of the Office 365/Azure services based on switches provided at runtime. </maml:para> <maml:para>Office 365 tenant name, for example, either contoso or contoso.onmicrosoft.com must be provided with -Tenant parameter. Additionally, if more than one username will be used against a single tenant, use the -User parameter (for the second username and on). Use anything unique to that username so the credential can be properly saved. Both the -Tenant and -User parameters are positional so it's not necessary to type -Tenant or -User. The -Tenant parameter is mandatory while the -User parameter is optional. </maml:para> <maml:para>For example, Get-LaConnected Contoso -Exchange demonstrates how it is not necessary to use the -User parameter and how the -Tenant parameter is positional. However, say I want to connect to the Contoso tenant as frank@contoso.com I could use Get-LaConnected Contoso Frank -Exchange When just connecting to Azure, it is still required to provide a Tenant, anything that uniquely identifies it. </maml:para> <maml:para>There is a switch to use Multi-Factor Authentication. For Exchange Online MFA, you are required to download and use the Exchange Online Remote PowerShell Module. To download the Exchange Online Remote PowerShell Module for multi-factor authentication, in the EAC (https://outlook.office365.com/ecp/), go to Hybrid > Setup and click the appropriate Configure button. When using Multi-Factor Authentication the saving of credentials is not available currently - thus each service will prompt independently for credentials. Also the Security and Compliance Center does not currently support multi-factor authentication. </maml:para> <maml:para>Locally saves and encrypts to a file the username and password. The encrypted file...can only be used on the computer and within the user's profile from which it was created, is the same .txt file for all the Office 365 services and is a separate .json file for Azure. If a username or password becomes corrupt or is entered incorrectly, it can be deleted using -Delete365Creds. For example, Get-LaConnected Contoso -Delete365Creds If Azure switch is used for first time : </maml:para> <maml:para>1. User will login as normal when prompted by Azure 2. User will be prompted to select which Azure Subscription 3. Select the subscription and click "OK" </maml:para> <maml:para>If Azure switch is used after first time: </maml:para> <maml:para>1. User will be prompted to pick username used previously 2. If a new username is to be used (e.g. username not found when prompted), click Cancel to be prompted to login. 3. User will be prompted to select which Azure Subscription 4. Select the subscription and click "OK" </maml:para> <maml:para>Directories used/created during the execution of this script </maml:para> <maml:para>1. $env:USERPROFILE\ps\ 2. $env:USERPROFILE\ps\creds\ </maml:para> <maml:para>All saved credentials are saved in $env:USERPROFILE\ps\creds\ Transcript is started and kept in $env:USERPROFILE\ps<tenantspecified> </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-LAConnected</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Tenant</maml:name> <maml:Description><maml:para>{{The Tenant Name}} </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>All365</maml:name> <maml:Description><maml:para>{{All Office 365 Services}} </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>Azure</maml:name> <maml:Description><maml:para>{{Microsoft Azure}} </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>{{Microsoft Skype}} </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>{{Microsoft SharePoint}} </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>Compliance</maml:name> <maml:Description><maml:para>{{Office 365 Security and Compliance Center}} </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>AzureADver2</maml:name> <maml:Description><maml:para>{{Azure Active Directory Version 2}} </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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>Delete365Creds</maml:name> <maml:Description><maml:para>{{Fill Delete365Creds Description}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Exchange</maml:name> <maml:Description><maml:para>{{Fill Exchange Description}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MFA</maml:name> <maml:Description><maml:para>{{Fill MFA Description}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MSOnline</maml:name> <maml:Description><maml:para>{{Fill MSOnline Description}} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>User</maml:name> <maml:Description><maml:para>{{Fill User Description}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Tenant</maml:name> <maml:Description><maml:para>{{The Tenant Name}} </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>All365</maml:name> <maml:Description><maml:para>{{All Office 365 Services}} </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>Azure</maml:name> <maml:Description><maml:para>{{Microsoft Azure}} </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>{{Microsoft Skype}} </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>{{Microsoft SharePoint}} </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>Compliance</maml:name> <maml:Description><maml:para>{{Office 365 Security and Compliance Center}} </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>AzureADver2</maml:name> <maml:Description><maml:para>{{Azure Active Directory Version 2}} </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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>Delete365Creds</maml:name> <maml:Description><maml:para>{{Fill Delete365Creds Description}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Exchange</maml:name> <maml:Description><maml:para>{{Fill Exchange Description}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MFA</maml:name> <maml:Description><maml:para>{{Fill MFA Description}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MSOnline</maml:name> <maml:Description><maml:para>{{Fill MSOnline Description}} </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>User</maml:name> <maml:Description><maml:para>{{Fill User Description}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command: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 -Exchange -MSOnline</dev:code> <dev:remarks><maml:para>Connects to MS Online Service (MSOL) and Exchange Online </maml:para> <maml:para>The tenant must be specified, for example either contoso or contoso.onmicrosoft.com </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LAConnected Contoso -Skype -Azure -Exchange -MSOnline</dev:code> <dev:remarks><maml:para>Connects to Azure, MS Online Service (MSOL), Exchange Online & Skype </maml:para> <maml:para>This is to illustrate that any number of individual services can be used to connect. Also that the -Tenant parameter is positional </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -SharePoint</dev:code> <dev:remarks><maml:para>Connects to SharePoint Online </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -Delete365Creds</dev:code> <dev:remarks><maml:para>The switch, Delete365Creds can be used if invalid credentials were inadvertently entered. Typically, the symptom would be a user would be prompted each time for credentials, as the saved credential is invalid. Use this switch with the mandatory Tenant parameter to delete the appropriate credentials. Credentials will then be saved on the following login. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -Compliance</dev:code> <dev:remarks><maml:para>Connects to Compliance & Security Center </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -All365</dev:code> <dev:remarks><maml:para>Connects to MS Online Service (MSOL), Exchange Online, Skype, SharePoint & Compliance </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -All365 -Azure</dev:code> <dev:remarks><maml:para>Connects to Azure, MS Online Service (MSOL), Exchange Online, Skype, SharePoint & Compliance </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>Get-LAConnected -Tenant Contoso -Skype -Exchange -MSOnline</dev:code> <dev:remarks><maml:para>Connects to MS Online Service (MSOL) and Exchange Online and Skype Online </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> </helpItems> |