Connect-ExchangeOnline
Este cmdlet só está disponível no módulo Exchange Online PowerShell. Para obter mais informações, veja Acerca do módulo Exchange Online PowerShell.
Utilize o cmdlet Connect-ExchangeOnline no módulo Exchange Online PowerShell para ligar ao Exchange Online PowerShell ou Proteção do Exchange Online autónomo do PowerShell através da autenticação moderna. Este cmdlet funciona para contas com ou sem autenticação multifator (MFA).
Para ligar ao PowerShell de Conformidade & de Segurança, utilize o cmdlet Connect-IPPSSession .
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
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]
[-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 ligação do PowerShell à sua organização Exchange Online.
Os comandos de ligação provavelmente falharão se o caminho do perfil da conta que utilizou para ligar contiver carateres especiais do PowerShell (por exemplo, $). A solução é ligar com uma conta diferente que não tenha carateres especiais no caminho do perfil.
Exemplos
Exemplo 1
Connect-ExchangeOnline -UserPrincipalName chris@contoso.comEste exemplo liga-se ao Exchange Online PowerShell através da autenticação moderna, com ou sem autenticação multifator (MFA). A ligação utiliza o modo de API REST e não requer que a autenticação Básica seja ativada no WinRM no computador local.
Exemplo 2
Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"Este exemplo liga-se ao Exchange Online PowerShell num cenário de scripting sem supervisão através de um thumbprint de certificado.
Exemplo 3
Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"Este exemplo liga-se ao Exchange Online PowerShell num cenário de scripting sem supervisão através de um ficheiro de certificado. Este método é mais adequado para cenários em que o certificado é armazenado em máquinas remotas e obtido no runtime. Por exemplo, o certificado é armazenado no Key Vault do Azure.
Exemplo 4
Connect-ExchangeOnline -DeviceNo PowerShell 7.0.3 ou posterior com a versão 2.0.4 ou posterior do módulo, este exemplo liga-se ao Exchange Online PowerShell em cenários de scripting interativos em computadores que não têm browsers.
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 início de sessão no browser, a sessão na janela do PowerShell 7 é autenticada através do fluxo de autenticação de Microsoft Entra normal e os cmdlets Exchange Online são importados após alguns segundos.
Exemplo 6
Connect-ExchangeOnline -InlineCredentialNo PowerShell 7.0.3 ou posterior com a versão 2.0.4 ou posterior do módulo, este exemplo liga-se ao Exchange Online PowerShell em cenários de scripting interativos ao transmitir credenciais diretamente na janela do PowerShell.
Parâmetros
-AccessToken
Nota: este parâmetro está disponível na versão 3.1.0 ou posterior do módulo.
O parâmetro AccessToken especifica o OAuth JSON Web Token (JWT) que é utilizado para ligar a Exchange Online.
Consoante o tipo de token de acesso, tem de utilizar este parâmetro com os parâmetros Organização, DelegatedOrganization ou UserPrincipalName.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-AppId
O parâmetro AppId especifica o ID da aplicação do principal de serviço utilizado na autenticação baseada em certificados (CBA). Um valor válido é o GUID do ID da aplicação (principal de serviço). Por exemplo, 36ee4c6c-0812-40a2-b820-b22ebd02bce3.
Para obter mais informações, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-AzureADAuthorizationEndpointUri
Nota: se utilizar o parâmetro ExchangeEnvironmentName, não precisa de utilizar os parâmetros AzureADAuthorizationEndpointUri ou ConnectionUri.
O parâmetro AzureADAuthorizationEndpointUri especifica o ponto final Microsoft Entra Autorização que pode emitir tokens de acesso OAuth2. São suportados os seguintes Exchange Online ambientes do PowerShell e valores relacionados:
- Microsoft 365 ou Microsoft 365 GCC: não utilize este parâmetro. O valor necessário é , mas esse também é
https://login.microsoftonline.com/commono valor predefinido, pelo que não precisa de utilizar este parâmetro. - Office 365 Alemanha:
https://login.microsoftonline.de/common - Microsoft 365 GCC High ou Microsoft 365 DoD:
https://login.microsoftonline.us/common
Se utilizar o parâmetro UserPrincipalName, não precisa de utilizar o parâmetro AzureADAuthorizationEndpointUri para MFA ou utilizadores federados em ambientes que normalmente o exijam (UserPrincipalName ou AzureADAuthorizationEndpointUri é necessário; OK para utilizar ambos).
Nota: a autenticação MFA ou a autenticação federada não está disponível no Office 365 operado pela 21Vianet.
| Tipo: | String |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-BypassMailboxAnchoring
O comutador BypassMailboxAnchoring ignora a utilização da sugestão de ancoragem da caixa de correio. Não é preciso especificar um valor com essa opção.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-Certificate
O parâmetro Certificado especifica o certificado que é utilizado para autenticação baseada em certificado (CBA). Um valor válido é o valor de objeto X509Certificate2 do certificado.
Não utilize este parâmetro com os parâmetros CertificateFilePath ou CertificateThumbprint.
Para obter mais informações sobre a CBA, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
| Tipo: | X509Certificate2 |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-CertificateFilePath
O parâmetro CertificateFilePath especifica o certificado utilizado para CBA. Um valor válido é o caminho público completo para o ficheiro de certificado. Utilize o parâmetro CertificatePassword com este parâmetro.
Não utilize este parâmetro com os parâmetros Certificate ou CertificateThumbprint.
Para obter mais informações sobre a CBA, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-CertificatePassword
O parâmetro CertificatePassword especifica a palavra-passe necessária para abrir o ficheiro de certificado quando utiliza o parâmetro CertificateFilePath para identificar o certificado utilizado para a CBA.
Pode utilizar os seguintes métodos como um valor para este parâmetro:
-
(ConvertTo-SecureString -String '<password>' -AsPlainText -Force). - Antes de executar este comando, armazene a palavra-passe como uma variável (por exemplo, ) e, em seguida,
$password = Read-Host "Enter password" -AsSecureStringutilize a variável ($password) para o valor. -
(Get-Credential).passworda ser pedido para introduzir a palavra-passe de forma segura quando executar este comando.
Para obter mais informações sobre a CBA, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
Nota: utilizar um comando ConvertTo-SecureString para armazenar a palavra-passe do certificado localmente derrota a finalidade de um método de ligação seguro para cenários de automatização. Utilizar um comando Get-Credential para lhe pedir a palavra-passe do certificado de forma segura não é ideal para cenários de automatização. Por outras palavras, não existe realmente uma forma automatizada e segura de ligar através de um certificado local.
| Tipo: | SecureString |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-CertificateThumbprint
O parâmetro CertificateThumbprint especifica o certificado utilizado para a CBA. Um valor válido é o valor thumbprint do certificado. Por exemplo, 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.
Não utilize este parâmetro com os parâmetros Certificate ou CertificateFilePath.
Nota: o parâmetro CertificateThumbprint só é suportado no Microsoft Windows.
Para obter mais informações sobre a CBA, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-CommandName
O parâmetro CommandName especifica a lista separada por vírgulas de comandos a importar para a sessão. Utilize este parâmetro para aplicações ou scripts que utilizam um conjunto específico de cmdlets. Reduzir o número de cmdlets na sessão ajuda a melhorar o desempenho e reduz a quantidade de memória da aplicação ou script.
| Tipo: | String[] |
| Cargo: | 6 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ConnectionUri
Nota: se utilizar o parâmetro ExchangeEnvironmentName, não precisa de utilizar os parâmetros AzureADAuthorizationEndpointUri ou ConnectionUri.
O parâmetro ConnectionUri especifica o ponto final de ligação para a sessão do PowerShell. São suportados os seguintes Exchange Online ambientes do PowerShell e valores relacionados:
- Microsoft 365 ou Microsoft 365 GCC: não utilize este parâmetro. O valor necessário é , mas esse também é
https://outlook.office365.com/powershell-liveid/o valor predefinido, pelo que não precisa de utilizar este 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
| Tipo: | String |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-Credential
O parâmetro Credential especifica o nome de utilizador e a palavra-passe utilizados para ligar 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 utilize este parâmetro para contas que utilizam a autenticação multifator (MFA).
Antes de executar o comando Connect-ExchangeOnline, armazene o nome de utilizador e a palavra-passe numa variável (por exemplo, $UserCredential = Get-Credential). Em seguida, utilize o nome da variável ($UserCredential) para este parâmetro.
Após a conclusão do comando Connect-ExchangeOnline, a chave de palavra-passe na variável é esvaziada.
Para especificar a palavra-passe de um ficheiro de certificado, não utilize este parâmetro; em alternativa, utilize o parâmetro CertificatePassword.
| Tipo: | PSCredential |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-DelegatedOrganization
O parâmetro DelegatedOrganization especifica a organização do cliente que pretende gerir. Um valor válido para este parâmetro é o domínio .onmicrosoft.com primário ou o ID de inquilino da organização do cliente.
Este parâmetro só funciona se a organização do cliente tiver concordado com a gestão delegada através do programa CSP.
Após a autenticação 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 efetuadas na organização do cliente.
| Tipo: | String |
| Cargo: | 4 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-Device
Nota: este parâmetro está disponível na versão 2.0.4 ou posterior do módulo e apenas no PowerShell 7.
O Comutador de dispositivo é normalmente utilizado em computadores sem browsers. Não é preciso especificar um valor com essa opção.
A utilização deste comutador resulta numa mensagem no ecrã que contém o URL https://microsoft.com/devicelogin e um código exclusivo. Em qualquer outro dispositivo com um browser e acesso à Internet, abra o URL, introduza o código exclusivo e introduza as suas credenciais nas páginas subsequentes.
Se o início de sessão tiver sido bem-sucedido, a ligação do PowerShell continuará.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-DisableWAM
Nota: este parâmetro está disponível na versão 3.7.2-Preview1 ou posterior do módulo.
O comutador DisableWAM desativa o Gestor de Conta Web (WAM). Não é preciso especificar um valor com essa opção.
A partir da versão 3.7.0, o WAM está ativado por predefinição ao ligar a Exchange Online. Se encontrar problemas relacionados com wAM durante o início de sessão, pode utilizar este comutador para desativar o WAM.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-EnableErrorReporting
O comutador EnableErrorReporting especifica se pretende ativar o relatório de erros. Não é preciso especificar um valor com essa opção.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ExchangeEnvironmentName
O ExchangeEnvironmentName especifica o ambiente Exchange Online e elimina a necessidade de utilizar os parâmetros AzureADAuthorizationEndpointUri e ConnectionUri. São suportados os seguintes Exchange Online ambientes do PowerShell:
- Microsoft 365 ou Microsoft 365 GCC: não utilize este parâmetro. O valor necessário é , mas esse também é
O365Defaulto valor predefinido, pelo que não precisa de utilizar este parâmetro. - Office 365 Alemanha:
O365GermanyCloud - Office 365 operado pela 21Vianet:
O365China - Microsoft 365 GCC High:
O365USGovGCCHigh - Microsoft 365 DoD:
O365USGovDoD
| Tipo: | ExchangeEnvironment |
| Cargo: | 2 |
| Valor padrão: | O365Default |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-FormatTypeName
O parâmetro FormatTypeName especifica o formato de saída do cmdlet.
| Tipo: | String[] |
| Cargo: | 7 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-InlineCredential
Nota: este parâmetro está disponível na versão 2.0.4 ou posterior do módulo e apenas no PowerShell 7.
O comutador InlineCredential especifica se deve transmitir credenciais diretamente na janela Windows PowerShell. Não é preciso especificar um valor com essa opção.
Este comutador é semelhante ao parâmetro Credential, mas com segurança adicional. O comutador InlineCredential não requer que armazene as credenciais localmente no script e pode introduzir credenciais diretamente numa sessão interativa do PowerShell.
Este comutador não funciona com contas que utilizam a MFA.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-LoadCmdletHelp
Nota: este parâmetro está disponível na versão 3.7.0-Preview1 ou posterior do módulo.
O comutador LoadCmdletHelp transfere ficheiros de ajuda do cmdlet para o cmdlet Get-Help em ligações à API REST. Não é preciso especificar um valor com essa opção.
A partir da v3.7.0-Preview1, os ficheiros de ajuda da linha de comandos não são transferidos por predefinição. Utilize este comutador para transferir os ficheiros para obter ajuda sobre cmdlets na linha de comandos.
Sugestão: este parâmetro substitui o parâmetro SkipLoadingCmdletHelp. O parâmetro SkipLoadingCmdletHelp já não é necessário e já não funciona, porque os ficheiros de ajuda do cmdlet já não são transferidos por predefinição.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-LogDirectoryPath
O parâmetro LogDirectoryPath especifica a localização dos ficheiros de registo. A localização predefinida é %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv.
Se especificar uma localização personalizada e um nome de ficheiro que contenham espaços, coloque o valor entre aspas (").
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-LogLevel
O parâmetro LogLevel especifica o nível de registo. Os valores válidos são Predefinido e Todos.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ManagedIdentity
O comutador ManagedIdentity especifica que está a utilizar a identidade gerida para ligar. Não é preciso especificar um valor com essa opção.
As ligações de identidade gerida são atualmente suportadas 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
Tem de utilizar este comutador com o parâmetro Organização.
Para a identidade gerida atribuída pelo utilizador, também tem de utilizar este comutador com o parâmetro ManagedIdentityAccountId.
Para obter mais informações sobre a ligação com a identidade gerida, veja Utilizar identidades geridas do Azure para ligar ao Exchange Online PowerShell.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ManagedIdentityAccountId
O parâmetro ManagedIdentityAccountId especifica a identidade gerida atribuída pelo utilizador que está a utilizar para se ligar. Um valor válido para este parâmetro é o ID da aplicação (GUID) do principal de serviço que corresponde à identidade gerida atribuída pelo utilizador no Azure.
Tem de utilizar este parâmetro com o parâmetro Organização e o comutador ManagedIdentity.
Para obter mais informações sobre a ligação com a identidade gerida, veja Utilizar identidades geridas do Azure para ligar ao Exchange Online PowerShell.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-Organization
O parâmetro Organização especifica a organização quando se liga através da CBA ou da identidade gerida. Um valor válido para este parâmetro é o domínio .onmicrosoft.com primário ou o ID de inquilino da organização.
Para obter mais informações sobre como ligar à CBA, veja Autenticação apenas de aplicações para scripts autónomos no módulo Exchange Online PowerShell.
Para obter mais informações sobre a ligação com a identidade gerida, veja Utilizar identidades geridas do Azure para ligar ao Exchange Online PowerShell.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-PageSize
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.
| Tipo: | UInt32 |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-Prefix
O parâmetro Prefixo especifica um valor de texto a adicionar aos nomes de Exchange Online cmdlets do PowerShell quando se liga. Por exemplo, Get-InboundConnector torna-se Get-ContosoInboundConnector quando utiliza o valor Contoso para este parâmetro.
- O valor Prefixo não pode conter espaços ou carateres especiais, como carateres de sublinhado ou asteriscos.
- Não pode utilizar o valor de Prefixo EXO. Esse valor está reservado para os nove cmdlets exclusivos Get-EXO* incorporados no módulo.
- O parâmetro Prefix afeta apenas os nomes de cmdlets importados Exchange Online. Não afeta os nomes dos cmdlets incorporados no módulo (por exemplo, Disconnect-ExchangeOnline).
| Tipo: | String |
| Cargo: | 5 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-PSSessionOption
Nota: este parâmetro não funciona nas ligações da API REST.
O parâmetro PSSessionOption especifica as opções de sessão do PowerShell a utilizar na sua ligação ao Exchange Online. Este parâmetro só funciona se também utilizar o comutador UseRPSSession no mesmo comando.
Armazene o resultado do comando New-PSSessionOption numa variável (por exemplo, $PSOptions = New-PSSessionOption <Settings>), e utilize o nome da variável como o valor para este parâmetro (por exemplo, $PSOptions).
| Tipo: | PSSessionOption |
| Cargo: | 3 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ShowBanner
O comutador ShowBanner mostra ou oculta a mensagem de faixa que é apresentada quando executa o Connect-ExchangeOnline. Não é preciso especificar um valor com essa opção.
- Para mostrar a faixa, não precisa de utilizar este comutador (a faixa é apresentada por predefinição).
- Para ocultar a faixa, utilize esta sintaxe exata:
-ShowBanner:$false.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | $true |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-ShowProgress
O parâmetro ShowProgress especifica se pretende mostrar ou ocultar a barra de progresso dos cmdlets importados quando se liga. Os valores válidos são:
- $true: é apresentada a barra de progresso. Esse é o valor padrão.
- $false: Atualmente, este valor não tem efeito.
| Tipo: | Boolean |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-SigningCertificate
Nota: este parâmetro está disponível na versão 3.2.0 ou posterior do módulo.
O parâmetro SigningCertificate especifica o certificado de cliente utilizado para assinar os ficheiros de formato (*. Format.ps1xml) ou ficheiros de módulo de script (.psm1) no módulo temporário que Connect-ExchangeOnline cria.
Um valor válido para este 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, utilize o cmdlet Get-PfxCertificate no módulo Microsoft.PowerShell.Security ou utilize 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á.
| Tipo: | X509Certificate2 |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-SkipLoadingCmdletHelp
Nota: este parâmetro está disponível na versão 3.3.0 ou posterior do módulo.
Na versão 3.7.0-Preview1 ou posterior, este parâmetro é substituído pelo parâmetro LoadCmdletHelp. O parâmetro SkipLoadingCmdletHelp já não é necessário e já não faz nada, porque os ficheiros de ajuda do cmdlet já não são transferidos por predefinição. Eventualmente, este parâmetro será descontinuado, pelo que deve removê-lo de quaisquer scripts.
O comutador SkipLoadingCmdletHelp impede a transferência dos ficheiros de ajuda do cmdlet para o cmdlet Get-Help nas ligações da API REST. Não é preciso especificar um valor com essa opção.
Quando utiliza este comutador, não obtém ficheiros de ajuda locais para qualquer cmdlet na linha de comandos.
Este comutador não funciona com o comutador UseRPSSession.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-SkipLoadingFormatData
O comutador SkipLoadingFormatData impede a transferência dos dados de formato para ligações da API REST. Não é preciso especificar um valor com essa opção.
Quando utilizar este comutador, o resultado de qualquer cmdlet do Exchange não será formatado.
Utilize este comutador para evitar erros ao ligar ao Exchange Online PowerShell a partir de um serviço Windows ou do SDK Windows PowerShell.
Este comutador não funciona com o comutador UseRPSSession.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-TrackPerformance
O parâmetro TrackPerformance mede eventos adicionais (por exemplo, carga da CPU e memória consumida). Os valores válidos são:
- $true: o controlo de desempenho está ativado.
- $false: o controlo de desempenho está desativado. Esse é o valor padrão.
Este parâmetro só funciona quando o registo está ativado.
| Tipo: | Boolean |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-UseMultithreading
O parâmetro UseMultithreading especifica se pretende desativar ou ativar a multi-threading no módulo Exchange Online PowerShell. Os valores válidos são:
- $true: Ativar multi-threading. Esse é o valor padrão.
- $false: Desativar multi-threading. Este valor irá degradar o desempenho dos nove cmdlets exclusivos Get-EXO* no módulo.
| Tipo: | Boolean |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-UserPrincipalName
O parâmetro UserPrincipalName especifica a conta que pretende utilizar para ligar (por exemplo, navin@contoso.onmicrosoft.com). A utilização deste parâmetro permite-lhe ignorar a introdução de um nome de utilizador no pedido de credenciais de autenticação moderna (é-lhe pedido que introduza uma palavra-passe).
Se utilizar o parâmetro UserPrincipalName, não precisa de utilizar o parâmetro AzureADAuthorizationEndpointUri para MFA ou utilizadores federados em ambientes que normalmente o exijam (UserPrincipalName ou AzureADAuthorizationEndpointUri é necessário; OK para utilizar ambos).
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |
-UseRPSSession
Nota: as ligações remotas do PowerShell ao Exchange Online PowerShell foram preteridas. Para obter mais informações, veja Descontinuação do PowerShell Remoto no Exchange Online.
O comutador UseRPSSession permite-lhe ligar ao Exchange Online PowerShell através do acesso tradicional remoto do PowerShell a todos os cmdlets. Não é preciso especificar um valor com essa opção.
Este comutador requer que a autenticação Básica esteja ativada no WinRM no computador local. Para obter mais informações, veja Ativar a autenticação Básica no WinRM.
Se não utilizar este comutador, o modo de API REST é utilizado para a ligação, pelo que a autenticação Básica no WinRM não é necessária.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online |