Connect-Entra

Moduł:

Microsoft.Entra.Authentication Module v1.3

Połącz się z Microsoft Entra ID przy użyciu uwierzytelnionego konta.

Składnia

UserParameterSet (domyślnie)

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

Opis

Polecenie Connect-Entra cmdlet nawiązuje połączenie z Microsoft Entra ID przy użyciu uwierzytelnionego konta.

Kilka scenariuszy uwierzytelniania jest obsługiwanych w zależności od przypadku użycia, takich jak delegowane (interaktywne) i tylko aplikacje (nieinterakcyjne).

Connect-Entra to alias dla elementu Connect-MgGraph.

Przykłady

Przykład 1: Delegowany dostęp: Łączenie sesji programu PowerShell z dzierżawą

Connect-Entra

W tym przykładzie pokazano, jak połączyć bieżącą sesję programu PowerShell z dzierżawą Microsoft Entra ID przy użyciu poświadczeń.

Przykład 2: Delegowany dostęp: Łączenie sesji programu PowerShell z dzierżawą z wymaganymi zakresami

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

Welcome to Microsoft Graph!

W tym przykładzie pokazano, jak uwierzytelniać się w Microsoft Entra ID przy użyciu zakresów.

Przykład 3: Dostęp delegowany: używanie tokenu dostępu

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

Welcome to Microsoft Graph!

W tym przykładzie pokazano, jak interaktywnie uwierzytelniać się w Microsoft Entra ID przy użyciu tokenu dostępu.

Aby uzyskać więcej informacji na temat uzyskiwania lub tworzenia tokenu dostępu, zobacz Żądanie tokenu dostępu.

Przykład 4. Delegowany dostęp: Korzystanie z przepływu kodu urządzenia

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.

W tym przykładzie pokazano, jak interaktywnie uwierzytelniać się w Microsoft Entra ID przy użyciu przepływu kodu urządzenia.

Aby uzyskać więcej informacji, zobacz Przepływ kodu urządzenia.

Przykład 5. Dostęp tylko do aplikacji: używanie poświadczeń klienta z odciskiem palca certyfikatu

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

W tym przykładzie pokazano, jak uwierzytelniać się przy użyciu identyfikatora aplikacji i parametru CertificateThumbprint.

Aby uzyskać więcej informacji na temat pobierania lub tworzenia certyfikatuThumbprint, zobacz Uwierzytelnianie przy użyciu dostępu tylko do aplikacji.

Przykład 6. Dostęp tylko do aplikacji: używanie poświadczeń klienta z nazwą certyfikatu

$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

Podmiot certyfikatu można znaleźć, uruchamiając powyższe polecenie.

Przykład 7. Dostęp tylko do aplikacji: używanie poświadczeń klienta z certyfikatem

$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

Przykład 8. Dostęp tylko do aplikacji: używanie poświadczeń wpisów tajnych 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

Ta metoda uwierzytelniania jest idealna w przypadku interakcji w tle.

Aby uzyskać więcej informacji na temat pobierania poświadczeń, zobacz Get-Credential polecenie.

Przykład 9. Dostęp tylko do aplikacji: Używanie tożsamości zarządzanej: tożsamość zarządzana przypisana przez system

Connect-Entra -Identity

Używa automatycznej tożsamości zarządzanej w wystąpieniu usługi. Tożsamość jest powiązana z cyklem życia wystąpienia usługi.

Przykład 10: Dostęp tylko do aplikacji: Korzystanie z tożsamości zarządzanej: tożsamość zarządzana przypisana przez użytkownika

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Używa tożsamości zarządzanej utworzonej przez użytkownika jako autonomicznego zasobu Azure.

Przykład 11: Nawiązywanie połączenia ze środowiskiem jako inną tożsamością

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Aby nawiązać połączenie jako inną tożsamość inną niż CurrentUser, określ parametr ContextScope z wartością Process.

Aby uzyskać więcej informacji na temat pobierania bieżącego kontekstu, zobacz Polecenie Get-EntraContext .

Przykład 12: Nawiązywanie połączenia ze środowiskiem lub chmurą

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'

W przypadku korzystania z funkcji Connect-Entra możesz wybrać opcję określania lokalizacji docelowej dla innych środowisk. Domyślnie Connect-Entra dotyczy globalnej chmury publicznej.

Przykład 13: Ustawia limit czasu klienta HTTP w sekundach

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

W tym przykładzie ustawia limit czasu klienta HTTP w sekundach.

Przykład 14: Ukrywa wiadomość powitalną

Connect-Entra -NoWelcome

W tym przykładzie jest ukrywana wiadomość powitalna.

Przykład 15: Umożliwia uwierzytelnianie przy użyciu zmiennych środowiskowych

Connect-Entra -EnvironmentVariable

Ten przykład umożliwia uwierzytelnianie przy użyciu zmiennych środowiskowych.

Parametry

-AccessToken

Określa token elementu nośnego dla usługi Microsoft Entra. Przekroczono limit czasu tokenów dostępu i trzeba obsługiwać ich odświeżanie.

Właściwości parametru

Typ:	SecureString
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

AccessTokenParameterSet

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Certificate

Certyfikat X.509 dostarczony podczas wywołania.

Właściwości parametru

Typ:	X509Certificate2
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-CertificateSubjectName

Nazwa wyróżniająca podmiotu certyfikatu. Certyfikat jest pobierany z magazynu certyfikatów bieżącego użytkownika.

Właściwości parametru

Typ:	System.String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	CertyfikatSubject, Nazwa certyfikatu

Zestawy parametrów

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-CertificateThumbprint

Określa odcisk palca certyfikatu cyfrowego klucza publicznego X.509 konta użytkownika z uprawnieniami do wykonania tej akcji.

Właściwości parametru

Typ:	System.String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ClientId

Określa identyfikator aplikacji jednostki usługi.

Właściwości parametru

Typ:	System.String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Identyfikator aplikacji, Identyfikator aplikacji

Zestawy parametrów

UserParameterSet

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

IdentityParameterSet

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

AppCertificateParameterSet

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ClientSecretCredential

Obiekt PSCredential udostępnia identyfikator aplikacji i klucz tajny klienta dla poświadczeń jednostki usługi. Aby uzyskać więcej informacji na temat obiektu PSCredential, wpisz Get-Help Get-Credential.

Właściwości parametru

Typ:	PSCredential
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	SecretCredential, Credential

Zestawy parametrów

AppSecretCredentialParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ClientTimeout

Ustawia limit czasu klienta HTTP w sekundach.

Właściwości parametru

Typ:	System.Double
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ContextScope

Określa zakres kontekstu uwierzytelniania. Ten element ContextScope akceptuje Process bieżący proces lub CurrentUser dla wszystkich sesji uruchomionych przez użytkownika.

Właściwości parametru

Typ:	ContextScope
Domyślna wartość:	None
Dopuszczalne wartości:	Process, CurrentUser
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

UserParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

IdentityParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

AppSecretCredentialParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

EnvironmentVariableParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Environment

Nazwa środowiska chmury krajowej do nawiązania połączenia. Domyślnie używana jest chmura globalna.

Właściwości parametru

Typ:	System.String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	NazwaŚrodowiska, NationalCloud

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-EnvironmentVariable

Umożliwia uwierzytelnianie przy użyciu zmiennych środowiskowych skonfigurowanych na maszynie hosta. Zobacz https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Właściwości parametru

Typ:	System.Management.Automation.SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

EnvironmentVariableParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Identity

Logowanie przy użyciu tożsamości zarządzanej

Właściwości parametru

Typ:	System.Management.Automation.SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	ManagedIdentity, ManagedServiceIdentity, MSI

Zestawy parametrów

IdentityParameterSet

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-NoWelcome

Ukrywa wiadomość powitalną.

Właściwości parametru

Typ:	System.Management.Automation.SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Scopes

Tablica delegowanych uprawnień do wyrażania zgody.

Właściwości parametru

Typ:	System.String[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

UserParameterSet

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-SendCertificateChain

Uwzględnij nagłówek x5c w oświadczeniach klienta podczas uzyskiwania tokenu w celu włączenia uwierzytelniania opartego na nazwie podmiotu/wystawcy przy użyciu danego certyfikatu.

Właściwości parametru

Typ:	Boolean
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-TenantId

Określa identyfikator dzierżawy.

Jeśli nie określisz tego parametru, konto zostanie uwierzytelnione w dzierżawie głównej.

Należy określić parametr TenantId, aby uwierzytelnić się jako jednostka usługi lub w przypadku używania konto Microsoft.

Właściwości parametru

Typ:	System.String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Audiencja, Tenant

Zestawy parametrów

UserParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

AppCertificateParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

AppSecretCredentialParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-UseDeviceCode

Użyj uwierzytelniania kodu urządzenia zamiast kontrolki przeglądarki.

Właściwości parametru

Typ:	System.Management.Automation.SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	UseDeviceAuthentication, Kod urządzenia, DeviceAuth, Urządzenie

Zestawy parametrów

UserParameterSet

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Linki powiązane

• Disconnect-Entra