Connect-Entra

Módulo:

Microsoft.Entra.Authentication Module v1.3

Ligue-se ao Microsoft Entra ID com uma conta autenticada.

Sintaxe

UserParameterSet (Predefinição)

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

Descrição

O Connect-Entra cmdlet liga-se ao Microsoft Entra ID através de uma conta autenticada.

São suportados vários cenários de autenticação consoante o seu caso de uso, como delegado (interativo) e apenas para aplicação (não interativo).

Connect-Entra é um alias para Connect-MgGraph.

Exemplos

Exemplo 1: Acesso delegado: Ligar uma sessão PowerShell a um tenant

Connect-Entra

Este exemplo mostra como ligar a sua sessão PowerShell atual a um inquilino do Microsoft Entra ID usando credenciais.

Exemplo 2: Acesso delegado: Ligar uma sessão PowerShell a um tenant com os escopos necessários

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

Welcome to Microsoft Graph!

Este exemplo mostra como autenticar para o Microsoft Entra ID com telescópios.

Exemplo 3: Acesso delegado: Utilização de um token de acesso

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

Welcome to Microsoft Graph!

Este exemplo mostra como autenticar interativamente para o Microsoft Entra ID usando um token de acesso.

Para mais informações sobre como obter ou criar um token de acesso, consulte Solicitar um token de acesso.

Exemplo 4: Acesso delegado: Utilização do fluxo de código do 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.

Este exemplo mostra como autenticar interativamente para o Microsoft Entra ID usando o fluxo de código do dispositivo.

Para mais informações, consulte Fluxo de Código do Dispositivo.

Exemplo 5: Acesso apenas por aplicação: Utilização de credencial de cliente com impressão digital do Certificado

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

Este exemplo mostra como autenticar usando um ApplicationId e um CertificateThumbprint.

Para mais informações sobre como obter ou criar o CertificateThumbprint, consulte Autenticar com acesso apenas por aplicação.

Exemplo 6: Acesso apenas por aplicação: Usar credencial de cliente com nome de certificado

$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

Pode encontrar o assunto do certificado executando o comando acima.

Exemplo 7: Acesso apenas por aplicação: Utilização de credencial de cliente com certificado

$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

Exemplo 8: Acesso apenas por aplicação: Utilização de credenciais secretas do cliente

$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

Este método de autenticação é ideal para interações em segundo plano.

Para mais informações sobre como obter credenciais, consulte o comando Obtenha de credenciais .

Exemplo 9: Acesso apenas por aplicação: Utilização de identidade gerida: Identidade gerida atribuída pelo sistema

Connect-Entra -Identity

Utiliza uma identidade gerida automaticamente numa instância de serviço. A identidade está ligada ao ciclo de vida de uma instância de serviço.

Exemplo 10: Acesso apenas por aplicação: Utilização de identidade gerida: Identidade gerida atribuída pelo utilizador

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Utiliza uma identidade gerida criada pelo utilizador como recurso Azure autónomo.

Exemplo 11: Conectar-se a um ambiente como uma identidade diferente

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Para se ligar com uma identidade diferente de CurrentUser, especifique o parâmetro ContextScope com o valor Process.

Para mais informações sobre como obter o contexto atual, consulte o comando Get-EntraContext .

Exemplo 12: Ligar a um ambiente ou 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 usa o Connect-Entra, pode escolher direcionar outros ambientes. Por defeito, Connect-Entra tem como alvo a nuvem pública global.

Exemplo 13: Define o timeout do cliente HTTP em segundos

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

Este exemplo define o timeout do cliente HTTP em segundos.

Exemplo 14: Esconde a mensagem de boas-vindas

Connect-Entra -NoWelcome

Este exemplo esconde a mensagem de boas-vindas.

Exemplo 15: Permite autenticação usando variáveis de ambiente

Connect-Entra -EnvironmentVariable

Este exemplo permite autenticação usando variáveis de ambiente.

Parâmetros

-AccessToken

Especifica um token portador para o serviço Microsoft Entra. Os tokens de acesso têm tempo de espera e tens de gerir a atualização deles.

Propriedades dos parâmetros

Tipo:	SecureString
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AccessTokenParameterSet

Posto:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Certificate

Um certificado X.509 fornecido durante a invocação.

Propriedades dos parâmetros

Tipo:	X509Certificate2
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-CertificateSubjectName

O sujeito distinguiu o nome de um certificado. O certificado é recuperado do armazenamento de certificados do utilizador atual.

Propriedades dos parâmetros

Tipo:	System.String
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Disciplina do Certificado, Nome do Certificado

Conjuntos de parâmetros

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-CertificateThumbprint

Especifica a impressão digital do certificado de chave pública digital X.509 de uma conta de utilizador que tem permissão para realizar esta ação.

Propriedades dos parâmetros

Tipo:	System.String
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ClientId

Especifica o ID da aplicação do principal de serviço.

Propriedades dos parâmetros

Tipo:	System.String
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AppId, ApplicationId

Conjuntos de parâmetros

UserParameterSet

Posto:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

IdentityParameterSet

Posto:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

AppCertificateParameterSet

Posto:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ClientSecretCredential

O objeto PSCredential fornece o ID da aplicação e o segredo do cliente para credenciais de principal de serviço. Para mais informações sobre o objeto PSCredential, escreva Get-Help Get-Credential.

Propriedades dos parâmetros

Tipo:	PSCredential
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Credencial Secreta, Credencial

Conjuntos de parâmetros

AppSecretCredentialParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ClientTimeout

Define o timeout do cliente HTTP em segundos.

Propriedades dos parâmetros

Tipo:	System.Double
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ContextScope

Determina o âmbito do contexto de autenticação. Este ContextScope aceita Process para o processo atual, ou CurrentUser para todas as sessões iniciadas pelo utilizador.

Propriedades dos parâmetros

Tipo:	ContextScope
Valor predefinido:	None
Valores aceites:	Process, CurrentUser
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

UserParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

IdentityParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

AppSecretCredentialParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

EnvironmentVariableParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Environment

O nome do ambiente nacional de cloud a que se deve ligar. Por defeito, utiliza-se a cloud global.

Propriedades dos parâmetros

Tipo:	System.String
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	NomeDoAmbiente, NationalCloud

Conjuntos de parâmetros

(All)

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-EnvironmentVariable

Permite autenticação usando variáveis de ambiente configuradas na máquina anfitriã. Veja https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Propriedades dos parâmetros

Tipo:	System.Management.Automation.SwitchParameter
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EnvironmentVariableParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Identity

Iniciar sessão usando uma identidade gerida

Propriedades dos parâmetros

Tipo:	System.Management.Automation.SwitchParameter
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	ManagedIdentity, ManagedServiceIdentity, MSI

Conjuntos de parâmetros

IdentityParameterSet

Posto:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-NoWelcome

Esconde a mensagem de boas-vindas.

Propriedades dos parâmetros

Tipo:	System.Management.Automation.SwitchParameter
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Scopes

Um conjunto de permissões delegadas para consentir.

Propriedades dos parâmetros

Tipo:	System.String[]
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

UserParameterSet

Posto:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-SendCertificateChain

Incluir cabeçalho x5c nas reivindicações do cliente ao adquirir um token para permitir a autenticação baseada no nome do assunto / emissor usando o dado certificado.

Propriedades dos parâmetros

Tipo:	Boolean
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-TenantId

Especifica a identificação de um inquilino.

Se não especificar este parâmetro, a conta é autenticada junto do inquilino da casa.

Deve especificar o parâmetro TenantId para autenticar como principal de serviço ou ao usar a conta conta Microsoft.

Propriedades dos parâmetros

Tipo:	System.String
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Público-alvo, Inquilino

Conjuntos de parâmetros

UserParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

AppCertificateParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

AppSecretCredentialParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-UseDeviceCode

Use a autenticação de código de dispositivo em vez de um controle de navegador.

Propriedades dos parâmetros

Tipo:	System.Management.Automation.SwitchParameter
Valor predefinido:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	UseDeviceAuthentication, Código do dispositivo, DeviceAuth, Dispositivo

Conjuntos de parâmetros

UserParameterSet

Posto:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Ligações Relacionadas

• Disconnect-Entra