en-US/Connect-ClientAzureADTenant-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-ClientAzureADTenant</command:name> <command:verb>Connect</command:verb> <command:noun>ClientAzureADTenant</command:noun> <maml:description> <maml:para>Given a valid Azure Tenant ID, will connect via delegated rights to that tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Supports MFA - Given a valid Azure Tenant ID, will connect via delegated rights to that tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-ClientAzureADTenant</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="CustomerContextId"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>CustomerContextId that you can find by searching Azure AD using Find-AzureTenantIdByName</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="True (ByPropertyName)" position="0" aliases="CustomerContextId"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>CustomerContextId that you can find by searching Azure AD using Find-AzureTenantIdByName</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>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</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>----------------- Connecting with a Tenant ID -----------------</maml:title> <dev:code>PS C:\> Connect-ClientAzureADTenant 00000000-0000-0000-0000-000000000000</dev:code> <dev:remarks> <maml:para>If you have a valid Tenant ID, you can enter it in to connect directly.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------- Searching and Connecting -------------------</maml:title> <dev:code>PS C:\> Find-AzureTenantIdByName "contoso" | Connect-ClientAzureADTenant</dev:code> <dev:remarks> <maml:para>Requires first connecting to your tenant that has a partner relationship with the target tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://rearmedhalo.github.io/DUST/Connect-ClientAzureADTenant.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AzureTenantIdByName</maml:linkText> <maml:uri>https://rearmedhalo.github.io/DUST/Find-AzureTenantIdByName.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureADContract</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azuread/get-azureadcontact</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |