Microsoft.Open.Azure.AD.CommonLibrary.dll-Help.xml
<?xml version="1.0" encoding="utf-16"?>
<!--This file has been auto-generated. Please do not make any manual changes to the file. All help text files are build from the text in "$(SRCROOT)\dev\PowerShell.V2\HelpFileUtilities\CompleteXmlHelpFile\AzureAD.Help.xml"--> <helpItems schema="maml" xmlns="http://msh"> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> <!--Rodejo 11/14/2016 Updated help and cleaned up file--> <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-AzureAD</command:name> <maml:description> <maml:para>Connect with an authenticated account to use Azure Active Directory cmdlet requests. </maml:para> </maml:description> <command:verb>Connect</command:verb> <command:noun>AzureAD</command:noun> </command:details> <maml:description> <maml:para>The Connect-AzureAD cmdlet connects an authenticated account to use for Azure Active Directory cmdlet requests. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-AzureAD</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AzureEnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanyCloud. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment+EnvironmentName</command:parameterValue> <dev:type> <maml:name>AzureEnvironment+EnvironmentName</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>TenantId</maml:name> <maml:Description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated to the home tenant of the user. You must specify the TenantID parameter to authenticate as a service principal or using Microsoft account. </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>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. The PSCredential object provides the user ID and password for organizational ID credentials. Note that you cannot connect to a tenant using the credential parameter if Multi Factor Authentication is enabled for the account </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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogLevel</maml:name> <maml:Description> <maml:para>Specifies the log level. Valid values are Info, Error, Warning, None. Default level is Info. The log file is in %localappdata%\Microsoft\AzureAD\Powershell </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</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>WhatIf</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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>Confirm</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <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-AzureAD</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AzureEnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanyCloud. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment+EnvironmentName</command:parameterValue> <dev:type> <maml:name>AzureEnvironment+EnvironmentName</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>TenantId</maml:name> <maml:Description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated to the home tenant of the user. You must specify the TenantID parameter to authenticate as a service principal or using Microsoft account. </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>LogLevel</maml:name> <maml:Description> <maml:para>Specifies the log level. Valid values are Info, Error, Warning, None. Default level is Info. The log file is in %localappdata%\Microsoft\AzureAD\Powershell </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</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>WhatIf</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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>Confirm</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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="False" position="named" aliases="none"> <maml:name>CertificateThumbprint</maml:name> <maml:Description> <maml:para>Secret for service principal credentials. </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="named" aliases="none"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para>Application ID of the service principal. </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:syntaxItem> <maml:name>Connect-AzureAD</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AzureEnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanyCloud. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment+EnvironmentName</command:parameterValue> <dev:type> <maml:name>AzureEnvironment+EnvironmentName</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>TenantId</maml:name> <maml:Description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated to the home tenant of the user. You must specify the TenantID parameter to authenticate as a service principal or using Microsoft account. </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>LogLevel</maml:name> <maml:Description> <maml:para>Specifies the log level. Valid values are Info, Error, Warning, None. Default level is Info. The log file is in %localappdata%\Microsoft\AzureAD\Powershell </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</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>WhatIf</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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>Confirm</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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="False" position="named" aliases="none"> <maml:name>AadAccessToken</maml:name> <maml:Description> <maml:para>Specifies a AAD Graph access token. </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>MsAccessToken</maml:name> <maml:Description> <maml:para>Specifies a MS Graph access token. </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="named" aliases="none"> <maml:name>AccountId</maml:name> <maml:Description> <maml:para>The UPN of the user when authenticating with a user access token. </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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AzureEnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanyCloud. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment+EnvironmentName</command:parameterValue> <dev:type> <maml:name>AzureEnvironment+EnvironmentName</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>TenantId</maml:name> <maml:Description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated to the home tenant of the user. You must specify the TenantID parameter to authenticate as a service principal or using Microsoft account. </maml:para> </maml:Description> <command:parameterValue required="false" 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>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. The PSCredential object provides the user ID and password for organizational ID credentials. Note that you cannot connect to a tenant using the credential parameter if Multi Factor Authentication is enabled for the account </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>LogLevel</maml:name> <maml:Description> <maml:para>Specifies the log level. Valid values are Info, Error, Warning, None. Default level is Info. The log file is in %localappdata%\Microsoft\AzureAD\Powershell </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</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>WhatIf</maml:name> <maml: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>Confirm</maml:name> <maml: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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateThumbprint</maml:name> <maml:Description> <maml:para>Secret for service principal credentials. </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="named" aliases="none"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para>Application ID of the service principal. </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="named" aliases="none"> <maml:name>AadAccessToken</maml:name> <maml:Description> <maml:para>Specifies a AAD Graph access token. </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>MsAccessToken</maml:name> <maml:Description> <maml:para>Specifies a MS Graph access token. </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="named" aliases="none"> <maml:name>AccountId</maml:name> <maml:Description> <maml:para>The UPN of the user when authenticating with a user access token. </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 /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Connect a powershell session to an azure AD tenant</maml:title> <dev:code>Connect-AzureAD</dev:code> <dev:remarks> <maml:para>This will connect your current PowerShell session to an AzureAD tenant. The command will prompt for a username and password for the tenant you want to connect to. The -Confirm parameter will bring up the prompt for confirmation. If multi-factor authentication is enabled for your credentials, you must log in using the interactive option or use service principal authentication. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Get credentials from the user, then connect the powershell session tot the tenant for those credentials</maml:title> <dev:code>$Credential = Get-Credential ; Connect-AzureAD -Credential $Credential</dev:code> <dev:remarks> <maml:para>The first command gets the user credentials, and then stores them in the $Credential variable. The second command connect your current PowerShell session with the credentials in $Credential. This account authenticates with AzureAD using organizational ID credentials. You cannot use multi-factor authentication or Microsoft account credentials to run AzureAD cmdlets with this account. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Connect your PowerShell session to a tenant using service principal credentials</maml:title> <dev:code>Connect-AzureAD -TenantId "xxxx-xxxx-xxxx-xxxx" -ApplicationId "xxxx-xxxx-xxxx-xxxx" -CertificateThumbprint "xxxx-xxxx-xxxx-xxxx"</dev:code> <dev:remarks> <maml:para>The command authenticate you to AzureAD as a service principal. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Connect your PowerShell session to a tenant in a specific environment</maml:title> <dev:code>Connect-AzureAD -AzureEnvironmentName AzureADChinaCloud</dev:code> <dev:remarks> <maml:para>Permissable values are AzureCloud, AzurePPE, AzureGermanyCloud, AzureChinaCloud and USGovernment </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>Disconnect-AzureAD</command:name> <command:verb>Disconnect</command:verb> <command:noun>AzureAD</command:noun> <maml:description> <maml:para>Disconnects the current session from an Azure AD tenant </maml:para> </maml:description> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-AzureAD</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="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>Confirm</maml:name> <maml:Description> <maml:para /> </maml:Description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <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>WhatIf</maml:name> <maml: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>Confirm</maml:name> <maml: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:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Disconnects your PowerShell session from a tenant</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Disconnect-AzureAD</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> </helpItems> |