Set-OfflineAddressBook
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.
Use o cmdlet Set-OfflineAddressBook para modificar as configurações do catálogo de endereços offline (OAB).
Em Exchange Online, esse cmdlet está disponível apenas na função Listas de Endereços e, por padrão, a função não é atribuída a nenhum grupo de funções. Para usar esse cmdlet, você precisa adicionar a função Listas de Endereços a um grupo de funções (por exemplo, ao grupo de funções gerenciamento de organização). Para obter mais informações, consulte Adicionar uma função a um grupo de funções.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Set-OfflineAddressBook
[-Identity] <OfflineAddressBookIdParameter>
[-AddressLists <AddressBookBaseIdParameter[]>]
[-ApplyMandatoryProperties]
[-ConfiguredAttributes <MultiValuedProperty>]
[-Confirm]
[-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>]
[-FullOabDownloadPreventionThreshold <Int32>]
[-GeneratingMailbox <MailboxIdParameter>]
[-GlobalWebDistributionEnabled <Boolean>]
[-IsDefault <Boolean>]
[-MaxBinaryPropertySize <Int32>]
[-MaxMultivaluedBinaryPropertySize <Int32>]
[-MaxMultivaluedStringPropertySize <Int32>]
[-MaxStringPropertySize <Int32>]
[-Name <String>]
[-PublicFolderDistributionEnabled <Boolean>]
[-Schedule <Schedule>]
[-ShadowMailboxDistributionEnabled <Boolean>]
[-UpgradeFromE14]
[-UseDefaultAttributes]
[-Versions <MultiValuedProperty>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
[-WhatIf]
[-ZipOabFilesBeforeUploading <Boolean>]
[<CommonParameters>]
Description
Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.
Exemplos
Exemplo 1
Set-OfflineAddressBook -Identity "Default Offline Address Book" -VirtualDirectories $null -GlobalWebDistributionEnabled $true
Este exemplo configura o OAB chamado Catálogo de Endereços Offline Padrão a fim de disponibilizá-lo para solicitações de download, em todos os Diretórios Virtuais do OAB da organização.
Exemplo 2
Set-OfflineAddressBook -Identity "\Default Offline Address Book" -GeneratingMailbox OABGen2
Este exemplo altera a Caixa de Correio de Organização responsável por gerar o OAB.
Parâmetros
-AddressLists
O parâmetro AddressLists especifica as listas de endereços ou listas de endereços global incluídas no OAB. É possível usar qualquer valor que identifique a lista de endereços com exclusividade. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
para localizar os valores de identificação das listas de endereços ou listas de endereços globais, use os cmdlets Get-AddressList e Get-GlobalAddressList.
Type: | AddressBookBaseIdParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ApplyMandatoryProperties
A opção ApplyMandatoryProperties especifica quando atualizar as propriedades obrigatórias de um OAB herdado. Não é preciso especificar um valor com essa opção.
Essa opção foi usada em ambientes de coexistência quando uma OAB foi migrada do Exchange 2003.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ConfiguredAttributes
O parâmetro ConfiguredAttributes especifica as propriedades MAPI do destinatário disponíveis no OAB. Esse parâmetro usa a sintaxe: "Name1,Type1","Name2,Type2",..."NameN,TypeN"
em que Nome é o nome da propriedade MAPI (por exemplo, MobileTelephoneNumber) e Type é o valor ANR (resolução de nome ambíguo), Valor ou Indicador.
Para redefinir esse parâmetro para os valores padrão, use a opção UseDefaultAttributes.
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Confirm
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.
- Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false
. - A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DiffRetentionPeriod
O parâmetro DiffRetentionPeriod especifica o número de dias em que os arquivos de diferença do OAB são armazenados no servidor. Os valores válidos são números inteiros de 7 a 1825 ou o valor unlimited. O valor padrão é 30.
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
Este parâmetro está disponível somente no Exchange local.
O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-FullOabDownloadPreventionThreshold
Esse parâmetro está reservado para uso interno da Microsoft.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-GeneratingMailbox
Este parâmetro está disponível somente no Exchange local.
O parâmetro GeneratingMailbox especifica a caixa de correio de arbitragem em que o OAB será gerado. Especificamente, a caixa de correio de arbitragem deve conter o valor OrganizationCapabilityOABGen para a propriedade PersistedCapability. A caixa de correio de arbitragem com esse recurso é conhecida também como Caixa de Correio de Organização. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Nome diferenciado (DN)
- Domain\username
- Endereço de email
- GUID
- LegacyExchangeDN
- SamAccountName
- ID de usuário ou nome UPN
O valor padrão desse parâmetro representa a Caixa de Correio de Organização nomeada SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}.
Uma caixa de correio de organização única pode gerar vários OABs (você pode usar o mesmo valor para esse parâmetro nas configurações de vários OABs), mas no Exchange 2013 CU5 ou posterior, um OAB só pode ser gerado por uma caixa de correio de organização única (esse parâmetro não aceita vários valores). Para disponibilizar uma cópia somente leitura do OAB (também conhecida como cópia de sombra) em outras Caixas de Correio de Organização, use o parâmetro ShadowMailboxDistributionEnabled.
Type: | MailboxIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-GlobalWebDistributionEnabled
Este parâmetro está disponível somente no Exchange local.
O parâmetro GlobalWebDistributionEnabled especifica se todos os Diretórios Virtuais do OAB da organização podem aceitar solicitações para baixar o OAB. Esses locais são divulgados pelo serviço Descoberta Automática. Os valores válidos são:
- $true: qualquer diretório virtual da OAB na organização pode aceitar solicitações para baixar a OAB. Não é possível usar essa configuração com o parâmetro VirtualDirectories.
- $false: somente os diretórios virtuais da OAB especificados pelo parâmetro VirtualDirectories aceitam solicitações para baixar a OAB. Esse é o valor padrão.
No Exchange 2013 CU7 ou posterior, recomendamos que você use o valor $true para esse parâmetro. Os serviços de Acesso para Cliente em servidores Caixa de Correio podem aplicar proxy às solicitações de download de entrada do OAB para o local correto.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
O parâmetro Identity especifica o OAB que você deseja modificar. É possível usar qualquer valor que identifique o OAB com exclusividade. Por exemplo:
- Nome ou \Nome
- DN (nome diferenciado)
- GUID
Type: | OfflineAddressBookIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IsDefault
O parâmetro IsDefault especifica se o OAB deve ser usado por todas as caixas de correio e bancos de dados de caixas de correio que não tenham um OAB especificado. Os valores válidos são:
- $true: o OAB é o OAB padrão.
- $false: o OAB não é o OAB padrão.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MaxBinaryPropertySize
Este parâmetro está disponível somente no Exchange local.
O parâmetro MaxBinaryPropertySize especifica o tamanho máximo em bytes dos atributos binários do OAB, antes que sejam truncados. Os valores válidos são números inteiros de 0 a 999999999. O valor padrão é 65536.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxMultivaluedBinaryPropertySize
Este parâmetro está disponível somente no Exchange local.
O parâmetro MaxMultivaluedBinaryPropertySize especifica o tamanho máximo em bytes dos atributos binários de múltiplos valores do OAB, antes que sejam truncados. Os valores válidos são números inteiros de 0 a 999999999. O valor padrão é 65536 (64 quilobytes).
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxMultivaluedStringPropertySize
Este parâmetro está disponível somente no Exchange local.
O parâmetro MaxMultivaluedStringPropertySize especifica o tamanho máximo dos atributos de cadeia de caracteres de múltiplos valores no OAB, antes que sejam truncados. Os valores válidos são números inteiros de 0 a 999999999. O valor padrão é 65536 (64 quilobytes).
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxStringPropertySize
Este parâmetro está disponível somente no Exchange local.
O parâmetro MaxStringPropertySize especifica o tamanho máximo em bytes dos atributos de cadeia de caracteres, antes que sejam truncados. Os valores válidos são números inteiros de 0 a 999999999. O valor padrão é 3400.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Name
O parâmetro Name especifica o nome exclusivo do OAB. O tamanho máximo é de 64 caracteres. Se o valor contiver espaços, coloque-o entre aspas.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PublicFolderDistributionEnabled
Esse parâmetro só está disponível no Exchange Server 2010.
O parâmetro PublicFolderDistributionEnabled especifica se o OAB deve ser distribuído por meio de pastas públicas. Definir o parâmetro PublicFolderDistributionEnabled como um valor de $true define o OAB a ser distribuído por meio de pastas públicas. O valor padrão é $true.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Schedule
Esse parâmetro é funcional apenas no Exchange 2010.
No Exchange 2013 ou posterior, esse parâmetro não é mais responsável pelo agendamento de geração da OAB. Para obter mais informações, consulte Alterar a agenda de geração de catálogo de endereços offline no Exchange.
O parâmetro Agendar especifica o intervalo para gerar a OAB no Exchange 2010 ou anterior.
A sintaxe deste parâmetro é: StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]
.
Você pode usar os seguintes valores por dias:
- Nome completo do dia.
- Nome abreviado do dia.
- Inteiro de 0 a 6, onde 0 = domingo.
Você pode inserir a hora no formato de 24 horas e omitir o valor AM/PM. Se você inserir a hora no formato de 12 horas, inclua um espaço entre a hora e o valor AM/PM.
Você pode misturar e corresponder formatos de data/hora.
Deve haver um intervalo de pelo menos 15 minutos entre a hora de início e a hora de término. Os minutos são arredondados para 0, 15, 30 ou 45.
Aqui estão alguns exemplos:
- "Dom.11:30 PM-Seg.1:30 AM"
- "6.22:00-6.22:15" (Executar de sábado às 22:00 até sábado às 22:15.)
- "Dom.1:15-Monday.23:00"
Observação: em Exchange Online, o valor somente leitura dessa propriedade é exibido em UTC (Tempo Universal Coordenado).
Type: | Schedule |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ShadowMailboxDistributionEnabled
Este parâmetro está disponível somente no Exchange local.
O parâmetro ShadowMailboxDistributionEnabled especifica se uma cópia somente leitura do OAB (também conhecida como cópia de sombra) deve ser distribuída a todas as outras caixas de correio de geração de OAB ou Caixas de Correio de Organização. Dessa forma, os servidores Caixa de Correio podem servir como pontos de extremidade para solicitações de download do OAB, o que pode ajudar a impedir que os usuários baixem o OAB em conexões WAN lentas. Os valores válidos são:
- $true: a OAB é distribuída para todas as outras caixas de correio da organização.
- $false: o OAB não é distribuído para outras caixas de correio da organização. Esse é o valor padrão.
O valor desse parâmetro só será significativo se você tiver várias caixas de correio da organização e só for benéfico em organizações do Exchange que tenham vários sites do Active Directory.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-UpgradeFromE14
Esse parâmetro está reservado para uso interno da Microsoft.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-UseDefaultAttributes
A opção UseDefaultAttributes especifica se as propriedades MAPI do destinatário disponíveis no OAB devem ser revertidas para a lista padrão. Não é preciso especificar um valor com essa opção.
Use esta opção para desfazer as alterações feitas à lista padrão por meio do parâmetro ConfiguredAttributes.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Versions
O parâmetro Versions especifica as versões do OAB geradas para download do cliente. Os valores válidos são:
- Versão2 (requer distribuição de pasta pública)
- Versão3 (requer distribuição de pasta pública)
- Versão4 (valor padrão no Exchange 2010 ou posterior; o único valor disponível no Exchange 2013 ou posterior)
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-VirtualDirectories
Este parâmetro está disponível somente no Exchange local.
O parâmetro VirtualDirectories especifica os diretórios virtuais da OAB que aceitam solicitações para baixar a OAB. Esses locais são divulgados no serviço Descoberta Automática.
É possível usar qualquer valor que identifique exclusivamente o diretório virtual. Por exemplo:
- Nome ou Servidor\Nome
- DN (nome diferenciado)
- GUID
O valor Name usa a sintaxe "VirtualDirectoryName (WebsiteName)"
das propriedades do diretório virtual. Você pode especificar o caractere curinga (*) em vez do site padrão usando a sintaxe VirtualDirectoryName*
.
O valor padrão desse parâmetro é os diretórios virtuais OAB (serviços de acesso ao cliente) e back-end no servidor caixa de correio que contém a caixa de correio de geração OAB (o parâmetro GeneratingMailbox ou SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) quando você criou o OAB (por exemplo, Caixa de correio01\OAB (Site Padrão), Caixa de Correio01\OAB (Back End do Exchange).
Para usar esse parâmetro, o valor do parâmetro GlobalWebDistributionEnabled deve ser $false.
No Exchange 2013 CU7 ou posterior, recomendamos que você defina esse parâmetro como $null e defina o parâmetro GlobalWebDistributionEnabled como $true, pois os serviços de Acesso ao Cliente em qualquer servidor da Caixa de Correio podem fazer proxy solicitações de download da OAB de entrada para o local correto.
Type: | VirtualDirectoryIdParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ZipOabFilesBeforeUploading
O ZipOabFilesBeforeUploading especifica se deve usar compactação de arquivo ZIP nos arquivos OAB antes de carregá-los no servidor. Os valores válidos são:
- $true: ZIP os arquivos OAB.
- $false: não zip os arquivos OAB. Esse é o valor padrão.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
Entradas
Input types
Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.
Saídas
Output types
Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.