Connect-Entra

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

Conéctese a Microsoft Entra ID con una cuenta autenticada.

Sintaxis

UserParameterSet (valor predeterminado) 

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

El Connect-Entra cmdlet se conecta a Microsoft Entra ID con una cuenta autenticada.

Se admiten varios escenarios de autenticación en función del caso de uso, como delegado (interactivo) y solo aplicación (no interactivo).

Connect-Entra es un alias de Connect-MgGraph.

Ejemplos

Ejemplo 1: Acceso delegado: Conexión de una sesión de PowerShell a un inquilino

Connect-Entra

En este ejemplo se muestra cómo conectar la sesión actual de PowerShell a un inquilino de Microsoft Entra ID mediante credenciales.

Ejemplo 2: Acceso delegado: Conexión de una sesión de PowerShell a un inquilino con ámbitos necesarios

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

Welcome to Microsoft Graph!

En este ejemplo se muestra cómo autenticarse en Microsoft Entra ID con ámbitos.

Ejemplo 3: Acceso delegado: Uso de un token de acceso

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

Welcome to Microsoft Graph!

En este ejemplo se muestra cómo autenticarse interactivamente en Microsoft Entra ID mediante un token de acceso.

Para obtener más información sobre cómo obtener o crear un token de acceso, consulte Solicitud de un token de acceso.

Ejemplo 4: Acceso delegado: Uso del flujo de código 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.

En este ejemplo se muestra cómo autenticarse interactivamente en Microsoft Entra ID mediante el flujo de código del dispositivo.

Para obtener más información, consulte Flujo de código de dispositivo.

Ejemplo 5: Acceso de solo aplicación: Uso de credenciales de cliente con una huella digital de certificado

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

Connect-Entra @connectParams

Welcome to Microsoft Graph!

En este ejemplo se muestra cómo autenticarse mediante applicationId y CertificateThumbprint.

Para obtener más información sobre cómo obtener o crear CertificateThumbprint, consulte Autenticación con acceso de solo aplicación.

Ejemplo 6: Acceso de solo aplicación: Uso de credenciales de cliente con un nombre 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

Para encontrar el firmante del certificado, ejecute el comando anterior.

Ejemplo 7: Acceso de solo aplicación: Uso de credenciales de cliente con un 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

Ejemplo 8: Acceso de solo aplicación: Uso de credenciales secretas de 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 autenticación es ideal para interacciones en segundo plano.

Para obtener más información sobre cómo obtener credenciales, consulte Comando Get-Credential .

Ejemplo 9: Acceso de solo aplicación: Uso de la identidad administrada: identidad administrada asignada por el sistema

Connect-Entra -Identity

Usa una identidad administrada automáticamente en una instancia de servicio. La identidad está vinculada al ciclo de vida de una instancia de servicio.

Ejemplo 10: Acceso solo a la aplicación: Uso de la identidad administrada: Identidad administrada asignada por el usuario

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Usa una identidad administrada creada por el usuario como un recurso de Azure independiente.

Ejemplo 11: Conexión a un entorno como una identidad diferente

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Para conectarse como una identidad diferente a CurrentUser, especifique el parámetro ContextScope con el valor Process.

Para obtener más información sobre cómo obtener el contexto actual, vea Comando Get-EntraContext .

Ejemplo 12: Conexión a un entorno o nube

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'

Al usar Connect-Entra, puede elegir establecer como destino otros entornos. De forma predeterminada, Connect-Entra tiene como destino la nube pública global.

Ejemplo 13: establece el tiempo de espera del cliente HTTP en segundos

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

En este ejemplo se establece el tiempo de espera del cliente HTTP en segundos.

Ejemplo 14: Oculta el mensaje de bienvenida

Connect-Entra -NoWelcome

En este ejemplo se oculta el mensaje de bienvenida.

Ejemplo 15: Permite la autenticación mediante variables de entorno

Connect-Entra -EnvironmentVariable

Este ejemplo permite la autenticación mediante variables de entorno.

Parámetros

-AccessToken

Especifica un token de portador para Microsoft Entra servicio. Los tokens de acceso agotan el tiempo de espera y tiene que controlar su actualización.

Propiedades de parámetro

Tipo:SecureString
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AccessTokenParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Certificate

Un certificado X.509 proporcionado durante la invocación.

Propiedades de parámetro

Tipo:X509Certificate2
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-CertificateSubjectName

Nombre distintivo del firmante de un certificado. El certificado se recupera del almacén de certificados del usuario actual.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:CertificateSubject, CertificateName

Conjuntos de parámetros

AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-CertificateThumbprint

Especifica la huella digital del certificado de un certificado X.509 de clave pública digital de una cuenta de usuario que tiene permiso para realizar esta acción.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ClientId

Especifica el identificador de aplicación de la entidad de servicio.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AppId, ApplicationId

Conjuntos de parámetros

UserParameterSet
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
IdentityParameterSet
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
AppCertificateParameterSet
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ClientSecretCredential

El objeto PSCredential proporciona el identificador de aplicación y el secreto de cliente para las credenciales de la entidad de servicio. Para obtener más información sobre el objeto PSCredential, escriba Get-Help Get-Credential.

Propiedades de parámetro

Tipo:PSCredential
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:SecretCredential, Credencial

Conjuntos de parámetros

AppSecretCredentialParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ClientTimeout

Establece el tiempo de espera del cliente HTTP en segundos.

Propiedades de parámetro

Tipo:System.Double
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ContextScope

Determina el ámbito del contexto de autenticación. ContextScope acepta para el proceso actual o CurrentUser para todas las sesiones iniciadas Process por el usuario.

Propiedades de parámetro

Tipo:ContextScope
Valor predeterminado:None
Valores aceptados:Process, CurrentUser
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

UserParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
IdentityParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
AppSecretCredentialParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
EnvironmentVariableParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Environment

Nombre del entorno de nube nacional al que se va a conectar. De forma predeterminada, se usa la nube global.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:EnvironmentName, NationalCloud

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnvironmentVariable

Permite la autenticación mediante variables de entorno configuradas en el equipo host. Vea https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

EnvironmentVariableParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Identity

Inicio de sesión con una identidad administrada

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:ManagedIdentity, Identidad de Servicio Gestionado, MSI

Conjuntos de parámetros

IdentityParameterSet
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-NoWelcome

Oculta el mensaje de bienvenida.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Scopes

Matriz de permisos delegados para dar su consentimiento.

Propiedades de parámetro

Tipo:

System.String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

UserParameterSet
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SendCertificateChain

Incluya el encabezado x5c en las notificaciones de cliente al adquirir un token para habilitar la autenticación basada en el nombre del firmante o emisor mediante un certificado determinado.

Propiedades de parámetro

Tipo:Boolean
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-TenantId

Especifica el identificador de un inquilino.

Si no especifica este parámetro, la cuenta se autentica con el inquilino principal.

Debe especificar el parámetro TenantId para autenticarse como entidad de servicio o al usar cuenta Microsoft.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Público, Tenant

Conjuntos de parámetros

UserParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
AppCertificateParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
AppSecretCredentialParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-UseDeviceCode

Use la autenticación de código de dispositivo en lugar de un control del explorador.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:UseDeviceAuthentication, DeviceCode, DeviceAuth, Dispositivo

Conjuntos de parámetros

UserParameterSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.