Connect-Entra

Module:

Microsoft.Entra.Authentication Module v1.3

Maak verbinding met Microsoft Entra ID met een geverifieerd account.

Syntax

UserParameterSet (Standaard)

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

De Connect-Entra cmdlet maakt verbinding met Microsoft Entra ID met een geverifieerd account.

Verschillende verificatiescenario's worden ondersteund op basis van uw use-case, zoals gedelegeerd (interactief) en app-only (niet-interactief).

Connect-Entra is een alias voor Connect-MgGraph.

Voorbeelden

Voorbeeld 1: Gedelegeerde toegang: Een PowerShell-sessie verbinden met een tenant

Connect-Entra

In dit voorbeeld ziet u hoe u uw huidige PowerShell-sessie verbindt met een Microsoft Entra ID-tenant met behulp van referenties.

Voorbeeld 2: Gedelegeerde toegang: Een PowerShell-sessie verbinden met een tenant met vereiste bereiken

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

Welcome to Microsoft Graph!

In dit voorbeeld ziet u hoe u zich kunt verifiëren bij Microsoft Entra ID met bereiken.

Voorbeeld 3: Gedelegeerde toegang: Een toegangstoken gebruiken

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

Welcome to Microsoft Graph!

In dit voorbeeld ziet u hoe u interactief kunt verifiëren bij Microsoft Entra ID met behulp van een toegangstoken.

Zie Een toegangstoken aanvragen voor meer informatie over het ophalen of maken van een toegangstoken.

Voorbeeld 4: Gedelegeerde toegang: Apparaatcodestroom gebruiken

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.

In dit voorbeeld ziet u hoe u interactief kunt verifiëren bij Microsoft Entra ID met behulp van de apparaatcodestroom.

Zie Apparaatcodestroom voor meer informatie.

Voorbeeld 5: Alleen-app-toegang: clientreferenties gebruiken met een vingerafdruk van een certificaat

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

In dit voorbeeld ziet u hoe u verifieert met behulp van een ApplicationId en CertificateThumbprint.

Zie Verifiëren met alleen-app-toegang voor meer informatie over het ophalen of maken van CertificateThumbprint.

Voorbeeld 6: Alleen-app-toegang: clientreferenties gebruiken met een certificaatnaam

$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

U vindt het certificaatonderwerp door de bovenstaande opdracht uit te voeren.

Voorbeeld 7: Alleen-app-toegang: clientreferenties gebruiken met een certificaat

$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

Voorbeeld 8: Alleen-app-toegang: referenties voor clientgeheim gebruiken

$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

Deze verificatiemethode is ideaal voor interacties op de achtergrond.

Zie de opdracht Get-Credential voor meer informatie over het ophalen van referenties.

Voorbeeld 9: Alleen-app-toegang: Beheerde identiteit gebruiken: Door het systeem toegewezen beheerde identiteit

Connect-Entra -Identity

Maakt gebruik van een automatisch beheerde identiteit op een service-exemplaar. De identiteit is gekoppeld aan de levenscyclus van een service-exemplaar.

Voorbeeld 10: Alleen-app-toegang: Beheerde identiteit gebruiken: Door de gebruiker toegewezen beheerde identiteit

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Maakt gebruik van een door een gebruiker gemaakte beheerde identiteit als een zelfstandige Azure resource.

Voorbeeld 11: Verbinding maken met een omgeving als een andere identiteit

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Als u verbinding wilt maken als een andere identiteit dan CurrentUser, geeft u de ContextScope-parameter op met de waardeProces.

Zie de opdracht Get-EntraContext voor meer informatie over het ophalen van de huidige context.

Voorbeeld 12: Verbinding maken met een omgeving of cloud

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'

Wanneer u Connect-Entra gebruikt, kunt u ervoor kiezen om andere omgevingen te targeten. Standaard is Connect-Entra gericht op de wereldwijde openbare cloud.

Voorbeeld 13: Hiermee stelt u de time-out van de HTTP-client in seconden in

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

In dit voorbeeld wordt de time-out van de HTTP-client in seconden ingesteld.

Voorbeeld 14: Het welkomstbericht verbergen

Connect-Entra -NoWelcome

In dit voorbeeld wordt het welkomstbericht verborgen.

Voorbeeld 15: Verificatie met behulp van omgevingsvariabelen toestaan

Connect-Entra -EnvironmentVariable

In dit voorbeeld is verificatie mogelijk met behulp van omgevingsvariabelen.

Parameters

-AccessToken

Hiermee geeft u een bearer-token voor Microsoft Entra-service. Er treedt een time-out op voor toegangstokens en u moet de vernieuwing afhandelen.

Parametereigenschappen

Type:	SecureString
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

AccessTokenParameterSet

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Certificate

Een X.509-certificaat dat is opgegeven tijdens het aanroepen.

Parametereigenschappen

Type:	X509Certificate2
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-CertificateSubjectName

De DN-naam van het onderwerp van een certificaat. Het certificaat wordt opgehaald uit het certificaatarchief van de huidige gebruiker.

Parametereigenschappen

Type:	System.String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	CertificateSubject, CertificateName

Parametersets

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-CertificateThumbprint

Hiermee geeft u de vingerafdruk van het certificaat van een X.509-certificaat van een digitale openbare sleutel van een gebruikersaccount dat gemachtigd is om deze actie uit te voeren.

Parametereigenschappen

Type:	System.String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-ClientId

Hiermee geeft u de toepassings-id van de service-principal.

Parametereigenschappen

Type:	System.String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	AppId, ApplicationId

Parametersets

UserParameterSet

Position:	1
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

IdentityParameterSet

Position:	1
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

AppCertificateParameterSet

Position:	1
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-ClientSecretCredential

Het PSCredential-object biedt de toepassings-id en het clientgeheim voor referenties van de service-principal. Typ Get-Help Get-Credential voor meer informatie over het PSCredential-object.

Parametereigenschappen

Type:	PSCredential
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	SecretCredential, Referentie

Parametersets

AppSecretCredentialParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-ClientTimeout

Hiermee stelt u de time-out van de HTTP-client in seconden in.

Parametereigenschappen

Type:	System.Double
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-ContextScope

Bepaalt het bereik van de verificatiecontext. Deze ContextScope accepteert Process voor het huidige proces of CurrentUser voor alle sessies die door de gebruiker zijn gestart.

Parametereigenschappen

Type:	ContextScope
Default value:	None
Geaccepteerde waarden:	Process, CurrentUser
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

UserParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

IdentityParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

AppSecretCredentialParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

EnvironmentVariableParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Environment

De naam van de nationale cloudomgeving waarmee verbinding moet worden gemaakt. Standaard wordt globale cloud gebruikt.

Parametereigenschappen

Type:	System.String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	OmgevingsNaam, NationalCloud

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-EnvironmentVariable

Staat verificatie toe met behulp van omgevingsvariabelen die zijn geconfigureerd op de hostcomputer. Zie https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Parametereigenschappen

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

EnvironmentVariableParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Identity

Aanmelden met een beheerde identiteit

Parametereigenschappen

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	ManagedIdentity, ManagedServiceIdentity, MSI

Parametersets

IdentityParameterSet

Position:	1
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-NoWelcome

Het welkomstbericht wordt verborgen.

Parametereigenschappen

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Scopes

Een matrix met gedelegeerde machtigingen om toestemming te geven.

Parametereigenschappen

Type:	System.String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

UserParameterSet

Position:	1
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-SendCertificateChain

Voeg x5c-header toe aan clientclaims bij het verkrijgen van een token om verificatie op basis van onderwerpnaam/verlener in te schakelen met behulp van een bepaald certificaat.

Parametereigenschappen

Type:	Boolean
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-TenantId

Hiermee geeft u de id van een tenant op.

Als u deze parameter niet opgeeft, wordt het account geverifieerd bij de thuistenant.

U moet de TenantId-parameter opgeven om te verifiëren als een service-principal of wanneer u Microsoft-account gebruikt.

Parametereigenschappen

Type:	System.String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	Audiëntie, Tenant

Parametersets

UserParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

AppCertificateParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

AppSecretCredentialParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-UseDeviceCode

Gebruik verificatie van apparaatcode in plaats van een browserbesturing.

Parametereigenschappen

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Apparaat

Parametersets

UserParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Verwante koppelingen

• Disconnect-Entra