Connect-Entra

Connettersi a Microsoft Entra ID con un account autenticato.

Sintassi

UserParameterSet (Impostazione predefinita)

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

Descrizione

Il Connect-Entra cmdlet si connette a Microsoft Entra ID con un account autenticato.

Diversi scenari di autenticazione sono supportati in base al caso d'uso, ad esempio delegato (interattivo) e solo app (non interattivo).

Connect-Entra è un alias per Connect-MgGraph.

Esempio

Esempio 1: Accesso delegato: Connettere una sessione di PowerShell a un tenant

Connect-Entra

Questo esempio illustra come connettere la sessione di PowerShell corrente a un tenant Microsoft Entra ID usando le credenziali.

Esempio 2: Accesso delegato: Connettere una sessione di PowerShell a un tenant con ambiti obbligatori

Connect-Entra -Scopes 'User.Read.All', 'Group.ReadWrite.All'
Welcome to Microsoft Graph!

Questo esempio illustra come eseguire l'autenticazione per Microsoft Entra ID con ambiti.

Esempio 3: Accesso delegato: Uso di un token di accesso

$secureString = ConvertTo-SecureString -String $AccessToken -AsPlainText -Force
Connect-Entra -AccessToken $secureString
Welcome to Microsoft Graph!

Questo esempio illustra come eseguire l'autenticazione interattiva per Microsoft Entra ID usando un token di accesso.

Per altre informazioni su come ottenere o creare un token di accesso, vedere Richiedere un token di accesso.

Esempio 4: Accesso delegato: Uso del flusso del codice del dispositivo

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.

Questo esempio illustra come eseguire l'autenticazione interattiva per Microsoft Entra ID usando il flusso del codice del dispositivo.

Per altre informazioni, vedere Flusso del codice del dispositivo.

Esempio 5: Accesso solo app: uso delle credenziali client con un'identificazione personale del certificato

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

Connect-Entra @connectParams
Welcome to Microsoft Graph!

In questo esempio viene illustrato come eseguire l'autenticazione usando applicationId e CertificateThumbprint.

Per altre informazioni su come ottenere o creare CertificateThumbprint, vedere Eseguire l'autenticazione con l'accesso solo app.

Esempio 6: Accesso solo app: Uso delle credenziali client con un nome di certificato

$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

È possibile trovare l'oggetto del certificato eseguendo il comando precedente.

Esempio 7: Accesso solo app: uso delle credenziali client con un certificato

$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

Esempio 8: Accesso solo app: uso delle credenziali del segreto client

$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

Questo metodo di autenticazione è ideale per le interazioni in background.

Per altre informazioni su come ottenere le credenziali, vedere Comando Get-Credential .

Esempio 9: Accesso solo app: uso dell'identità gestita: identità gestita assegnata dal sistema

Connect-Entra -Identity

Usa un'identità gestita automaticamente in un'istanza del servizio. L'identità è associata al ciclo di vita di un'istanza del servizio.

Esempio 10: Accesso solo app: uso dell'identità gestita: identità gestita assegnata dall'utente

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Usa un'identità gestita creata dall'utente come risorsa Azure autonoma.

Esempio 11: Connessione a un ambiente come identità diversa

Connect-Entra -ContextScope 'Process'
Welcome to Microsoft Graph!

Per connettersi come identità diversa da CurrentUser, specificare il parametro ContextScope con il valore Process.

Per altre informazioni su come ottenere il contesto corrente, vedere Comando Get-EntraContext .

Esempio 12: Connessione a un ambiente o a un 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'

Quando si usa Connect-Entra, è possibile scegliere di usare altri ambienti. Per impostazione predefinita, Connect-Entra è destinato al cloud pubblico globale.

Esempio 13: imposta il timeout del client HTTP in secondi

 Connect-Entra -ClientTimeout 60
Welcome to Microsoft Graph!

In questo esempio viene impostato il timeout del client HTTP in secondi.

Esempio 14: Nasconde il messaggio di benvenuto

Connect-Entra -NoWelcome

In questo esempio viene nascosto il messaggio di benvenuto.

Esempio 15: consente l'autenticazione usando le variabili di ambiente

Connect-Entra -EnvironmentVariable

Questo esempio consente l'autenticazione usando le variabili di ambiente.

Parametri

-AccessToken

Specifica un token di connessione per Microsoft Entra servizio. I token di accesso eseguono il timeout ed è necessario gestire il relativo aggiornamento.

Proprietà dei parametri

Tipo:SecureString
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

AccessTokenParameterSet
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Certificate

Certificato X.509 fornito durante la chiamata.

Proprietà dei parametri

Tipo:X509Certificate2
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-CertificateSubjectName

Nome distinto dell'oggetto di un certificato. Il certificato viene recuperato dall'archivio certificati dell'utente corrente.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:CertificateSubject, CertificateName

Set di parametri

AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-CertificateThumbprint

Specifica l'identificazione personale del certificato di un certificato X.509 con chiave pubblica digitale di un account utente autorizzato a eseguire questa azione.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ClientId

Specifica l'ID applicazione dell'entità servizio.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:AppId, ApplicationId

Set di parametri

UserParameterSet
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
IdentityParameterSet
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
AppCertificateParameterSet
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ClientSecretCredential

L'oggetto PSCredential fornisce l'ID applicazione e il segreto client per le credenziali dell'entità servizio. Per altre informazioni sull'oggetto PSCredential, digitare Get-Help Get-Credential.

Proprietà dei parametri

Tipo:PSCredential
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretCredential, Credenziale

Set di parametri

AppSecretCredentialParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ClientTimeout

Imposta il timeout del client HTTP in secondi.

Proprietà dei parametri

Tipo:System.Double
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ContextScope

Determina l'ambito del contesto di autenticazione. ContextScope accetta Process per il processo corrente o CurrentUser per tutte le sessioni avviate dall'utente.

Proprietà dei parametri

Tipo:ContextScope
Valore predefinito:None
Valori accettati:Process, CurrentUser
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

UserParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
IdentityParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
AppSecretCredentialParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
EnvironmentVariableParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Environment

Nome dell'ambiente cloud nazionale a cui connettersi. Per impostazione predefinita viene usato il cloud globale.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:EnvironmentName, NationalCloud

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-EnvironmentVariable

Consente l'autenticazione usando le variabili di ambiente configurate nel computer host. Fare riferimento a https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Proprietà dei parametri

Tipo:System.Management.Automation.SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

EnvironmentVariableParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Identity

Accesso con un'identità gestita

Proprietà dei parametri

Tipo:System.Management.Automation.SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:ManagedIdentity, ManagedServiceIdentity, MSI

Set di parametri

IdentityParameterSet
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-NoWelcome

Nasconde il messaggio di benvenuto.

Proprietà dei parametri

Tipo:System.Management.Automation.SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Scopes

Matrice di autorizzazioni delegate a cui concedere il consenso.

Proprietà dei parametri

Tipo:

System.String[]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

UserParameterSet
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-SendCertificateChain

Includere l'intestazione x5c nelle attestazioni client durante l'acquisizione di un token per abilitare l'autenticazione basata su nome soggetto/autorità emittente usando un determinato certificato.

Proprietà dei parametri

Tipo:Boolean
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-TenantId

Specifica l'ID di un tenant.

Se non si specifica questo parametro, l'account viene autenticato con il tenant principale.

È necessario specificare il parametro TenantId per l'autenticazione come entità servizio o quando si usa account Microsoft.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:Pubblico, Tenant

Set di parametri

UserParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
AppCertificateParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
AppSecretCredentialParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-UseDeviceCode

Usare l'autenticazione del codice del dispositivo anziché un controllo browser.

Proprietà dei parametri

Tipo:System.Management.Automation.SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:UseDeviceAuthentication, DeviceCode, DeviceAuth, Dispositivo

Set di parametri

UserParameterSet
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.