New-App
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 New-App para instalar aplicativos para o Outlook.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
New-App
[-Etoken <String>]
[-Mailbox <MailboxIdParameter>]
[-MarketplaceCorrelationID <String>]
[-MarketplaceAssetID <String>]
[-MarketplaceQueryMarket <String>]
[-MarketplaceServicesUrl <String>]
[-MarketplaceUserProfileType <String>]
[-AllowReadWriteMailbox]
[-Confirm]
[-DefaultStateForUser <DefaultStateForUser>]
[-DomainController <Fqdn>]
[-DownloadOnly]
[-Enabled <Boolean>]
[-OrganizationApp]
[-PrivateCatalog]
[-ProvidedTo <ClientExtensionProvidedTo>]
[-UserList <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]New-App
[-FileData <Byte[]>]
[-AllowReadWriteMailbox]
[-Confirm]
[-DefaultStateForUser <DefaultStateForUser>]
[-DomainController <Fqdn>]
[-DownloadOnly]
[-Enabled <Boolean>]
[-Mailbox <MailboxIdParameter>]
[-OrganizationApp]
[-PrivateCatalog]
[-ProvidedTo <ClientExtensionProvidedTo>]
[-UserList <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]New-App
[-FileStream <Stream>]
[-AllowReadWriteMailbox]
[-Confirm]
[-DefaultStateForUser <DefaultStateForUser>]
[-DomainController <Fqdn>]
[-DownloadOnly]
[-Enabled <Boolean>]
[-Mailbox <MailboxIdParameter>]
[-OrganizationApp]
[-PrivateCatalog]
[-ProvidedTo <ClientExtensionProvidedTo>]
[-UserList <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]New-App
[-Url <Uri>]
[-AllowReadWriteMailbox]
[-Confirm]
[-DefaultStateForUser <DefaultStateForUser>]
[-DomainController <Fqdn>]
[-DownloadOnly]
[-Enabled <Boolean>]
[-Mailbox <MailboxIdParameter>]
[-OrganizationApp]
[-PrivateCatalog]
[-ProvidedTo <ClientExtensionProvidedTo>]
[-UserList <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]Description
Se o aplicativo estiver habilitado para toda a organização, os usuários poderão ativar o novo aplicativo ao exibir itens de email ou calendário em Microsoft Outlook ou Outlook na Web. Se um aplicativo instalado não estiver habilitado, os usuários poderão habilitar o aplicativo Outlook na Web Options. Da mesma forma, os administradores podem habilitar aplicativos instalados do centro de administração do Exchange ou usando o cmdlet Enable-App ou Set-App.
Para obter mais informações, consulte Gerenciar o acesso do usuário a suplementos para o Outlook em Exchange Server e Gerenciar a implantação de suplementos no Centro de administração do Microsoft 365.
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
New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml'))Este exemplo instala o arquivo de manifesto do aplicativo Finance Test que foi copiado para o disco rígido local.
Exemplo 2
New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser EnabledEste exemplo instala o arquivo manifest.xml do aplicativo Contoso CRM de uma URL na rede corporativa Contoso. O servidor exchange deve ser capaz de alcançar a URL de destino. Este aplicativo é instalado como um aplicativo da organização, é disponibilizado para uma lista específica de usuários e é habilitado por padrão para esses usuários.
Parâmetros
-AllowReadWriteMailbox
A opção AllowReadWriteMailbox especifica se o aplicativo permite a permissão de caixa de correio de leitura/gravação. Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange 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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-DefaultStateForUser
O parâmetro DefaultStateForUser especifica o estado padrão inicial de um aplicativo da organização. Os valores válidos são:
- Habilitado: o aplicativo da organização está habilitado por padrão.
- Desabilitado: o aplicativo da organização está desabilitado por padrão. Esse é o valor padrão.
- AlwaysEnabled: o aplicativo da organização está habilitado e os usuários não podem desabilitá-lo.
Você precisa usar a opção OrganizationApp quando usar esse parâmetro.
| Type: | DefaultStateForUser |
| 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, 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 2013, Exchange Server 2016, Exchange Server 2019 |
-DownloadOnly
A opção DownloadOnly especifica se é para obter o arquivo de manifesto do aplicativo e pedir confirmação para o usuário, antes de confirmar uma instalação real. Não é preciso especificar um valor com essa opção.
Quando você usa essa opção, o cmdlet só baixa o arquivo de manifesto do aplicativo e exibe as propriedades do aplicativo sem instalar o aplicativo.
| Type: | SwitchParameter |
| 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, Exchange Online, Exchange Online Protection |
-Enabled
O parâmetro Enabled especifica se o aplicativo é disponibilizado para os usuários da organização. Os valores válidos são:
- $true: o aplicativo está disponível para os usuários especificados. Esse é o valor padrão.
- $false: o aplicativo está oculto de todos os usuários da organização.
Essa configuração substitui as configurações ProvidedTo, UserList e DefaultStateForUser. Esta configuração não impede que os usuários instalem sua própria instância do aplicativo se tiverem permissões para instalar.
| 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, Exchange Online |
-Etoken
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | String |
| 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, Exchange Online, Exchange Online Protection |
-FileData
O parâmetro FileData especifica a localização do arquivo de manifesto do aplicativo. Você deve especificar apenas um local de origem para o arquivo de manifesto do aplicativo. Você pode especificar o manifesto do aplicativo usando os parâmetros MarketplaceServicesUrl, Url ou FileData.
Um valor válido para esse parâmetro exige que você leia o arquivo em um objeto codificado por bytes usando a seguinte sintaxe: ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')). Você pode usar esse comando como o valor do parâmetro ou gravar a saída em uma variável ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')) e usar a variável como o valor do parâmetro ($data).
| Type: | Byte[] |
| 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, Exchange Online |
-FileStream
O parâmetro FileStream é usado apenas pelo centro de administração do Exchange para dar suporte ao carregador de arquivo de aplicativo. Não use esse parâmetro para especificar o arquivo de manifesto do aplicativo. Você pode especificar o arquivo de manifesto do aplicativo usando o parâmetro MarketplaceServicesUrl, Url ou FileData.
| Type: | Stream |
| 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, Exchange Online |
-Mailbox
O parâmetro Caixa de correio especifica a caixa de correio em que você deseja instalar o aplicativo. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo: 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
| 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, Exchange Online |
-MarketplaceAssetID
O parâmetro MarketplaceAssetID especifica o identificador da Office Store para o aplicativo. É necessário usar esse parâmetro se você usar o parâmetro MarketplaceServicesUrl.
| Type: | String |
| 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, Exchange Online, Exchange Online Protection |
-MarketplaceCorrelationID
O parâmetro MarketplaceCorrelationID especifica o identificador de correlação do Office Store para o aplicativo.
| Type: | String |
| 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, Exchange Online Protection |
-MarketplaceQueryMarket
O parâmetro MarketplaceQueryMarket especifica o local em que um aplicativo é arquivado no Office Marketplace. Por exemplo, um aplicativo na loja dos Estados Unidos, em inglês, usa o valor en-US. O valor padrão é en-US.
| Type: | String |
| 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, Exchange Online, Exchange Online Protection |
-MarketplaceServicesUrl
O parâmetro MarketplaceServicesUrl especifica a URL completa de serviços para o aplicativo. Você deve especificar apenas um local de origem para o arquivo de manifesto do aplicativo. Você pode especificar o arquivo de manifesto do aplicativo usando o parâmetro MarketplaceServicesUrl, Url ou FileData.
| Type: | String |
| 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, Exchange Online, Exchange Online Protection |
-MarketplaceUserProfileType
O parâmetro MarketplaceUserProfileType especifica o tipo de perfil de usuário da Office Store.
| Type: | String |
| 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, Exchange Online Protection |
-OrganizationApp
A opção OrganizationApp especifica que o escopo do aplicativo é organizacional (não ligado a um usuário específico). Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PrivateCatalog
A opção PrivateCatalog especifica se o aplicativo está localizado em um catálogo privado. Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ProvidedTo
O parâmetro ProvidedTo especifica a disponibilidade de um aplicativo em sua organização. Os valores válidos são:
- Todos: esse é o valor padrão. Este aplicativo é fornecido para todos os usuários da organização. Cada usuário vê esse aplicativo listado na lista de aplicativos instalados no Outlook na Web Options. Quando um aplicativo na lista de aplicativos instalados estiver habilitado, os usuários podem usar os recursos desse aplicativo em seus emails. Todos os usuários são impedidos de instalar suas próprias instâncias desse aplicativo, inclusive, mas sem limitações, usuários com permissões para instalar aplicativos,
- SpecificUsers: este aplicativo é fornecido apenas para os usuários especificados pelo parâmetro UserList. Todos os outros usuários não podem ver esse aplicativo organizacional em sua visualização de gerenciamento, ele nem será ativado em seus itens de email ou calendário. Os usuários especificados também são bloqueados para instalar sua própria instância deste aplicativo. Os usuários fora da lista não são bloqueados para instalar sua própria instância deste aplicativo.
Use esse parâmetro com a opção OrganizationApp.
| Type: | ClientExtensionProvidedTo |
| 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, Exchange Online |
-Url
O parâmetro Url especifica a URL completa do local do arquivo de manifesto de aplicativo que você deseja instalar. Você deve especificar apenas um local de origem para o arquivo de manifesto do aplicativo. Você pode especificar o arquivo de manifesto do aplicativo usando o parâmetro MarketplaceServicesUrl, Url ou FileData.
Observação: não há suporte para URLs com redirecionamentos em Exchange Server 2016, Exchange Server 2019 e Exchange Online. Use uma URL direta para o manifesto.
| Type: | Uri |
| 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, Exchange Online, Exchange Online Protection |
-UserList
O parâmetro UserList especifica quem pode usar um aplicativo organizacional. Esse parâmetro é limitado a 1000 usuários. No serviço baseado em nuvem, esse valor é menos relevante à medida que o gerenciamento de suplementos do Office está se movendo para Implantação Centralizada.
Os valores válidos são caixas de correio ou usuários de email em sua organização. É possível usar qualquer valor que identifique o usuário com exclusividade. 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
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".
Use esse parâmetro com a opção OrganizationApp.
| Type: | MultiValuedProperty |
| 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, Exchange Online |
-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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
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.