Connect-Entra

Módulo:: Microsoft.Entra.Authentication Module v1.3

Conecte-se a Microsoft Entra ID com uma conta autenticada.

Sintaxe

UserParameterSet (Default)

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

O Connect-Entra cmdlet se conecta a Microsoft Entra ID com uma conta autenticada.

Há suporte para vários cenários de autenticação com base no caso de uso, como delegado (interativo) e somente aplicativo (não interativo).

Connect-Entra é um alias para Connect-MgGraph.

Exemplos

Exemplo 1: acesso delegado: conectar uma sessão do PowerShell a um locatário

Connect-Entra

Este exemplo mostra como conectar sua sessão atual do PowerShell a um locatário Microsoft Entra ID usando credenciais.

Exemplo 2: Acesso delegado: conectar uma sessão do PowerShell a um locatário com escopos necessários

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

Welcome to Microsoft Graph!

Este exemplo mostra como autenticar para Microsoft Entra ID com escopos.

Exemplo 3: Acesso delegado: usando 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 Microsoft Entra ID usando um token de acesso.

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

Exemplo 4: Acesso delegado: usando o 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 Microsoft Entra ID usando o fluxo de código do dispositivo.

Para obter mais informações, consulte o fluxo do Código do Dispositivo.

Exemplo 5: acesso somente aplicativo: usando a credencial do cliente com uma 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 ApplicationId e CertificateThumbprint.

Para obter mais informações sobre como obter ou criar CertificateThumbprint, consulte Authenticate with app-only access.

Exemplo 6: Acesso somente aplicativo: usando a credencial do cliente com um 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

Você pode encontrar a entidade de certificado executando o comando acima.

Exemplo 7: Acesso somente aplicativo: usando a credencial do cliente com um 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 somente aplicativo: usando credenciais de segredo 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

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

Para obter mais informações sobre como obter a credencial, consulte o comando Get-Credential .

Exemplo 9: Acesso somente aplicativo: Usando a identidade gerenciada: identidade gerenciada atribuída pelo sistema

Connect-Entra -Identity

Usa uma identidade gerenciada automaticamente em uma instância de serviço. A identidade está vinculada ao ciclo de vida de uma instância de serviço.

Exemplo 10: Acesso somente aplicativo: usando a identidade gerenciada: identidade gerenciada atribuída pelo usuário

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Usa uma identidade gerenciada criada pelo usuário como um recurso de Azure autônomo.

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

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Para se conectar como uma identidade diferente do CurrentUser, especifique o parâmetro ContextScope com o processo de valor.

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

Exemplo 12: Conectando-se a um ambiente ou nuvem

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'

Ao usar o Connect-Entra, você pode optar por direcionar outros ambientes. Por padrão, Connect-Entra tem como destino a nuvem pública global.

Exemplo 13: define o tempo limite do cliente HTTP em segundos

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

Este exemplo define o tempo limite do cliente HTTP em segundos.

Exemplo 14: oculta a mensagem de boas-vindas

Connect-Entra -NoWelcome

Este exemplo oculta a mensagem de boas-vindas.

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

Connect-Entra -EnvironmentVariable

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

Parâmetros

-AccessToken

Especifica um token de portador para Microsoft Entra serviço. Os tokens de acesso passam o tempo limite e você precisa lidar com a atualização deles.

Propriedades do parâmetro

Tipo:	SecureString
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

AccessTokenParameterSet

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Certificate

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

Propriedades do parâmetro

Tipo:	X509Certificate2
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-CertificateSubjectName

O nome diferenciado da entidade de um certificado. O certificado é recuperado do repositório de certificados do usuário atual.

Propriedades do parâmetro

Tipo:	System.String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	CertificateSubject, CertificateName

Conjuntos de parâmetros

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-CertificateThumbprint

Especifica a impressão digital do certificado de um certificado X.509 de chave pública digital de uma conta de usuário que tem permissão para executar essa ação.

Propriedades do parâmetro

Tipo:	System.String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ClientId

Especifica a ID do aplicativo da entidade de serviço.

Propriedades do parâmetro

Tipo:	System.String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	AppId, ApplicationId

Conjuntos de parâmetros

UserParameterSet

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

IdentityParameterSet

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

AppCertificateParameterSet

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ClientSecretCredential

O objeto PSCredential fornece a ID do aplicativo e o segredo do cliente para credenciais da entidade de serviço. Para obter mais informações sobre o objeto PSCredential, digite Get-Help Get-Credential.

Propriedades do parâmetro

Tipo:	PSCredential
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	SecretCredential, Credential

Conjuntos de parâmetros

AppSecretCredentialParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ClientTimeout

Define o tempo limite do cliente HTTP em segundos.

Propriedades do parâmetro

Tipo:	System.Double
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ContextScope

Determina o escopo do contexto de autenticação. Este ContextScope aceita Process o processo atual ou CurrentUser para todas as sessões iniciadas pelo usuário.

Propriedades do parâmetro

Tipo:	ContextScope
Valor padrão:	None
Valores aceitos:	Process, CurrentUser
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

UserParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

IdentityParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

AppSecretCredentialParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

EnvironmentVariableParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Environment

O nome do ambiente de nuvem nacional ao qual se conectar. Por padrão, a nuvem global é usada.

Propriedades do parâmetro

Tipo:	System.String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	EnvironmentName, NationalCloud

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-EnvironmentVariable

Permite a autenticação usando variáveis de ambiente configuradas no computador host. Consulte https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Propriedades do parâmetro

Tipo:	System.Management.Automation.SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

EnvironmentVariableParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Identity

Entrar usando uma identidade gerenciada

Propriedades do parâmetro

Tipo:	System.Management.Automation.SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	ManagedIdentity, ManagedServiceIdentity, MSI

Conjuntos de parâmetros

IdentityParameterSet

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-NoWelcome

Oculta a mensagem de boas-vindas.

Propriedades do parâmetro

Tipo:	System.Management.Automation.SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Scopes

Uma matriz de permissões delegadas às quais consentir.

Propriedades do parâmetro

Tipo:	System.String[]
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

UserParameterSet

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-SendCertificateChain

Inclua o cabeçalho x5c em declarações de cliente ao adquirir um token para habilitar a autenticação baseada em nome da entidade/emissor usando determinado certificado.

Propriedades do parâmetro

Tipo:	Boolean
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TenantId

Especifica a ID de um locatário.

Se você não especificar esse parâmetro, a conta será autenticada com o locatário residencial.

Você deve especificar o parâmetro TenantId para autenticar como uma entidade de serviço ou ao usar conta Microsoft.

Propriedades do parâmetro

Tipo:	System.String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	Audiência, Inquilino

Conjuntos de parâmetros

UserParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

AppCertificateParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

AppSecretCredentialParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-UseDeviceCode

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

Propriedades do parâmetro

Tipo:	System.Management.Automation.SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Dispositivo

Conjuntos de parâmetros

UserParameterSet

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	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.

Disconnect-Entra

Comentários

Esta página foi útil?

Connect-Entra

Sintaxe

UserParameterSet (Default)

AppCertificateParameterSet

IdentityParameterSet

AppSecretCredentialParameterSet

AccessTokenParameterSet

EnvironmentVariableParameterSet

Description

Exemplos

Exemplo 1: acesso delegado: conectar uma sessão do PowerShell a um locatário

Exemplo 2: Acesso delegado: conectar uma sessão do PowerShell a um locatário com escopos necessários

Exemplo 3: Acesso delegado: usando um token de acesso

Exemplo 4: Acesso delegado: usando o fluxo de código do dispositivo

Exemplo 5: acesso somente aplicativo: usando a credencial do cliente com uma impressão digital do Certificado

Exemplo 6: Acesso somente aplicativo: usando a credencial do cliente com um nome de certificado

Exemplo 7: Acesso somente aplicativo: usando a credencial do cliente com um certificado

Exemplo 8: Acesso somente aplicativo: usando credenciais de segredo do cliente

Exemplo 9: Acesso somente aplicativo: Usando a identidade gerenciada: identidade gerenciada atribuída pelo sistema

Exemplo 10: Acesso somente aplicativo: usando a identidade gerenciada: identidade gerenciada atribuída pelo usuário

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

Exemplo 12: Conectando-se a um ambiente ou nuvem

Exemplo 13: define o tempo limite do cliente HTTP em segundos

Exemplo 14: oculta a mensagem de boas-vindas

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

Parâmetros

-AccessToken

Propriedades do parâmetro

Conjuntos de parâmetros

-Certificate

Propriedades do parâmetro

Conjuntos de parâmetros

-CertificateSubjectName

Propriedades do parâmetro

Conjuntos de parâmetros

-CertificateThumbprint

Propriedades do parâmetro

Conjuntos de parâmetros

-ClientId

Propriedades do parâmetro

Conjuntos de parâmetros

-ClientSecretCredential

Propriedades do parâmetro

Conjuntos de parâmetros

-ClientTimeout

Propriedades do parâmetro

Conjuntos de parâmetros

-ContextScope

Propriedades do parâmetro

Conjuntos de parâmetros

-Environment

Propriedades do parâmetro

Conjuntos de parâmetros

-EnvironmentVariable

Propriedades do parâmetro

Conjuntos de parâmetros

-Identity

Propriedades do parâmetro

Conjuntos de parâmetros

-NoWelcome

Propriedades do parâmetro

Conjuntos de parâmetros

-Scopes

Propriedades do parâmetro

Conjuntos de parâmetros

-SendCertificateChain

Propriedades do parâmetro

Conjuntos de parâmetros

-TenantId

Propriedades do parâmetro

Conjuntos de parâmetros

-UseDeviceCode

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Links Relacionados

Comentários