New-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 ambiente ou de outro.
Use o cmdlet New-OfflineAddressBook para criar catálogos de endereços offline (OABs).
No 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 da 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.
Sintaxe
Default (Default)
New-OfflineAddressBook
[-Name] <String>
-AddressLists <AddressBookBaseIdParameter[]>
[-Confirm]
[-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>]
[-GeneratingMailbox <MailboxIdParameter>]
[-GlobalWebDistributionEnabled <Boolean>]
[-IsDefault <Boolean>]
[-PublicFolderDatabase <DatabaseIdParameter>]
[-PublicFolderDistributionEnabled <Boolean>]
[-Schedule <Schedule>]
[-Server <ServerIdParameter>]
[-ShadowMailboxDistributionEnabled <Boolean>]
[-SkipPublicFolderInitialization]
[-Versions <MultiValuedProperty>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
Description
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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
$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"}
New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00"
No Exchange Server 2010 e 2013, este exemplo usa dois comandos para criar o OAB chamado OAB_AgencyB que inclui todas as listas de endereços nas quais a AgênciaB faz parte do nome. Usando as configurações mostradas, um OAB é gerado por myserver.contoso.com às segundas e quartas-feiras, das 01:00 às 2:00. Esse comando de exemplo também cria o OAB padrão para a organização.
Exemplo 2
New-OfflineAddressBook -Name "Contoso Executives OAB" -AddressLists "Default Global Address List","Contoso Executives Address List" -GlobalWebDistributionEnabled $true
Este exemplo cria um novo OAB chamado OAB Contoso Executives com as seguintes propriedades:
- Listas de endereços incluídas no OAB: Lista de Endereços Global Padrão e Lista de Endereços de Executivos da Contoso
- Todos os diretórios virtuais do OAB na organização podem aceitar solicitações para baixar o OAB.
A caixa de correio da organização responsável por gerar o OAB é SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} (não usamos o parâmetro GeneratingMailbox para especificar uma caixa de correio de organização diferente).
O OAB não é usado por caixas de correio e bancos de dados de caixa de correio que não têm um OAB especificado (não usamos o parâmetro IsDefault com o valor $true).
Exemplo 3
New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -VirtualDirectories "SERVER01\OAB (Default Web Site)"
No Exchange Server 2010, este exemplo cria o novo OAB do OAB que usa a distribuição baseada na Web para clientes do Microsoft Office Outlook 2007 ou posteriores no SERVER01 usando o diretório virtual padrão.
Exemplo 4
New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2
No Exchange Server 2010, este exemplo cria o OAB herdado do OAB que usa a distribuição de pasta pública para clientes do Outlook 2003 Service Pack 1 (SP1) e Outlook 98 Service Pack 2 (SP2) em SERVER01.
Se você configurar OABs para usar a distribuição de pasta pública, mas sua organização não tiver nenhuma infraestrutura de pasta pública, um erro será retornado. Para obter mais informações, consulte Gerenciamento de Pastas Públicas.
Parâmetros
-AddressLists
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Propriedades do parâmetro
| Tipo: | AddressBookBaseIdParameter[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.
- Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false. - A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
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 |
-DiffRetentionPeriod
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Propriedades do parâmetro
| Tipo: | Unlimited |
| 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 |
-DomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Propriedades do parâmetro
| Tipo: | Fqdn |
| 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 |
-GeneratingMailbox
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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)
- Domínio\Nome de usuário
- 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 única caixa de correio da organização 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 única caixa de correio da organização (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.
Propriedades do parâmetro
| Tipo: | MailboxIdParameter |
| 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 |
-GlobalWebDistributionEnabled
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 do OAB na organização pode aceitar solicitações para baixar o OAB. Não é possível usar essa configuração com o parâmetro VirtualDirectories.
- $false: somente os diretórios virtuais do OAB especificados pelo parâmetro VirtualDirectories aceitam solicitações para baixar o OAB. Esse valor é o 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.
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 |
-IsDefault
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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. Esse valor é o padrão.
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 |
-Name
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
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: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-PublicFolderDatabase
Aplicável: Exchange Server 2010
O parâmetro PublicFolderDatabase especifica o banco de dados de pasta pública usado para distribuir o OAB. É possível usar qualquer valor que identifique o banco de dados com exclusividade. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
Para usar esse parâmetro, o parâmetro PublicFolderDistributionEnabled deve ser definido como $true.
Propriedades do parâmetro
| Tipo: | DatabaseIdParameter |
| 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 |
-PublicFolderDistributionEnabled
Aplicável: Exchange Server 2010
O parâmetro PublicFolderDistributionEnabled especifica se o OAB é distribuído por meio de pastas públicas. Se o valor do parâmetro PublicFolderDistributionEnabled for $true, o OAB será distribuído por meio de pastas públicas.
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 |
-Schedule
Aplicável: Exchange Server 2010
O parâmetro Schedule especifica o intervalo para gerar o OAB no Exchange 2010 ou anterior.
A sintaxe para esse parâmetro é: StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM].
Você pode usar os seguintes valores para dias:
- Nome completo do dia.
- Nome abreviado do dia.
- Inteiro de 0 a 6, em que 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 12 horas, inclua um espaço entre a hora e o valor AM/PM.
Você pode misturar e combinar 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 baixo 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" (Executado de sábado às 22:00 até sábado às 22:15.)
- "Dom.1:15 AM-Monday.23:00"
Propriedades do parâmetro
| Tipo: | Schedule |
| 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 |
-Server
Aplicável: Exchange Server 2010
O parâmetro Servidor especifica o servidor Exchange em que você deseja executar esse comando. É possível usar qualquer valor que identifique o servidor com exclusividade. Por exemplo:
- Nome
- FQDN
- DN (nome diferenciado)
- ExchangeLegacyDN
DN Herdado do Exchange
Propriedades do parâmetro
| Tipo: | ServerIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-ShadowMailboxDistributionEnabled
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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: O OAB é distribuído 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 valor é o padrão.
O valor desse parâmetro só será significativo se você tiver várias caixas de correio da organização e só será benéfico em organizações do Exchange que tenham vários sites do Active Directory.
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 |
-SkipPublicFolderInitialization
Aplicável: Exchange Server 2010
A opção SkipPublicFolderInitialization especifica se a criação imediata das pastas públicas do OAB deve ser ignorada se você estiver criando um OAB que usa a distribuição de pastas públicas. Não é preciso especificar um valor com essa opção.
O OAB não estará disponível para download até que o próximo ciclo de manutenção de pasta do site seja concluído. A omissão dessa opção pode fazer com que a tarefa seja pausada enquanto entra em contato com o servidor de pasta pública responsável para criar as pastas públicas necessárias. Se o servidor estiver inacessível no momento ou se for caro contatar de outra forma, a pausa poderá ser significativa.
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 |
-Versions
Aplicável: Exchange Server 2010
O parâmetro Versions especifica as versões do OAB geradas para download do cliente. Os valores válidos são:
- Versão 2 (requer distribuição de pasta pública)
- Versão 3 (requer distribuição de pasta pública)
- Versão 4 (valor padrão)
Propriedades do parâmetro
| Tipo: | MultiValuedProperty |
| 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 |
-VirtualDirectories
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
O parâmetro VirtualDirectories especifica os diretórios virtuais do OAB que aceitam solicitações para baixar o 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 Nome 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 são os diretórios virtuais OAB de serviços de Acesso para Cliente (front-end) e OAB de back-end no servidor de Caixa de Correio que contém a caixa de correio de geração do OAB (o parâmetro GeneratingMailbox ou SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}). Por exemplo, Mailbox01\OAB (Site Padrão),Mailbox01\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 o parâmetro GlobalWebDistributionEnabled como $true, pois os serviços de Acesso para Cliente em qualquer servidor de Caixa de Correio podem fazer proxy de solicitações de download de OAB de entrada para o local correto.
Propriedades do parâmetro
| Tipo: | VirtualDirectoryIdParameter[] |
| 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 |
-WhatIf
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. 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 |
| Aliases: | wi |
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.
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.