Connect-ExchangeOnline
Este cmdlet está disponível somente no módulo do PowerShell do Exchange Online. Para obter mais informações, consulte Sobre o módulo do PowerShell do Exchange Online.
Use o cmdlet Connect-ExchangeOnline no módulo Exchange Online PowerShell para usar a autenticação moderna para se conectar ao Exchange Online PowerShell ou PowerShell para o complemento de segurança interna para caixas de correio locais. Este cmdlet funciona para contas com ou sem autenticação multifator (MFA).
Para se conectar ao PowerShell de Segurança & Conformidade, use o cmdlet Connect-IPPSSession .
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Default (Default)
Connect-ExchangeOnline
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
[[-PSSessionOption] <PSSessionOption>]
[[-DelegatedOrganization] <String>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AccessToken <String>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-Device]
[-DisableWAM]
[-EnableErrorReporting]
[-EXOModuleBasePath <String>]
[-InlineCredential]
[-LoadCmdletHelp]
[-LogDirectoryPath <String>]
[-LogLevel <LogLevel>]
[-ManagedIdentity]
[-ManagedIdentityAccountId <String>]
[-Organization <String>]
[-PageSize <UInt32>]
[-ShowBanner]
[-ShowProgress <Boolean>]
[-SigningCertificate <X509Certificate2>]
[-SkipLoadingCmdletHelp]
[-SkipLoadingFormatData]
[-TrackPerformance <Boolean>]
[-UseMultithreading <Boolean>]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]
Description
Este cmdlet cria uma conexão do PowerShell com sua organização do Exchange Online.
Os comandos de Conexão provavelmente falharão se o caminho do perfil da conta usada para conectar contiver caracteres especiais do PowerShell (por exemplo, $). A solução alternativa é conectar-se usando uma conta diferente que não tenha caracteres especiais no caminho do perfil.
Exemplos
Exemplo 1
Connect-ExchangeOnline -UserPrincipalName chris@contoso.com
Este exemplo se conecta ao PowerShell do Exchange Online usando autenticação moderna, com ou sem MFA (autenticação multifator). A conexão usa o modo API REST e não exige que a autenticação Básica seja habilitada no WinRM no computador local.
Exemplo 2
Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"
Este exemplo se conecta ao PowerShell do Exchange Online em um cenário de script autônomo usando uma impressão digital de certificado.
Exemplo 3
Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"
Este exemplo se conecta ao PowerShell do Exchange Online 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 tempo de execução. Por exemplo, o certificado é armazenado no Azure Key Vault.
Exemplo 4
Connect-ExchangeOnline -Device
No PowerShell 7.0.3 ou posterior usando a versão 2.0.4 ou posterior do módulo, este exemplo se conecta ao PowerShell do Exchange Online em cenários de script interativo em computadores que não têm navegadores da Web.
O comando retorna um URL e um código exclusivo vinculado à sessão. Você precisa abrir o URL em um navegador em qualquer computador e, em seguida, inserir o código exclusivo. Depois de concluir o logon no navegador da Web, a sessão na janela do Powershell 7 é autenticada por meio do fluxo de autenticação regular do Microsoft Entra e os cmdlets do Exchange Online são importados após alguns segundos.
Exemplo 6
Connect-ExchangeOnline -InlineCredential
No PowerShell 7.0.3 ou posterior usando a versão 2.0.4 ou posterior do módulo, este exemplo se conecta ao PowerShell do Exchange Online em cenários de script interativo passando credenciais diretamente na janela do PowerShell.
Parâmetros
-AccessToken
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 3.1.0-Preview1 ou posterior do módulo.
O parâmetro AccessToken especifica o JWT (Token Web JSON) OAuth usado para se conectar ao Exchange Online.
Dependendo do tipo de token de acesso, você precisa usar esse parâmetro com os parâmetros Organization, DelegatedOrganization ou UserPrincipalName.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-AppId
Aplicável: Exchange Online
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 de aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-AzureADAuthorizationEndpointUri
Aplicável: Exchange Online
Observação: se você usar o parâmetro ExchangeEnvironmentName, não precisará usar os parâmetros AzureADAuthorizationEndpointUri ou ConnectionUri.
O parâmetro AzureADAuthorizationEndpointUri especifica o ponto de extremidade de autorização do Microsoft Entra que pode emitir tokens de acesso OAuth2. Os seguintes ambientes do PowerShell do Exchange Online e os valores relacionados têm suporte:
- Microsoft 365 ou Microsoft 365 GCC: não use esse parâmetro. O valor necessário é
https://login.microsoftonline.com/organizations, mas esse também é o valor padrão, portanto, você não precisa usar esse parâmetro. - Office 365 Alemanha:
https://login.microsoftonline.de/organizations - Microsoft 365 GCC High ou Microsoft 365 DoD:
https://login.microsoftonline.us/organizations
O valor URI que termina em /organizations permite apenas contas corporativas ou de estudante. O valor de URI mais antigo que termina em /common ainda funciona, mas pode solicitar que você escolha entre uma conta pessoal e uma conta corporativa ou de estudante. Recomendamos o valor URI /organizations em cenários corporativos onde as contas de consumidor devem ser excluídas.
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).
Observação: a autenticação MFA ou a autenticação federada não estão disponíveis no Office 365 operado pela 21Vianet.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-BypassMailboxAnchoring
Aplicável: Exchange Online
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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| 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 |
-Certificate
Aplicável: Exchange Online
O parâmetro Certificate especifica o certificado usado para autenticação baseada em certificado (CBA). 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 o CBA, consulte Autenticação somente de aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | X509Certificate2 |
| 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 |
-CertificateFilePath
Aplicável: Exchange Online
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 o CBA, consulte Autenticação somente de aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-CertificatePassword
Aplicável: Exchange Online
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 esse 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).passwordserá solicitado a inserir a senha com segurança ao executar esse comando.
Para obter mais informações sobre o CBA, consulte Autenticação somente de aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Observação: usar um comando ConvertTo-SecureString para armazenar a senha do certificado localmente anula a finalidade de um método de conexão segura 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.
Propriedades do parâmetro
| Tipo: | SecureString |
| 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 |
-CertificateThumbprint
Aplicável: Exchange Online
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 tem suporte apenas no Microsoft Windows.
Para obter mais informações sobre o CBA, consulte Autenticação somente de aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-CommandName
Aplicável: Exchange Online
O parâmetro CommandName especifica a lista separada por 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.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 6 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ConnectionUri
Aplicável: Exchange Online
Observação: se você usar o parâmetro ExchangeEnvironmentName, não precisará usar os parâmetros AzureADAuthorizationEndpointUri ou ConnectionUri.
O parâmetro ConnectionUri especifica o ponto de extremidade de conexão para a sessão do PowerShell. Os seguintes ambientes do PowerShell do Exchange Online e os valores relacionados têm suporte:
- Microsoft 365 ou Microsoft 365 GCC: não use esse parâmetro. O valor necessário é
https://outlook.office365.com/powershell-liveid/, mas esse também é o valor padrão, portanto, você não precisa usar esse parâmetro. - Office 365 Alemanha:
https://outlook.office.de/PowerShell-LiveID - Office 365 operado pela 21Vianet:
https://partner.outlook.cn/PowerShell - Microsoft 365 GCC High:
https://outlook.office365.us/powershell-liveID - Microsoft 365 DoD:
https://webmail.apps.mil/powershell-liveID
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Credential
Aplicável: Exchange Online
O parâmetro Credential especifica o nome de usuário e a senha usados para se conectar ao PowerShell do Exchange Online. 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 a MFA (autenticação multifator).
Antes de executar o comando Connect-ExchangeOnline, 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-ExchangeOnline é concluído, a chave de senha na variável é esvaziada.
Para especificar a senha de um arquivo de certificado, não use esse parâmetro; em vez disso, use o parâmetro CertificatePassword.
Propriedades do parâmetro
| Tipo: | PSCredential |
| 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 |
-DelegatedOrganization
Aplicável: Exchange Online
O parâmetro DelegatedOrganization especifica a organização do cliente que você deseja gerenciar. Um valor válido para esse parâmetro é o domínio .onmicrosoft.com primário ou a ID de locatário da organização do cliente.
Esse parâmetro funcionará somente 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 4 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Device
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 2.0.4-Preview6 ou posterior do módulo e somente no PowerShell 7.
A opção Dispositivo normalmente é usada em computadores sem navegadores da Web. Não é preciso especificar um valor com essa opção.
O uso dessa opção resulta em uma mensagem na tela que contém a URL https://microsoft.com/devicelogin e um código exclusivo. Em qualquer outro dispositivo com um navegador da Web e acesso à Internet, abra a URL, insira o código exclusivo e insira suas credenciais nas páginas subsequentes.
Se o logon tiver sido bem-sucedido, a conexão com o PowerShell continuará.
Propriedades do parâmetro
| Tipo: | 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 |
-DisableWAM
Aplicável: Exchange Online
Nota: Este parâmetro está disponível na versão do módulo 3.7.2-Preview1 ou posterior.
O comutador DisableWAM desabilita o WAM (Gerenciador de Contas da Web). Não é preciso especificar um valor com essa opção.
A partir da versão 3.7.0, o WAM é habilitado por padrão ao se conectar ao Exchange Online. Se encontrar problemas relacionados ao WAM durante a entrada, você poderá usar essa opção para desabilitar o WAM.
Propriedades do parâmetro
| Tipo: | 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 |
-EnableErrorReporting
Aplicável: Exchange Online
A opção EnableErrorReporting especifica se o relatório de erros deve ser habilitado. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | 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 |
-ExchangeEnvironmentName
Aplicável: Exchange Online
O ExchangeEnvironmentName especifica o ambiente do Exchange Online e elimina a necessidade de usar os parâmetros AzureADAuthorizationEndpointUri e ConnectionUri. Os seguintes ambientes do PowerShell do Exchange Online têm suporte:
- Microsoft 365 ou Microsoft 365 GCC: não use esse parâmetro. O valor necessário é
O365Default, mas esse também é o valor padrão, portanto, você não precisa usar esse parâmetro. - Office 365 Alemanha:
O365GermanyCloud - Office 365 operado pela 21Vianet:
O365China - Microsoft 365 GCC High:
O365USGovGCCHigh - Microsoft 365 DoD:
O365USGovDoD
Propriedades do parâmetro
| Tipo: | ExchangeEnvironment |
| Valor padrão: | O365Default |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-EXOModuleBasePath
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 3.9.1-Preview1 ou posterior do módulo.
O parâmetro EXOModuleBasePath especifica a pasta em que a cópia temporária local do módulo do PowerShell do Exchange Online está armazenada. Se o valor contiver espaços, coloque-o entre aspas (").
Connect-ExchangeOnline comandos armazenam uma cópia temporária do módulo Exchange Online localmente no cliente para conectividade de sessão. Por padrão, a cópia temporária do módulo é armazenada na pasta %TMP% (por padrão, C:\Users\<UserName>\AppData\Local\Temp).
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-FormatTypeName
Aplicável: Exchange Online
O parâmetro FormatTypeName especifica o formato de saída do cmdlet.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 7 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InlineCredential
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 2.0.4-Preview6 ou posterior do módulo e somente no PowerShell 7.
O comutador InlineCredential especifica se as credenciais devem ser passadas diretamente na janela do Windows PowerShell. Não é preciso especificar um valor com essa opção.
Essa opção é semelhante ao parâmetro Credential, mas com segurança adicional. A opção InlineCredential não exige que você armazene as credenciais localmente no script e você pode inserir credenciais diretamente em uma sessão interativa do PowerShell.
Esta opção não funciona com contas que usam MFA.
Propriedades do parâmetro
| Tipo: | 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 |
-LoadCmdletHelp
Aplicável: Exchange Online
Observação: esse parâmetro está disponível na versão do módulo 3.7.0-Preview1 ou posterior.
O switch LoadCmdletHelp baixa os arquivos de ajuda do cmdlet para o cmdlet Get-Help em conexões da API REST. Não é preciso especificar um valor com essa opção.
A partir da v3.7.0-Preview1, os arquivos de ajuda para a linha de comando não são baixados por padrão. Use esta opção para baixar os arquivos para ajuda de cmdlet na linha de comando.
Dica: esse parâmetro substitui o parâmetro SkipLoadingCmdletHelp. O parâmetro SkipLoadingCmdletHelp não é mais necessário e não funciona mais, pois os arquivos de ajuda de cmdlet não são mais baixados por padrão.
Propriedades do parâmetro
| Tipo: | 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 |
-LogDirectoryPath
Aplicável: Exchange Online
O parâmetro LogDirectoryPath especifica o local dos arquivos de log. O local padrão é %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv.
Se você especificar um local personalizado e um nome de arquivo que contenha espaços, coloque o valor entre aspas (").
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-LogLevel
Aplicável: Exchange Online
O parâmetro LogLevel especifica o nível de log. Os valores válidos são Padrão e Todos.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-ManagedIdentity
Aplicável: Exchange Online
A opção ManagedIdentity especifica que você está usando a identidade gerenciada para se conectar. Não é preciso especificar um valor com essa opção.
No momento, há suporte para conexões de identidade gerenciada para os seguintes tipos de recursos do Azure:
- Automação do Azure runbooks
- Máquinas Virtuais do Azure
- Azure Conjuntos de Dimensionamento de Máquinas Virtuais
- Azure Functions
Você deve usar essa opção com o parâmetro Organization.
Para identidade gerenciada atribuída ao usuário, você também deve usar essa opção com o parâmetro ManagedIdentityAccountId.
Para obter mais informações sobre como se conectar com a identidade gerenciada, confira Usar identidades gerenciadas do Azure para se conectar ao Windows PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | 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 |
-ManagedIdentityAccountId
Aplicável: Exchange Online
O parâmetro ManagedIdentityAccountId especifica a identidade gerenciada atribuída pelo usuário que você está usando para se conectar. Um valor válido para esse parâmetro é a ID do aplicativo (GUID) da entidade de serviço que corresponde à identidade gerenciada atribuída pelo usuário no Azure.
Você deve usar esse parâmetro com o parâmetro Organization e a opção ManagedIdentity.
Para obter mais informações sobre como se conectar com a identidade gerenciada, confira Usar identidades gerenciadas do Azure para se conectar ao Windows PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-Organization
Aplicável: Exchange Online
O parâmetro Organization especifica a organização quando você se conecta usando CBA ou identidade gerenciada. Um valor válido para esse parâmetro é o domínio .onmicrosoft.com primário da organização.
Para obter mais informações sobre como se conectar ao CBA, consulte Autenticação somente do aplicativo para scripts autônomos no módulo do PowerShell do Exchange Online.
Para obter mais informações sobre como se conectar com a identidade gerenciada, confira Usar identidades gerenciadas do Azure para se conectar ao Windows PowerShell do Exchange Online.
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-PageSize
Aplicável: Exchange Online
O parâmetro PageSize especifica o número máximo de entradas por página. A entrada válida para este parâmetro é um número inteiro entre 1 e 1000. O valor padrão é 1000.
Propriedades do parâmetro
| Tipo: | UInt32 |
| 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 |
-Prefix
Aplicável: Exchange Online
O parâmetro Prefix especifica um valor de texto a ser adicionado aos nomes dos cmdlets do PowerShell do Exchange Online quando você se conecta. Por exemplo, Get-InboundConnector se torna Get-ContosoInboundConnector quando você usa o valor Contoso para esse parâmetro.
- O valor do Prefixo não pode conter espaços ou caracteres especiais, como sublinhados ou asteriscos.
- Não é possível usar o valor de prefixo EXO. Esse valor é reservado para os nove cmdlets exclusivos Get-EXO* integrados ao módulo.
- O parâmetro Prefix afeta apenas nomes de cmdlet do Exchange Online importados. Isso não afeta os nomes dos cmdlets internos do módulo (por exemplo, Disconnect-ExchangeOnline).
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 5 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-PSSessionOption
Aplicável: Exchange Online
Observação: esse parâmetro não funciona em conexões da API REST.
O parâmetro PSSessionOption especifica as opções de sessão do PowerShell a serem usadas em sua conexão com o Exchange Online. Esse parâmetro só funcionará se você também usar a opção UseRPSSession no mesmo comando.
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 esse parâmetro (por exemplo, $PSOptions).
Propriedades do parâmetro
| Tipo: | PSSessionOption |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 3 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ShowBanner
Aplicável: Exchange Online
O comutador ShowBanner mostra ou oculta a mensagem de faixa exibida quando você executa o Connect-ExchangeOnline. Não é preciso especificar um valor com essa opção.
- Para mostrar a faixa, você não precisa usar essa opção (a faixa é exibida por padrão).
- Para ocultar a faixa, use exatamente esta sintaxe:
-ShowBanner:$false.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | $true |
| 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 |
-ShowProgress
Aplicável: Exchange Online
O parâmetro ShowProgress especifica se a barra de progresso dos cmdlets importados deve ser mostrada ou oculta quando você se conecta. Os valores válidos são:
- $true: A barra de progresso é exibida. Esse valor é o padrão.
- $false: atualmente, esse valor não tem efeito.
Propriedades do parâmetro
| Tipo: | Boolean |
| 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 |
-SigningCertificate
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 3.2.0-Preview4 ou posterior do módulo.
O parâmetro SigningCertificate especifica o certificado do cliente usado para assinar os arquivos de formato (*. Format.ps1xml) ou arquivos de módulo de script (.psm1) no módulo temporário que Connect-ExchangeOnline cria.
Um valor válido para esse parâmetro é uma variável que contém o certificado ou um comando ou expressão que obtém o certificado.
Para localizar o certificado, use o cmdlet Get-PfxCertificate no módulo Microsoft.PowerShell.Security ou use o cmdlet Get-ChildItem na unidade de certificado (Cert:). Se o certificado não for válido ou não tiver autoridade suficiente, o comando falhará.
Propriedades do parâmetro
| Tipo: | X509Certificate2 |
| 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 |
-SkipLoadingCmdletHelp
Aplicável: Exchange Online
Observação: este parâmetro está disponível na versão 3.3.0-Preview1 ou posterior do módulo.
Na versão 3.7.0-Preview1 ou posterior, esse parâmetro é substituído pelo parâmetro LoadCmdletHelp. O parâmetro SkipLoadingCmdletHelp não é mais necessário e não faz mais nada, porque os arquivos de ajuda de cmdlet não são mais baixados por padrão.
O comutador SkipLoadingCmdletHelp impede o download dos arquivos de ajuda de cmdlet para o cmdlet Get-Help em conexões da API REST. Não é preciso especificar um valor com essa opção.
Ao usar essa opção, você não obtém arquivos de ajuda local para nenhum cmdlet na linha de comando.
Essa opção não funciona com a opção UseRPSSession.
Propriedades do parâmetro
| Tipo: | 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 |
-SkipLoadingFormatData
Aplicável: Exchange Online
O comutador SkipLoadingFormatData impede o download dos dados de formato para conexões da API REST. Não é preciso especificar um valor com essa opção.
Quando você usa essa opção, a saída de qualquer cmdlet do Exchange não está formatada.
Use esta opção para evitar erros ao conectar-se ao PowerShell do Exchange Online por meio de um serviço do Windows ou do SDK do Windows PowerShell.
Essa opção não funciona com a opção UseRPSSession.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| 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 |
-TrackPerformance
Aplicável: Exchange Online
O parâmetro TrackPerformance mede eventos adicionais (por exemplo, carga da CPU e memória consumida). Os valores válidos são:
- $true: o acompanhamento de desempenho está habilitado.
- $false: o acompanhamento de desempenho está desabilitado. Esse valor é o padrão.
Esse parâmetro funciona somente quando o registro em log está habilitado.
Propriedades do parâmetro
| Tipo: | Boolean |
| 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 |
-UseMultithreading
Aplicável: Exchange Online
O parâmetro UseMultithreading especifica se o multithreading deve ser desabilitado ou habilitado no módulo do PowerShell do Exchange Online. Os valores válidos são:
- $true: Habilitar multi-threading. Esse valor é o padrão.
- $false: Desabilite o multi-threading. Esse valor degrada o desempenho dos nove cmdlets exclusivos Get-EXO* no módulo.
Propriedades do parâmetro
| Tipo: | Boolean |
| 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 |
-UserPrincipalName
Aplicável: Exchange Online
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 ignorar 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).
Propriedades do parâmetro
| Tipo: | String |
| 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 |
-UseRPSSession
Aplicável: Exchange Online
Observação: Este parâmetro está obsoleto na versão 3.9.2 ou posterior do módulo. As conexões da API REST substituíram as conexões remotas do PowerShell no PowerShell do Exchange Online em outubro de 2023. Para obter mais informações, consulte Substituição do PowerShell Remoto no Exchange Online.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| 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 |
CommonParameters
Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.