Connect-IPPSSession
Esse cmdlet está disponível apenas no módulo Exchange Online PowerShell. Para obter mais informações, consulte Sobre o módulo Exchange Online PowerShell.
Use o cmdlet Connect-IPPSSession no módulo Exchange Online PowerShell para se conectar ao PowerShell de Conformidade de Segurança & usando a autenticação moderna. O cmdlet funciona para contas habilitadas para MFA ou não MFA.
Observação: a versão 3.2.0 ou posterior do módulo dá suporte ao modo de API REST para a maioria dos cmdlets do PowerShell de conformidade de segurança & (a autenticação básica no WinRM no computador local não é necessária para o modo de API REST). Para obter mais informações, consulte Pré-requisitos para o módulo Exchange Online PowerShell.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
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 obter instruções de conexão detalhadas, incluindo pré-requisitos, consulte Conectar-se ao PowerShell de Conformidade de Segurança&.
Exemplos
Exemplo 1
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.comEste exemplo se conecta ao PowerShell de Conformidade de Segurança & usando a conta especificada e a autenticação moderna, com ou sem MFA. No v3.2.0 ou posterior do módulo, estamos nos conectando no modo de API REST, portanto, a autenticação básica no WinRM não é necessária no computador local.
Exemplo 2
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSessionEste exemplo se conecta ao PowerShell de Conformidade de Segurança & usando a conta especificada e a autenticação moderna, com ou sem MFA. No v3.2.0 ou posterior do módulo, estamos nos conectando no modo remoto do PowerShell, portanto, a autenticação básica no WinRM é necessária no computador local.
Exemplo 3
Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"Este exemplo se conecta ao PowerShell de Conformidade de Segurança & em um cenário de script autônomo usando uma impressão digital de certificado.
Exemplo 4
Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"Este exemplo se conecta ao PowerShell de Conformidade de Segurança & em um cenário de script autônomo usando um arquivo de certificado. Esse método é mais adequado para cenários em que o certificado é armazenado em computadores remotos e buscado em runtime. Por exemplo, o certificado é armazenado no Key Vault do Azure.
Parâmetros
-AppId
O parâmetro AppId especifica a ID do aplicativo da entidade de serviço usada na CBA (autenticação baseada em certificado). Um valor válido é o GUID da ID do aplicativo (entidade de serviço). Por exemplo, 36ee4c6c-0812-40a2-b820-b22ebd02bce3.
Para obter mais informações, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-AzureADAuthorizationEndpointUri
O parâmetro AzureADAuthorizationEndpointUri especifica o ponto de extremidade Azure AD Autorização que pode emitir tokens de acesso OAuth2. Há suporte para os seguintes ambientes e valores relacionados do PowerShell:
- Conformidade de segurança & Do PowerShell no Microsoft 365 ou no Microsoft 365 GCC: não use esse parâmetro. O valor necessário é
https://login.microsoftonline.com/common, mas esse também é o valor padrão, portanto, você não precisa usar esse parâmetro. - PowerShell de Conformidade de Segurança & no Office 365 operado pela 21Vianet:
https://login.chinacloudapi.cn/common - PowerShell de Conformidade de Segurança & no Microsoft GCC High ou Microsoft DoD:
https://login.microsoftonline.us/common
Se você usar o parâmetro UserPrincipalName, não precisará usar o parâmetro AzureADAuthorizationEndpointUri para MFA ou usuários federados em ambientes que normalmente o exigem (UserPrincipalName ou AzureADAuthorizationEndpointUri é necessário; OK 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
A opção BypassMailboxAnchoring ignora o uso da dica de ancoragem da caixa de correio. Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Certificate
O parâmetro Certificado especifica o certificado usado para a CBA (autenticação baseada em certificado). Um valor válido é o valor do objeto X509Certificate2 do certificado.
Não use esse parâmetro com os parâmetros CertificateFilePath ou CertificateThumbprint.
Para obter mais informações sobre a CBA, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
| Type: | X509Certificate2 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateFilePath
O parâmetro CertificateFilePath especifica o certificado usado para CBA. Um valor válido é o caminho público completo para o arquivo de certificado. Use o parâmetro CertificatePassword com esse parâmetro.
Não use esse parâmetro com os parâmetros Certificate ou CertificateThumbprint.
Para obter mais informações sobre a CBA, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificatePassword
O parâmetro CertificatePassword especifica a senha necessária para abrir o arquivo de certificado quando você usa o parâmetro CertificateFilePath para identificar o certificado usado para CBA.
Você pode usar os seguintes métodos como um valor para este parâmetro:
(ConvertTo-SecureString -String '<password>' -AsPlainText -Force).- Antes de executar esse comando, armazene a senha como uma variável (por exemplo,
$password = Read-Host "Enter password" -AsSecureString), e use a variável ($password) para o valor. (Get-Credential).passworda ser solicitado a inserir a senha com segurança ao executar esse comando.
Para obter mais informações sobre a CBA, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
Observação: usar um comando ConvertTo-SecureString para armazenar a senha do certificado localmente derrota a finalidade de um método de conexão seguro para cenários de automação. Usar um comando Get-Credential para solicitar a senha do certificado com segurança não é ideal para cenários de automação. Em outras palavras, não há realmente nenhuma maneira automatizada e segura de se conectar usando um certificado local.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateThumbprint
O parâmetro CertificateThumbprint especifica o certificado usado para CBA. Um valor válido é o valor da impressão digital do certificado. Por exemplo, 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.
Não use esse parâmetro com os parâmetros Certificate ou CertificateFilePath.
Observação: o parâmetro CertificateThumbprint só tem suporte no Microsoft Windows.
Para obter mais informações sobre a CBA, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CommandName
O parâmetro CommandName especifica a lista separada de vírgulas de comandos a serem importados para a sessão. Use esse parâmetro para aplicativos ou scripts que usam um conjunto específico de cmdlets. Reduzir o número de cmdlets na sessão ajuda a melhorar o desempenho e reduz o volume de memória do aplicativo ou script.
| Type: | String[] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ConnectionUri
O parâmetro ConnectionUri especifica o ponto de extremidade de conexão para a sessão remota do PowerShell. Há suporte para os seguintes ambientes e valores relacionados do PowerShell:
- Conformidade de segurança & Do PowerShell no Microsoft 365 ou no Microsoft 365 GCC: não use esse parâmetro. O valor necessário é
https://ps.compliance.protection.outlook.com/powershell-liveid/, mas esse também é o valor padrão, portanto, você não precisa usar esse parâmetro. - PowerShell de Conformidade de Segurança & no Office 365 operado pela 21Vianet:
https://ps.compliance.protection.partner.outlook.cn/powershell-liveid - PowerShell de Conformidade de Segurança & no Microsoft GCC High:
https://ps.compliance.protection.office365.us/powershell-liveid/ - PowerShell de Conformidade de Segurança & no 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
O parâmetro Credential especifica o nome de usuário e a senha usados para se conectar ao Exchange Online PowerShell. Normalmente, você usa esse parâmetro em scripts ou quando você precisa fornecer credenciais diferentes que têm as permissões necessárias. Não use esse parâmetro para contas que usam MFA (autenticação multifator).
Antes de executar o comando Connect-IPPSSession, armazene o nome de usuário e a senha em uma variável (por exemplo, $UserCredential = Get-Credential). Em seguida, use o nome da variável ($UserCredential) para esse parâmetro.
Depois que o comando Connect-IPPSSession for concluído, a chave de senha na variável será esvaziada.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-DelegatedOrganization
O parâmetro DelegatedOrganization especifica a organização do cliente que você deseja gerenciar (por exemplo, contosoelectronics.onmicrosoft.com). Esse parâmetro só funcionará se a organização do cliente tiver concordado com o gerenciamento delegado por meio do programa CSP.
Depois de autenticar com êxito, os cmdlets nesta sessão são mapeados para a organização do cliente e todas as operações nesta sessão são feitas na organização do cliente.
Observações:
- Use o domínio .onmicrosoft.com primário da organização delegada para o valor desse parâmetro.
- Você deve usar o parâmetro AzureADAuthorizationEndpointUri com esse parâmetro.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-FormatTypeName
O parâmetro FormatTypeName especifica o formato de saída do cmdlet.
| Type: | String[] |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Organization
O parâmetro Organização especifica a organização ao se conectar usando a CBA. Você deve usar o domínio .onmicrosoft.com primário da organização para o valor desse parâmetro.
Para obter mais informações sobre a CBA, consulte Autenticação somente aplicativo para scripts autônomos no módulo Exchange Online PowerShell.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Prefix
O parâmetro Prefix especifica um valor de texto a ser adicionado aos nomes dos cmdlets do PowerShell de Conformidade de Segurança & quando você se conecta. Por exemplo, Get-ComplianceCase se torna Get-ContosoComplianceCase quando você usa o valor Contoso para este parâmetro.
- O valor prefixo não pode conter espaços ou caracteres especiais, como sublinhados ou asteriscos.
- Você não pode usar o EXO do valor de prefixo. Esse valor é reservado para os nove cmdlets get-EXO* exclusivos que são incorporados ao módulo.
- O parâmetro Prefix afeta apenas nomes de cmdlet de conformidade de segurança & importados. Isso não afeta os nomes de cmdlets que são incorporados ao módulo (por exemplo, Disconnect-ExchangeOnline).
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PSSessionOption
O parâmetro PSSessionOption especifica as opções remotas de sessão do PowerShell a serem usadas em sua conexão com o PowerShell de Conformidade de Segurança & .
Armazene a saída do comando New-PSSessionOption em uma variável (por exemplo, $PSOptions = New-PSSessionOption <Settings>), e use o nome da variável como o valor para este parâmetro (por exemplo, $PSOptions).
| Type: | PSSessionOption |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UserPrincipalName
O parâmetro UserPrincipalName especifica a conta que você deseja usar para se conectar (por exemplo, navin@contoso.onmicrosoft.com). O uso desse parâmetro permite que você ignore a inserção de um nome de usuário no prompt de credenciais de autenticação moderna (você é solicitado a inserir uma senha).
Se você usar o parâmetro UserPrincipalName, não precisará usar o parâmetro AzureADAuthorizationEndpointUri para MFA ou usuários federados em ambientes que normalmente o exigem (UserPrincipalName ou AzureADAuthorizationEndpointUri é necessário; OK 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
Esse parâmetro está disponível na versão 3.2.0 ou posterior do módulo.
A opção UseRPSSession permite que você se conecte ao PowerShell de Conformidade de Segurança & usando o acesso remoto tradicional do PowerShell a todos os cmdlets. Não é preciso especificar um valor com essa opção.
Essa opção requer que a autenticação básica esteja habilitada no WinRM no computador local. Para obter mais informações, consulte Ativar a autenticação básica no WinRM.
Se você não usar essa opção, a autenticação básica no WinRM não será necessária.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |