Connect-Entra

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

Připojte se k Microsoft Entra ID pomocí ověřeného účtu.

Syntax

UserParameterSet (Výchozí)

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

Rutina Connect-Entra se připojí k Microsoft Entra ID pomocí ověřeného účtu.

Na základě vašeho případu použití se podporuje několik scénářů ověřování, jako jsou delegované (interaktivní) a pouze aplikace (neinteraktivní).

Connect-Entra je alias pro Connect-MgGraph.

Příklady

Příklad 1: Delegovaný přístup: Připojení relace PowerShellu k tenantovi

Connect-Entra

Tento příklad ukazuje, jak připojit aktuální relaci PowerShellu k Microsoft Entra ID tenantovi pomocí přihlašovacích údajů.

Příklad 2: Delegovaný přístup: Připojení relace PowerShellu k tenantovi s požadovanými obory

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

Welcome to Microsoft Graph!

Tento příklad ukazuje, jak ověřit Microsoft Entra ID s obory.

Příklad 3: Delegovaný přístup: Použití přístupového tokenu

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

Welcome to Microsoft Graph!

Tento příklad ukazuje, jak interaktivně ověřit Microsoft Entra ID pomocí přístupového tokenu.

Další informace o získání nebo vytvoření přístupového tokenu najdete v tématu Žádost o přístupový token.

Příklad 4: Delegovaný přístup: Použití toku kódu zařízení

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.

Tento příklad ukazuje, jak interaktivně ověřit Microsoft Entra ID pomocí toku kódu zařízení.

Další informace najdete v tématu Tok kódu zařízení.

Příklad 5: Přístup jen pro aplikaci: Použití přihlašovacích údajů klienta s kryptografickým otiskem certifikátu

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

Tento příklad ukazuje, jak provést ověření pomocí ApplicationId a CertificateThumbprint.

Další informace o tom, jak získat nebo vytvořit CertificateThumbprint, najdete v tématu Ověřování pomocí přístupu jen pro aplikace.

Příklad 6: Přístup pouze pro aplikaci: Použití přihlašovacích údajů klienta s názvem certifikátu

$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

Předmět certifikátu najdete spuštěním výše uvedeného příkazu.

Příklad 7: Přístup pouze pro aplikace: Použití přihlašovacích údajů klienta s certifikátem

$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

Příklad 8: Přístup jen pro aplikace: Použití přihlašovacích údajů tajných kódů klienta

$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

Tato metoda ověřování je ideální pro interakce na pozadí.

Další informace o získání přihlašovacích údajů naleznete v tématu Get-Credential command.

Příklad 9: Přístup jen pro aplikace: Použití spravované identity: Spravovaná identita přiřazená systémem

Connect-Entra -Identity

Používá automaticky spravovanou identitu v instanci služby. Identita je svázaná s životním cyklem instance služby.

Příklad 10: Přístup jen pro aplikace: Použití spravované identity: Spravovaná identita přiřazená uživatelem

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Používá spravovanou identitu vytvořenou uživatelem jako samostatný prostředek Azure.

Příklad 11: Připojení k prostředí jako jiná identita

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Pokud se chcete připojit jako jinou identitu než CurrentUser, zadejte parametr ContextScope s hodnotou Process.

Další informace o získání aktuálního kontextu naleznete v tématu Get-EntraContext příkaz.

Příklad 12: Připojení k prostředí nebo cloudu

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'

Když používáte Connect-Entra, můžete se rozhodnout pro cílení na jiná prostředí. Ve výchozím nastavení Connect-Entra cílí na globální veřejný cloud.

Příklad 13: Nastaví časový limit klienta HTTP v sekundách.

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

Tento příklad nastaví časový limit klienta HTTP v sekundách.

Příklad 14: Skryje uvítací zprávu.

Connect-Entra -NoWelcome

Tento příklad skryje uvítací zprávu.

Příklad 15: Umožňuje ověřování pomocí proměnných prostředí

Connect-Entra -EnvironmentVariable

Tento příklad umožňuje ověřování pomocí proměnných prostředí.

Parametry

-AccessToken

Určuje nosný token pro službu Microsoft Entra. Vypršení časového limitu přístupových tokenů a musíte zpracovat jejich aktualizaci.

Vlastnosti parametru

Typ:	SecureString
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

AccessTokenParameterSet

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Certificate

Certifikát X.509 zadaný během vyvolání

Vlastnosti parametru

Typ:	X509Certificate2
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CertificateSubjectName

Rozlišující název subjektu certifikátu. Certifikát se načte z úložiště certifikátů aktuálního uživatele.

Vlastnosti parametru

Typ:	System.String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	CertificateSubject, Název certifikátu

Sady parametrů

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CertificateThumbprint

Určuje kryptografický otisk certifikátu digitálního veřejného klíče X.509 uživatelského účtu, který má oprávnění k provedení této akce.

Vlastnosti parametru

Typ:	System.String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ClientId

Určuje ID aplikace instančního objektu.

Vlastnosti parametru

Typ:	System.String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	AppId, ApplicationId

Sady parametrů

UserParameterSet

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

IdentityParameterSet

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

AppCertificateParameterSet

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ClientSecretCredential

Objekt PSCredential poskytuje ID aplikace a tajný klíč klienta pro přihlašovací údaje instančního objektu. Další informace o objektu PSCredential zadejte Get-Help Get-Credential.

Vlastnosti parametru

Typ:	PSCredential
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	SecretCredential, Reference

Sady parametrů

AppSecretCredentialParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ClientTimeout

Nastaví časový limit klienta HTTP v sekundách.

Vlastnosti parametru

Typ:	System.Double
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ContextScope

Určuje rozsah kontextu ověřování. Tento ContextScope přijímá Process pro aktuální proces nebo CurrentUser pro všechny relace spuštěné uživatelem.

Vlastnosti parametru

Typ:	ContextScope
Default value:	None
Přípustné hodnoty:	Process, CurrentUser
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

UserParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

IdentityParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

AppSecretCredentialParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

EnvironmentVariableParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Environment

Název národního cloudového prostředí, ke kterému se chcete připojit. Ve výchozím nastavení se používá globální cloud.

Vlastnosti parametru

Typ:	System.String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	název prostředí, NationalCloud

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-EnvironmentVariable

Umožňuje ověřování pomocí proměnných prostředí nakonfigurovaných na hostitelském počítači. Viz https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables.

Vlastnosti parametru

Typ:	System.Management.Automation.SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

EnvironmentVariableParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Identity

Přihlášení pomocí spravované identity

Vlastnosti parametru

Typ:	System.Management.Automation.SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	ManagedIdentity, ManagedServiceIdentity, MSI

Sady parametrů

IdentityParameterSet

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-NoWelcome

Skryje uvítací zprávu.

Vlastnosti parametru

Typ:	System.Management.Automation.SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Scopes

Pole delegovaných oprávnění k vyjádření souhlasu.

Vlastnosti parametru

Typ:	System.String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

UserParameterSet

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-SendCertificateChain

Při získání tokenu za účelem povolení ověřování na základě názvu subjektu nebo vystavitele pomocí daného certifikátu do deklarací identity klienta zahrňte hlavičku x5c.

Vlastnosti parametru

Typ:	Boolean
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-TenantId

Určuje ID tenanta.

Pokud tento parametr nezadáte, účet se ověří u domovského tenanta.

Je nutné zadat parametr TenantId, který se má ověřit jako instanční objekt nebo při použití účet Microsoft.

Vlastnosti parametru

Typ:	System.String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Cílová skupina, Tenant

Sady parametrů

UserParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

AppCertificateParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

AppSecretCredentialParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-UseDeviceCode

Místo ovládacího prvku prohlížeče použijte ověřování kódu zařízení.

Vlastnosti parametru

Typ:	System.Management.Automation.SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Zařízení

Sady parametrů

UserParameterSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Disconnect-Entra

Váš názor

Byla tato stránka užitečná?

Connect-Entra

Syntax

UserParameterSet (Výchozí)

AppCertificateParameterSet

IdentityParameterSet

AppSecretCredentialParameterSet

AccessTokenParameterSet

EnvironmentVariableParameterSet

Description

Příklady

Příklad 1: Delegovaný přístup: Připojení relace PowerShellu k tenantovi

Příklad 2: Delegovaný přístup: Připojení relace PowerShellu k tenantovi s požadovanými obory

Příklad 3: Delegovaný přístup: Použití přístupového tokenu

Příklad 4: Delegovaný přístup: Použití toku kódu zařízení

Příklad 5: Přístup jen pro aplikaci: Použití přihlašovacích údajů klienta s kryptografickým otiskem certifikátu

Příklad 6: Přístup pouze pro aplikaci: Použití přihlašovacích údajů klienta s názvem certifikátu

Příklad 7: Přístup pouze pro aplikace: Použití přihlašovacích údajů klienta s certifikátem

Příklad 8: Přístup jen pro aplikace: Použití přihlašovacích údajů tajných kódů klienta

Příklad 9: Přístup jen pro aplikace: Použití spravované identity: Spravovaná identita přiřazená systémem

Příklad 10: Přístup jen pro aplikace: Použití spravované identity: Spravovaná identita přiřazená uživatelem

Příklad 11: Připojení k prostředí jako jiná identita

Příklad 12: Připojení k prostředí nebo cloudu

Příklad 13: Nastaví časový limit klienta HTTP v sekundách.

Příklad 14: Skryje uvítací zprávu.

Příklad 15: Umožňuje ověřování pomocí proměnných prostředí

Parametry

-AccessToken

Vlastnosti parametru

Sady parametrů

-Certificate

Vlastnosti parametru

Sady parametrů

-CertificateSubjectName

Vlastnosti parametru

Sady parametrů

-CertificateThumbprint

Vlastnosti parametru

Sady parametrů

-ClientId

Vlastnosti parametru

Sady parametrů

-ClientSecretCredential

Vlastnosti parametru

Sady parametrů

-ClientTimeout

Vlastnosti parametru

Sady parametrů

-ContextScope

Vlastnosti parametru

Sady parametrů

-Environment

Vlastnosti parametru

Sady parametrů

-EnvironmentVariable

Vlastnosti parametru

Sady parametrů

-Identity

Vlastnosti parametru

Sady parametrů

-NoWelcome

Vlastnosti parametru

Sady parametrů

-Scopes

Vlastnosti parametru

Sady parametrů

-SendCertificateChain

Vlastnosti parametru

Sady parametrů

-TenantId

Vlastnosti parametru

Sady parametrů

-UseDeviceCode

Vlastnosti parametru

Sady parametrů

CommonParameters

Související odkazy

Váš názor