Connect-Entra

Modul:: Microsoft.Entra.Authentication Module v1.3

Anslut till Microsoft Entra ID med ett autentiserat konto.

Syntax

UserParameterSet (Standard)

Connect-Entra
[[-Scopes]
    [[-Scopes] <String[]>]
    [[-ClientId] <String>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-UseDeviceCode]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AppCertificateParameterSet

Connect-Entra
[-ClientId]
    [-ClientId] <String>
    [[-CertificateSubjectName] <String>]
    [[-CertificateThumbprint] <String>]
    [-SendCertificateChain <Boolean>]
    [-Certificate <X509Certificate2>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

IdentityParameterSet

Connect-Entra
[[-ClientId]
    [[-ClientId] <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-Identity]
    [-NoWelcome]
    [<CommonParameters>]

AppSecretCredentialParameterSet

Connect-Entra
[-ClientSecretCredential
    [-ClientSecretCredential <PSCredential>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AccessTokenParameterSet

Connect-Entra
[-AccessToken]
    [-AccessToken] <SecureString>
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

EnvironmentVariableParameterSet

Connect-Entra
[-ContextScope
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-EnvironmentVariable]
    [-NoWelcome]
    [<CommonParameters>]

Description

Cmdleten Connect-Entra ansluter till Microsoft Entra ID med ett autentiserat konto.

Flera autentiseringsscenarier stöds baserat på ditt användningsfall, till exempel delegerade (interaktiva) och endast appar (icke-interaktiva).

Connect-Entra är ett alias för Connect-MgGraph.

Exempel

Exempel 1: Delegerad åtkomst: Ansluta en PowerShell-session till en klientorganisation

Connect-Entra

Det här exemplet visar hur du ansluter din aktuella PowerShell-session till en Microsoft Entra ID klientorganisation med hjälp av autentiseringsuppgifter.

Exempel 2: Delegerad åtkomst: Ansluta en PowerShell-session till en klientorganisation med nödvändiga omfång

Connect-Entra -Scopes 'User.Read.All', 'Group.ReadWrite.All'

Welcome to Microsoft Graph!

Det här exemplet visar hur du autentiserar för att Microsoft Entra ID med omfång.

Exempel 3: Delegerad åtkomst: Använda en åtkomsttoken

$secureString = ConvertTo-SecureString -String $AccessToken -AsPlainText -Force
Connect-Entra -AccessToken $secureString

Welcome to Microsoft Graph!

Det här exemplet visar hur du interaktivt autentiserar till Microsoft Entra ID med hjälp av en åtkomsttoken.

Mer information om hur du hämtar eller skapar åtkomsttoken finns i Begär en åtkomsttoken.

Exempel 4: Delegerad åtkomst: Använda enhetskodflöde

Connect-Entra -UseDeviceCode

To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code A1B2CDEFGH to authenticate.

Det här exemplet visar hur du interaktivt autentiserar till Microsoft Entra ID med hjälp av enhetskodflöde.

Mer information finns i Enhetskodflöde.

Exempel 5: Endast appåtkomst: Använda klientautentiseringsuppgifter med tumavtryck för certifikat

$connectParams = @{
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    ApplicationId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    CertificateThumbprint = 'AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00'
}

Connect-Entra @connectParams

Welcome to Microsoft Graph!

Det här exemplet visar hur du autentiserar med hjälp av ett ApplicationId och CertificateThumbprint.

Mer information om hur du hämtar eller skapar CertificateThumbprint finns i Autentisera med endast appåtkomst.

Exempel 6: Åtkomst endast för appar: Använda klientautentiseringsuppgifter med ett certifikatnamn

$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    CertificateName = 'YOUR_CERT_SUBJECT'
}

Connect-Entra @params

 $Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
 Connect-Entra -ClientId '<App-Id>' -TenantId '<Tenant-Id>' -Certificate $Cert

Du hittar certifikatämnet genom att köra kommandot ovan.

Exempel 7: Endast appåtkomst: Använda klientautentiseringsuppgifter med ett certifikat

$Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    Certificate = $Cert
}

Connect-Entra @params

Exempel 8: Endast appåtkomst: Använda autentiseringsuppgifter för klienthemligheter

$ClientSecretCredential = Get-Credential -Credential '00001111-aaaa-2222-bbbb-3333cccc4444'
# Enter client_secret in the password prompt.
Connect-Entra -TenantId 'aaaabbbb-0000-cccc-1111-dddd2222eeee' -ClientSecretCredential $ClientSecretCredential

Den här autentiseringsmetoden är idealisk för bakgrundsinteraktioner.

Mer information om hur du hämtar autentiseringsuppgifter finns i Kommandot Get-Credential .

Exempel 9: Endast appåtkomst: Använda hanterad identitet: Systemtilldelad hanterad identitet

Connect-Entra -Identity

Använder en automatiskt hanterad identitet på en tjänstinstans. Identiteten är kopplad till livscykeln för en tjänstinstans.

Exempel 10: Endast appåtkomst: Använda hanterad identitet: Användartilldelad hanterad identitet

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Använder en användarskapad hanterad identitet som en fristående Azure resurs.

Exempel 11: Ansluta till en miljö som en annan identitet

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Om du vill ansluta som en annan identitet än CurrentUser anger du parametern ContextScope med värdet Process.

Mer information om hur du hämtar den aktuella kontexten finns i kommandot Get-EntraContext .

Exempel 12: Ansluta till en miljö eller ett moln

Get-EntraEnvironment

Name     AzureADEndpoint                   GraphEndpoint                           Type
----     ---------------                   -------------                           ----
China    https://login.chinacloudapi.cn    https://microsoftgraph.chinacloudapi.cn Built-in
Global   https://login.microsoftonline.com https://graph.microsoft.com             Built-in
USGov    https://login.microsoftonline.us  https://graph.microsoft.us              Built-in
USGovDoD https://login.microsoftonline.us  https://dod-graph.microsoft.us          Built-in

Connect-Entra -Environment 'Global'

När du använder Connect-Entra kan du välja att rikta in dig på andra miljöer. Som standard riktar Connect-Entra in sig på det globala offentliga molnet.

Exempel 13: Anger tidsgränsen för HTTP-klienten i sekunder

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

I det här exemplet anges tidsgränsen för HTTP-klienten i sekunder.

Exempel 14: Döljer välkomstmeddelandet

Connect-Entra -NoWelcome

Det här exemplet döljer välkomstmeddelandet.

Exempel 15: Tillåter autentisering med hjälp av miljövariabler

Connect-Entra -EnvironmentVariable

Det här exemplet tillåter autentisering med hjälp av miljövariabler.

Parametrar

-AccessToken

Anger en ägartoken för Microsoft Entra-tjänsten. Åtkomsttoken överskrider tidsgränsen och du måste hantera uppdateringen.

Parameteregenskaper

Typ:	SecureString
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

AccessTokenParameterSet

Position:	Named
Obligatorisk:	True
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Certificate

Ett X.509-certifikat som tillhandahålls under anropet.

Parameteregenskaper

Typ:	X509Certificate2
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-CertificateSubjectName

Certifikatets unika namn. Certifikatet hämtas från den aktuella användarens certifikatarkiv.

Parameteregenskaper

Typ:	System.String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	CertificateSubject, CertificateName

Parameteruppsättningar

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-CertificateThumbprint

Anger certifikatets tumavtryck för ett X.509-certifikat för en digital offentlig nyckel för ett användarkonto som har behörighet att utföra den här åtgärden.

Parameteregenskaper

Typ:	System.String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-ClientId

Anger program-ID för tjänstens huvudnamn.

Parameteregenskaper

Typ:	System.String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	AppId, ApplicationId

Parameteruppsättningar

UserParameterSet

Position:	1
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

IdentityParameterSet

Position:	1
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

AppCertificateParameterSet

Position:	1
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-ClientSecretCredential

PSCredential-objektet tillhandahåller program-ID och klienthemlighet för autentiseringsuppgifter för tjänstens huvudnamn. Om du vill ha mer information om PSCredential-objektet skriver du Get-Help Get-Credential.

Parameteregenskaper

Typ:	PSCredential
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	SecretCredential, Credential

Parameteruppsättningar

AppSecretCredentialParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-ClientTimeout

Anger tidsgränsen för HTTP-klienten i sekunder.

Parameteregenskaper

Typ:	System.Double
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-ContextScope

Avgör omfånget för autentiseringskontexten. Detta ContextScope accepterar Process för den aktuella processen eller CurrentUser för alla sessioner som startas av användaren.

Parameteregenskaper

Typ:	ContextScope
Standardvärde:	None
Godkända värden:	Process, CurrentUser
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

UserParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

IdentityParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

AppSecretCredentialParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

EnvironmentVariableParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Environment

Namnet på den nationella molnmiljö som ska anslutas till. Som standard används det globala molnet.

Parameteregenskaper

Typ:	System.String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	Miljönamn, NationalCloud

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-EnvironmentVariable

Tillåter autentisering med hjälp av miljövariabler som konfigurerats på värddatorn. Se https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Parameteregenskaper

Typ:	System.Management.Automation.SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

EnvironmentVariableParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Identity

Logga in med en hanterad identitet

Parameteregenskaper

Typ:	System.Management.Automation.SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	ManagedIdentity, ManagedServiceIdentity, MSI

Parameteruppsättningar

IdentityParameterSet

Position:	1
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-NoWelcome

Döljer välkomstmeddelandet.

Parameteregenskaper

Typ:	System.Management.Automation.SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Scopes

En matris med delegerade behörigheter att samtycka till.

Parameteregenskaper

Typ:	System.String[]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

UserParameterSet

Position:	1
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-SendCertificateChain

Inkludera x5c-huvudet i klientanspråk när du hämtar en token för att aktivera ämnesnamn/utfärdarbaserad autentisering med angivet certifikat.

Parameteregenskaper

Typ:	Boolean
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-TenantId

Anger ID för en klientorganisation.

Om du inte anger den här parametern autentiseras kontot med hemklientorganisationen.

Du måste ange parametern TenantId för att autentisera som tjänstens huvudnamn eller när du använder Microsoft-konto.

Parameteregenskaper

Typ:	System.String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	Målgrupp, Tenant

Parameteruppsättningar

UserParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

AppCertificateParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

AppSecretCredentialParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-UseDeviceCode

Använd enhetskodautentisering i stället för en webbläsarkontroll.

Parameteregenskaper

Typ:	System.Management.Automation.SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Enhet

Parameteruppsättningar

UserParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Disconnect-Entra

Feedback

Var den här sidan till hjälp?

Connect-Entra

Syntax

UserParameterSet (Standard)

AppCertificateParameterSet

IdentityParameterSet

AppSecretCredentialParameterSet

AccessTokenParameterSet

EnvironmentVariableParameterSet

Description

Exempel

Exempel 1: Delegerad åtkomst: Ansluta en PowerShell-session till en klientorganisation

Exempel 2: Delegerad åtkomst: Ansluta en PowerShell-session till en klientorganisation med nödvändiga omfång

Exempel 3: Delegerad åtkomst: Använda en åtkomsttoken

Exempel 4: Delegerad åtkomst: Använda enhetskodflöde

Exempel 5: Endast appåtkomst: Använda klientautentiseringsuppgifter med tumavtryck för certifikat

Exempel 6: Åtkomst endast för appar: Använda klientautentiseringsuppgifter med ett certifikatnamn

Exempel 7: Endast appåtkomst: Använda klientautentiseringsuppgifter med ett certifikat

Exempel 8: Endast appåtkomst: Använda autentiseringsuppgifter för klienthemligheter

Exempel 9: Endast appåtkomst: Använda hanterad identitet: Systemtilldelad hanterad identitet

Exempel 10: Endast appåtkomst: Använda hanterad identitet: Användartilldelad hanterad identitet

Exempel 11: Ansluta till en miljö som en annan identitet

Exempel 12: Ansluta till en miljö eller ett moln

Exempel 13: Anger tidsgränsen för HTTP-klienten i sekunder

Exempel 14: Döljer välkomstmeddelandet

Exempel 15: Tillåter autentisering med hjälp av miljövariabler

Parametrar

-AccessToken

Parameteregenskaper

Parameteruppsättningar

-Certificate

Parameteregenskaper

Parameteruppsättningar

-CertificateSubjectName

Parameteregenskaper

Parameteruppsättningar

-CertificateThumbprint

Parameteregenskaper

Parameteruppsättningar

-ClientId

Parameteregenskaper

Parameteruppsättningar

-ClientSecretCredential

Parameteregenskaper

Parameteruppsättningar

-ClientTimeout

Parameteregenskaper

Parameteruppsättningar

-ContextScope

Parameteregenskaper

Parameteruppsättningar

-Environment

Parameteregenskaper

Parameteruppsättningar

-EnvironmentVariable

Parameteregenskaper

Parameteruppsättningar

-Identity

Parameteregenskaper

Parameteruppsättningar

-NoWelcome

Parameteregenskaper

Parameteruppsättningar

-Scopes

Parameteregenskaper

Parameteruppsättningar

-SendCertificateChain

Parameteregenskaper

Parameteruppsättningar

-TenantId

Parameteregenskaper

Parameteruppsättningar

-UseDeviceCode

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Relaterade länkar

Feedback