Connect-IPPSSession

  • Referencia
Módulo:
ExchangePowerShell
Se aplica a:
Exchange Online

Este cmdlet solo está disponible en el módulo de PowerShell Exchange Online. Para obtener más información, vea Acerca de la Exchange Online módulo de PowerShell.

Use el cmdlet Connect-IPPSSession del módulo de PowerShell Exchange Online para conectarse a PowerShell de Cumplimiento de seguridad & mediante la autenticación moderna. El cmdlet funciona para cuentas mfa o no habilitadas para MFA.

Nota: La versión 3.2.0 o posterior del módulo admite el modo de API REST para la mayoría de los cmdlets de PowerShell de cumplimiento de seguridad & (la autenticación básica en WinRM en el equipo local no es necesaria para el modo de API REST). Para obtener más información, vea Requisitos previos para el módulo de PowerShell Exchange Online.

Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.

Syntax

Connect-IPPSSession
       [[-ConnectionUri] <String>]
       [[-AzureADAuthorizationEndpointUri] <String>]
       [[-DelegatedOrganization] <String>]
       [[-PSSessionOption] <PSSessionOption>]
       [[-Prefix] <String>]
       [[-CommandName] <String[]>]
       [[-FormatTypeName] <String[]>]
       [-AppId <String>]
       [-BypassMailboxAnchoring]
       [-Certificate <X509Certificate2>]
       [-CertificateFilePath <String>]
       [-CertificatePassword <SecureString>]
       [-CertificateThumbprint <String>]
       [-Credential <PSCredential>]
       [-Organization <String>]
       [-UserPrincipalName <String>]
       [-UseRPSSession]
       [<CommonParameters>]

Description

Para obtener instrucciones de conexión detalladas, incluidos los requisitos previos, consulte Conexión a PowerShell de cumplimiento de seguridad&.

Ejemplos

Ejemplo 1

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com

Este ejemplo se conecta a PowerShell de cumplimiento de seguridad & mediante la cuenta especificada y la autenticación moderna, con o sin MFA. En la versión 3.2.0 o posterior del módulo, nos conectamos en modo de API REST, por lo que la autenticación básica en WinRM no es necesaria en el equipo local.

Ejemplo 2

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession

Este ejemplo se conecta a PowerShell de cumplimiento de seguridad & mediante la cuenta especificada y la autenticación moderna, con o sin MFA. En la versión 3.2.0 o posterior del módulo, nos conectamos en modo remoto de PowerShell, por lo que se requiere la autenticación básica en WinRM en el equipo local.

Ejemplo 3

Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"

Este ejemplo se conecta a PowerShell de cumplimiento de seguridad & en un escenario de scripting desatendido mediante una huella digital de certificado.

Ejemplo 4

Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"

Este ejemplo se conecta a PowerShell de cumplimiento de seguridad & en un escenario de scripting desatendido mediante un archivo de certificado. Este método es más adecuado para escenarios en los que el certificado se almacena en máquinas remotas y se captura en tiempo de ejecución. Por ejemplo, el certificado se almacena en azure Key Vault.

Parámetros

-AppId

El parámetro AppId especifica el identificador de aplicación de la entidad de servicio que se usa en la autenticación basada en certificados (CBA). Un valor válido es el GUID del identificador de aplicación (entidad de servicio). Por ejemplo, 36ee4c6c-0812-40a2-b820-b22ebd02bce3.

Para obtener más información, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-AzureADAuthorizationEndpointUri

El parámetro AzureADAuthorizationEndpointUri especifica el punto de conexión de autorización de Azure AD que puede emitir tokens de acceso de OAuth2. Se admiten los siguientes entornos de PowerShell y los valores relacionados:

  • PowerShell de cumplimiento de seguridad & en Microsoft 365 o Microsoft 365 GCC: no use este parámetro. El valor necesario es https://login.microsoftonline.com/common, pero también es el valor predeterminado, por lo que no es necesario usar este parámetro.
  • PowerShell de cumplimiento de seguridad & en Office 365 operado por 21Vianet:https://login.chinacloudapi.cn/common
  • PowerShell de cumplimiento de seguridad & en Microsoft GCC High o Microsoft DoD: https://login.microsoftonline.us/common

Si usa el parámetro UserPrincipalName, no es necesario usar el parámetro AzureADAuthorizationEndpointUri para MFA o usuarios federados en entornos que lo requieran normalmente (se requiere UserPrincipalName o AzureADAuthorizationEndpointUri; Aceptar para usar ambos).

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-BypassMailboxAnchoring

El modificador BypassMailboxAnchoring omite el uso de la sugerencia de anclaje del buzón. No es necesario especificar un valor con este modificador.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Certificate

El parámetro Certificate especifica el certificado que se usa para la autenticación basada en certificados (CBA). Un valor válido es el valor del objeto X509Certificate2 del certificado.

No use este parámetro con los parámetros CertificateFilePath o CertificateThumbprint.

Para obtener más información sobre CBA, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateFilePath

El parámetro CertificateFilePath especifica el certificado que se usa para CBA. Un valor válido es la ruta de acceso pública completa al archivo de certificado. Use el parámetro CertificatePassword con este parámetro.

No use este parámetro con los parámetros Certificate o CertificateThumbprint.

Para obtener más información sobre CBA, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificatePassword

El parámetro CertificatePassword especifica la contraseña necesaria para abrir el archivo de certificado cuando se usa el parámetro CertificateFilePath para identificar el certificado que se usa para CBA.

Puede usar los métodos siguientes como valor para este parámetro:

  • (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).
  • Antes de ejecutar este comando, almacene la contraseña como variable (por ejemplo, ) y, a continuación, $password = Read-Host "Enter password" -AsSecureStringuse la variable ($password) para el valor.
  • (Get-Credential).password para que se le pida que escriba la contraseña de forma segura al ejecutar este comando.

Para obtener más información sobre CBA, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Nota: El uso de un comando ConvertTo-SecureString para almacenar la contraseña del certificado de forma local anula el propósito de un método de conexión seguro para escenarios de automatización. El uso de un comando Get-Credential para solicitar la contraseña del certificado de forma segura no es ideal para escenarios de automatización. En otras palabras, realmente no hay ninguna manera automatizada y segura de conectarse mediante un certificado local.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateThumbprint

El parámetro CertificateThumbprint especifica el certificado que se usa para CBA. Un valor válido es el valor de huella digital del certificado. Por ejemplo, 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.

No use este parámetro con los parámetros Certificate o CertificateFilePath.

Nota: El parámetro CertificateThumbprint solo se admite en Microsoft Windows.

Para obtener más información sobre CBA, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CommandName

El parámetro CommandName especifica la lista separada por comas de los comandos que se van a importar en la sesión. Use este parámetro para las aplicaciones o scripts que usan un conjunto específico de cmdlets. Reducir el número de cmdlets de la sesión ayuda a mejorar el rendimiento y reduce la superficie de memoria de la aplicación o el script.

Type:String[]
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ConnectionUri

El parámetro ConnectionUri especifica el punto de conexión para la sesión remota de PowerShell. Se admiten los siguientes entornos de PowerShell y los valores relacionados:

  • PowerShell de cumplimiento de seguridad & en Microsoft 365 o Microsoft 365 GCC: no use este parámetro. El valor necesario es https://ps.compliance.protection.outlook.com/powershell-liveid/, pero también es el valor predeterminado, por lo que no es necesario usar este parámetro.
  • PowerShell de cumplimiento de seguridad & en Office 365 operado por 21Vianet:https://ps.compliance.protection.partner.outlook.cn/powershell-liveid
  • PowerShell de cumplimiento de seguridad & en Microsoft GCC High: https://ps.compliance.protection.office365.us/powershell-liveid/
  • PowerShell de cumplimiento de seguridad & en Microsoft DoD: https://l5.ps.compliance.protection.office365.us/powershell-liveid/
Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Credential

El parámetro Credential especifica el nombre de usuario y la contraseña que se usan para conectarse a Exchange Online PowerShell. Por lo general, este parámetro se usa en scripts o cuando deben proporcionarse credenciales diferentes que disponen de los permisos necesarios. No use este parámetro para las cuentas que usan la autenticación multifactor (MFA).

Antes de ejecutar el comando Connect-IPPSSession, almacene el nombre de usuario y la contraseña en una variable (por ejemplo, $UserCredential = Get-Credential). A continuación, use el nombre de variable ($UserCredential) para este parámetro.

Una vez completado el comando Connect-IPPSSession, se vacía la clave de contraseña de la variable.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-DelegatedOrganization

El parámetro DelegatedOrganization especifica la organización del cliente que desea administrar (por ejemplo, contosoelectronics.onmicrosoft.com). Este parámetro solo funciona si la organización del cliente ha aceptado la administración delegada a través del programa CSP.

Después de autenticarse correctamente, los cmdlets de esta sesión se asignan a la organización del cliente y todas las operaciones de esta sesión se realizan en la organización del cliente.

Notas:

  • Use el dominio .onmicrosoft.com principal de la organización delegada para el valor de este parámetro.
  • Debe usar el parámetro AzureADAuthorizationEndpointUri con este parámetro.
Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-FormatTypeName

El parámetro FormatTypeName especifica el formato de salida del cmdlet.

Type:String[]
Position:6
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Organization

El parámetro Organization especifica la organización al conectarse mediante CBA. Debe usar el dominio .onmicrosoft.com principal de la organización para el valor de este parámetro.

Para obtener más información sobre CBA, consulte Autenticación de solo aplicación para scripts desatendidos en el módulo de PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Prefix

El parámetro Prefix especifica un valor de texto que se va a agregar a los nombres de los cmdlets de PowerShell de cumplimiento de seguridad & al conectarse. Por ejemplo, Get-ComplianceCase se convierte en Get-ContosoComplianceCase cuando se usa el valor Contoso para este parámetro.

  • El valor Prefix no puede contener espacios ni caracteres especiales, como caracteres de subrayado o asteriscos.
  • No se puede usar el valor prefijo EXO. Ese valor está reservado para los nueve cmdlets get-EXO* exclusivos integrados en el módulo.
  • El parámetro Prefix solo afecta a los nombres de cmdlet de cumplimiento de seguridad & importados. No afecta a los nombres de los cmdlets integrados en el módulo (por ejemplo, Disconnect-ExchangeOnline).
Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PSSessionOption

El parámetro PSSessionOption especifica las opciones de sesión remotas de PowerShell que se usarán en la conexión a PowerShell de cumplimiento de seguridad & .

Almacene la salida del comando New-PSSessionOption en una variable (por ejemplo, $PSOptions = New-PSSessionOption <Settings>) y use el nombre de la variable como valor para este parámetro (por ejemplo, $PSOptions).

Type:PSSessionOption
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UserPrincipalName

El parámetro UserPrincipalName especifica la cuenta que desea usar para conectarse (por ejemplo, navin@contoso.onmicrosoft.com). El uso de este parámetro le permite omitir la entrada de un nombre de usuario en el símbolo del sistema de credenciales de autenticación moderna (se le pedirá que escriba una contraseña).

Si usa el parámetro UserPrincipalName, no es necesario usar el parámetro AzureADAuthorizationEndpointUri para MFA o usuarios federados en entornos que lo requieran normalmente (se requiere UserPrincipalName o AzureADAuthorizationEndpointUri; Aceptar para usar ambos).

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UseRPSSession

Este parámetro está disponible en la versión 3.2.0 o posterior del módulo.

El modificador UseRPSSession permite conectarse a PowerShell de cumplimiento de seguridad & mediante el acceso remoto tradicional de PowerShell a todos los cmdlets. No es necesario especificar un valor con este modificador.

Este modificador requiere que la autenticación básica esté habilitada en WinRM en el equipo local. Para obtener más información, vea Activar la autenticación básica en WinRM.

Si no usa este modificador, no se requiere la autenticación básica en WinRM.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online