Connect-Entra

Modul:
Microsoft.Entra.Authentication Module v1.3

Stellen Sie eine Verbindung mit Microsoft Entra ID mit einem authentifizierten Konto her.

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>]

Beschreibung

Das Connect-Entra Cmdlet stellt eine Verbindung mit Microsoft Entra ID mit einem authentifizierten Konto bereit.

Mehrere Authentifizierungsszenarien werden basierend auf Ihrem Anwendungsfall unterstützt, z. B. delegierte (interaktiv) und nur App (nicht interaktiv).

Connect-Entra ist ein Alias für Connect-MgGraph.

Beispiele

Beispiel 1: Delegierter Zugriff: Verbinden einer PowerShell-Sitzung mit einem Mandanten

Connect-Entra

In diesem Beispiel wird gezeigt, wie Sie ihre aktuelle PowerShell-Sitzung mit einem Microsoft Entra ID Mandanten mithilfe von Anmeldeinformationen verbinden.

Beispiel 2: Delegierter Zugriff: Verbinden einer PowerShell-Sitzung mit einem Mandanten mit erforderlichen Bereichen

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

Welcome to Microsoft Graph!

In diesem Beispiel wird gezeigt, wie Sie sich bei Microsoft Entra ID mit Bereichen authentifizieren.

Beispiel 3: Delegierter Zugriff: Verwenden eines Zugriffstokens

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

Welcome to Microsoft Graph!

In diesem Beispiel wird gezeigt, wie Sie sich interaktiv bei Microsoft Entra ID mithilfe eines Zugriffstokens authentifizieren.

Weitere Informationen zum Abrufen oder Erstellen von Zugriffstoken finden Sie unter Anfordern eines Zugriffstokens.

Beispiel 4: Delegierter Zugriff: Verwenden des Gerätecodeflusses

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 diesem Beispiel wird gezeigt, wie Sie sich interaktiv bei Microsoft Entra ID mithilfe des Gerätecodeflusses authentifizieren.

Weitere Informationen finden Sie unter Device Code flow.

Beispiel 5: Nur-App-Zugriff: Verwenden von Clientanmeldeinformationen mit einem Zertifikatfingerabdruck

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

In diesem Beispiel wird gezeigt, wie Sie sich mit einer ApplicationId und CertificateThumbprint authentifizieren.

Weitere Informationen zum Abrufen oder Erstellen von CertificateThumbprint finden Sie unter Authentifizieren mit nur App-Zugriff.

Beispiel 6: Nur-App-Zugriff: Verwenden von Clientanmeldeinformationen mit einem Zertifikatnamen

$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

Sie finden den Zertifikatbetreff, indem Sie den obigen Befehl ausführen.

Beispiel 7: Nur-App-Zugriff: Verwenden von Clientanmeldeinformationen mit einem Zertifikat

$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

Beispiel 8: Nur-App-Zugriff: Verwenden geheimer Clientschlüsselanmeldeinformationen

$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

Diese Authentifizierungsmethode eignet sich ideal für Hintergrundinteraktionen.

Weitere Informationen zum Abrufen von Anmeldeinformationen finden Sie unter "Get-Credential"- Befehl.

Beispiel 9: Nur-App-Zugriff: Verwenden der verwalteten Identität: Vom System zugewiesene verwaltete Identität

Connect-Entra -Identity

Verwendet eine automatisch verwaltete Identität in einer Dienstinstanz. Die Identität ist an den Lebenszyklus einer Dienstinstanz gebunden.

Beispiel 10: Nur-App-Zugriff: Verwenden der verwalteten Identität: Vom Benutzer zugewiesene verwaltete Identität

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Verwendet eine vom Benutzer erstellte verwaltete Identität als eigenständige Azure Ressource.

Beispiel 11: Herstellen einer Verbindung mit einer Umgebung als andere Identität

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Wenn Sie eine Verbindung als eine andere Identität als CurrentUser herstellen möchten, geben Sie den ContextScope-Parameter mit dem Wert "Process" an.

Weitere Informationen zum Abrufen des aktuellen Kontexts finden Sie unter Get-EntraContext-Befehl .

Beispiel 12: Herstellen einer Verbindung mit einer Umgebung oder 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'

Wenn Sie Connect-Entra verwenden, können Sie sich für andere Umgebungen entscheiden. Standardmäßig zielt Connect-Entra auf die globale öffentliche Cloud ab.

Beispiel 13: Legt das HTTP-Clienttimeout in Sekunden fest.

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

In diesem Beispiel wird das HTTP-Clienttimeout in Sekunden festgelegt.

Beispiel 14: Blendet die Willkommensnachricht aus

Connect-Entra -NoWelcome

In diesem Beispiel wird die Willkommensnachricht ausgeblendet.

Beispiel 15: Ermöglicht die Authentifizierung mithilfe von Umgebungsvariablen

Connect-Entra -EnvironmentVariable

In diesem Beispiel wird die Authentifizierung mithilfe von Umgebungsvariablen ermöglicht.

Parameter

-AccessToken

Gibt ein Bearertoken für Microsoft Entra Dienst an. Zugriffstoken führen ein Timeout durch, und Sie müssen deren Aktualisierung behandeln.

Parametereigenschaften

Typ:SecureString
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AccessTokenParameterSet
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Certificate

Ein X.509-Zertifikat, das während des Aufrufs bereitgestellt wird.

Parametereigenschaften

Typ:X509Certificate2
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CertificateSubjectName

Der Antragstellername eines Zertifikats. Das Zertifikat wird aus dem Zertifikatspeicher des aktuellen Benutzers abgerufen.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:CertificateSubject, CertificateName

Parametersätze

AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CertificateThumbprint

Gibt den Zertifikatfingerabdruck eines X.509-Zertifikats eines digitalen öffentlichen Schlüssels eines Benutzerkontos an, das über die Berechtigung zum Ausführen dieser Aktion verfügt.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ClientId

Gibt die Anwendungs-ID des Dienstprinzipals an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AppId, ApplicationId

Parametersätze

UserParameterSet
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
IdentityParameterSet
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
AppCertificateParameterSet
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ClientSecretCredential

Das PSCredential-Objekt stellt die Anwendungs-ID und den geheimen Clientschlüssel für Dienstprinzipalanmeldeinformationen bereit. Um weitere Informationen zum PSCredential-Objekt zu erhalten, geben Sie Get-Help Get-Credential ein.

Parametereigenschaften

Typ:PSCredential
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Geheime Anmeldeinformationen, Leistungsnachweis

Parametersätze

AppSecretCredentialParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ClientTimeout

Legt das HTTP-Clienttimeout in Sekunden fest.

Parametereigenschaften

Typ:System.Double
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ContextScope

Bestimmt den Authentifizierungskontext. Dieser ContextScope akzeptiert Process den aktuellen Prozess oder CurrentUser für alle vom Benutzer gestarteten Sitzungen.

Parametereigenschaften

Typ:ContextScope
Standardwert:None
Zulässige Werte:Process, CurrentUser
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UserParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
IdentityParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
AppSecretCredentialParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
EnvironmentVariableParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Environment

Der Name der nationalen Cloudumgebung, mit der eine Verbindung hergestellt werden soll. Standardmäßig wird die globale Cloud verwendet.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Umgebungsname, NationalCloud

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-EnvironmentVariable

Ermöglicht die Authentifizierung mithilfe von Umgebungsvariablen, die auf dem Hostcomputer konfiguriert sind. Siehe https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

EnvironmentVariableParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Identity

Anmelden mithilfe einer verwalteten Identität

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:ManagedIdentity, ManagedServiceIdentity, MSI

Parametersätze

IdentityParameterSet
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-NoWelcome

Blendet die Willkommensnachricht aus.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Scopes

Ein Array delegierter Berechtigungen, deren Zustimmung zuzustimmen ist.

Parametereigenschaften

Typ:

System.String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UserParameterSet
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SendCertificateChain

Schließen Sie den x5c-Header in Clientansprüche ein, wenn Sie ein Token abrufen, um die antragstellername/ausstellerbasierte Authentifizierung mithilfe des angegebenen Zertifikats zu aktivieren.

Parametereigenschaften

Typ:Boolean
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-TenantId

Gibt die ID eines Mandanten an.

Wenn Sie diesen Parameter nicht angeben, wird das Konto beim Heimmandanten authentifiziert.

Sie müssen den TenantId-Parameter angeben, der als Dienstprinzipal oder bei Verwendung von Microsoft-Konto authentifiziert werden soll.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Publikum, Tenant

Parametersätze

UserParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
AppCertificateParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
AppSecretCredentialParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-UseDeviceCode

Verwenden Sie die Gerätecodeauthentifizierung anstelle eines Browsersteuerelements.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:UseDeviceAuthentication, DeviceCode, DeviceAuth, Gerät

Parametersätze

UserParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.