Connect-Entra

Modul:

Microsoft.Entra.Authentication Module v1.3

Csatlakozzon a Microsoft Entra ID hitelesített fiókkal.

Syntax

UserParameterSet (Alapértelmezett)

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

A Connect-Entra parancsmag hitelesített fiókkal csatlakozik Microsoft Entra ID.

A használati eset alapján számos hitelesítési forgatókönyv támogatott, például delegált (interaktív) és csak alkalmazásalapú (nem interaktív).

Connect-Entra egy alias Connect-MgGraph számára.

Példák

1. példa: Delegált hozzáférés: PowerShell-munkamenet csatlakoztatása bérlőhöz

Connect-Entra

Ez a példa bemutatja, hogyan csatlakoztathatja az aktuális PowerShell-munkamenetet egy Microsoft Entra ID-bérlőhöz hitelesítő adatokkal.

2. példa: Delegált hozzáférés: PowerShell-munkamenet csatlakoztatása szükséges hatókörökkel rendelkező bérlőhöz

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

Welcome to Microsoft Graph!

Ez a példa bemutatja, hogyan hitelesíthető a hatókörökkel Microsoft Entra ID.

3. példa: Delegált hozzáférés: Hozzáférési jogkivonat használata

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

Welcome to Microsoft Graph!

Ez a példa bemutatja, hogyan hitelesíthető interaktívan Microsoft Entra ID hozzáférési jogkivonat használatával.

A hozzáférési jogkivonat beszerzéséről és létrehozásáról további információt a hozzáférési jogkivonat kérése című témakörben talál.

4. példa: Delegált hozzáférés: Eszközkód-folyamat használata

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.

Ez a példa bemutatja, hogyan hitelesíthető interaktívan Microsoft Entra ID eszközkód-folyamat használatával.

További információ: Eszközkód-folyamat.

5. példa: Csak alkalmazáshoz való hozzáférés: Ügyfél-hitelesítő adatok használata tanúsítvány-ujjlenyomattal

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

Ez a példa bemutatja, hogyan hitelesíthető az ApplicationId és a CertificateThumbprint használatával.

A CertificateThumbprint beszerzéséről és létrehozásáról további információt a Hitelesítés csak alkalmazás-hozzáféréssel című témakörben talál.

6. példa: Csak alkalmazáshoz való hozzáférés: Ügyfél hitelesítő adatainak használata tanúsítványnévvel

$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

A tanúsítvány tulajdonosát a fenti parancs futtatásával találja meg.

7. példa: Csak alkalmazáshoz való hozzáférés: Ügyfél-hitelesítő adatok használata tanúsítvánnyal

$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

8. példa: Csak alkalmazáshoz való hozzáférés: Titkos ügyfélkód hitelesítő adatainak használata

$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

Ez a hitelesítési módszer ideális háttérbeli interakciókhoz.

A hitelesítő adatok lekéréséről további információt a Get-Credential parancsban talál.

9. példa: Csak alkalmazáshoz való hozzáférés: Felügyelt identitás használata: Rendszer által hozzárendelt felügyelt identitás

Connect-Entra -Identity

Automatikusan felügyelt identitást használ egy szolgáltatáspéldányon. Az identitás egy szolgáltatáspéldány életciklusához van kötve.

10. példa: Csak alkalmazáshoz való hozzáférés: Felügyelt identitás használata: Felhasználó által hozzárendelt felügyelt identitás

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Egy felhasználó által létrehozott felügyelt identitást használ önálló Azure erőforrásként.

11. példa: Csatlakozás egy környezethez más identitásként

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Ha más identitásként szeretne csatlakozni, mint a CurrentUser, adja meg a ContextScope paramétert a Process értékkel.

Az aktuális környezet lekéréséről további információt a Get-EntraContext parancsban talál.

12. példa: Csatlakozás környezethez vagy felhőhöz

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'

A Connect-Entra használata esetén dönthet úgy, hogy más környezeteket céloz meg. Alapértelmezés szerint Connect-Entra a globális nyilvános felhőt célozza meg.

13. példa: A HTTP-ügyfél időtúllépésének beállítása másodpercben

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

Ez a példa másodpercek alatt állítja be a HTTP-ügyfél időtúllépését.

14. példa: Elrejti az üdvözlő üzenetet

Connect-Entra -NoWelcome

Ez a példa elrejti az üdvözlő üzenetet.

15. példa: Engedélyezi a környezeti változók használatával történő hitelesítést

Connect-Entra -EnvironmentVariable

Ez a példa lehetővé teszi a környezeti változók használatával történő hitelesítést.

Paraméterek

-AccessToken

Egy tulajdonosi jogkivonatot ad meg Microsoft Entra szolgáltatáshoz. A hozzáférési jogkivonatok időtúllépést hajtanak végre, és önnek kell kezelnie a frissítésüket.

Paramétertulajdonságok

Típus:	SecureString
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

AccessTokenParameterSet

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Certificate

A meghívás során megadott X.509-tanúsítvány.

Paramétertulajdonságok

Típus:	X509Certificate2
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-CertificateSubjectName

A tanúsítvány tulajdonosának megkülönböztető neve. A rendszer lekéri a tanúsítványt az aktuális felhasználó tanúsítványtárolójából.

Paramétertulajdonságok

Típus:	System.String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	CertificateSubject, Tanúsítványnév

Paraméterkészletek

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-CertificateThumbprint

Megadja egy olyan felhasználói fiók X.509 digitális nyilvános kulcsú tanúsítványának ujjlenyomatát, amely rendelkezik a művelet végrehajtásához engedéllyel.

Paramétertulajdonságok

Típus:	System.String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ClientId

A szolgáltatásnév alkalmazásazonosítóját adja meg.

Paramétertulajdonságok

Típus:	System.String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	AppId, ApplicationId

Paraméterkészletek

UserParameterSet

Position:	1
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

IdentityParameterSet

Position:	1
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

AppCertificateParameterSet

Position:	1
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ClientSecretCredential

A PSCredential objektum biztosítja az alkalmazásazonosítót és az ügyfél titkos kódját a szolgáltatásnév hitelesítő adataihoz. A PSCredential objektummal kapcsolatos további információkért írja be Get-Help Get-Credential parancsot.

Paramétertulajdonságok

Típus:	PSCredential
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	SecretCredential, Igazolás

Paraméterkészletek

AppSecretCredentialParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ClientTimeout

Beállítja a HTTP-ügyfél időtúllépését másodpercben.

Paramétertulajdonságok

Típus:	System.Double
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ContextScope

Meghatározza a hitelesítési környezet hatókörét. Ez a ContextScope elfogadja Process az aktuális folyamatot, vagy CurrentUser a felhasználó által indított összes munkamenetet.

Paramétertulajdonságok

Típus:	ContextScope
Alapértelmezett érték:	None
Elfogadott értékek:	Process, CurrentUser
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

UserParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

IdentityParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

AppSecretCredentialParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

EnvironmentVariableParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Environment

Annak a nemzeti felhőkörnyezetnek a neve, amelyhez csatlakozni szeretne. A rendszer alapértelmezés szerint globális felhőt használ.

Paramétertulajdonságok

Típus:	System.String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	KörnyezetNév, NationalCloud

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-EnvironmentVariable

Engedélyezi a hitelesítést a gazdagépen konfigurált környezeti változók használatával. Lásd: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Paramétertulajdonságok

Típus:	System.Management.Automation.SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

EnvironmentVariableParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Identity

Bejelentkezés felügyelt identitással

Paramétertulajdonságok

Típus:	System.Management.Automation.SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	ManagedIdentity, ManagedServiceIdentity, MSI

Paraméterkészletek

IdentityParameterSet

Position:	1
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-NoWelcome

Elrejti az üdvözlő üzenetet.

Paramétertulajdonságok

Típus:	System.Management.Automation.SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Scopes

Delegált engedélyek tömbje a hozzájáruláshoz.

Paramétertulajdonságok

Típus:	System.String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

UserParameterSet

Position:	1
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-SendCertificateChain

X5c-fejlécet is belefoglalhat az ügyféljogcímekbe, amikor jogkivonatot szerez be a tulajdonosnév/kiállítóalapú hitelesítés adott tanúsítvány használatával történő engedélyezéséhez.

Paramétertulajdonságok

Típus:	Boolean
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-TenantId

Egy bérlő azonosítóját adja meg.

Ha nem adja meg ezt a paramétert, a fiók hitelesítése az otthoni bérlővel történik.

Meg kell adnia a TenantId paramétert a szolgáltatásnévként való hitelesítéshez vagy Microsoft-fiók használatakor.

Paramétertulajdonságok

Típus:	System.String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	Közönség, Bérlő

Paraméterkészletek

UserParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

AppCertificateParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

AppSecretCredentialParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-UseDeviceCode

Használjon eszközkód-hitelesítést böngészővezérlő helyett.

Paramétertulajdonságok

Típus:	System.Management.Automation.SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Eszköz

Paraméterkészletek

UserParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Kapcsolódó hivatkozások

• Disconnect-Entra