TechNet
Export (0) Print
Expand All

New-App

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-App cmdlet to install apps for Outlook.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-App [-FileData <Byte[]>] <COMMON PARAMETERS>

New-App [-Etoken <String>] [-MarketplaceAssetID <String>] [-MarketplaceCorrelationID <String>] [-MarketplaceQueryMarket <String>] [-MarketplaceServicesUrl <String>] [-MarketplaceUserProfileType <String>] <COMMON PARAMETERS>

New-App [-FileStream <Stream>] <COMMON PARAMETERS>

New-App [-Url <Uri>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-AllowReadWriteMailbox <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] [-DomainController <Fqdn>] [-DownloadOnly <SwitchParameter>] [-Enabled <$true | $false>] [-Mailbox <MailboxIdParameter>] [-OrganizationApp <SwitchParameter>] [-PrivateCatalog <SwitchParameter>] [-ProvidedTo <Everyone | SpecificUsers>] [-UserList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

This example installs the Finance Test app manifest file that has been copied to the local hard disk.

New-App -FileData ([Byte[]](Get-Content -Encoding Byte -Path "C:\Apps\FinanceTestApp.xml" -ReadCount 0))

For more information, see Install or remove apps for Outlook for your organization.

This example installs the Contoso CRM app manifest.xml from a URL on the Contoso corporate network. The Exchange server must be able to reach the target URL. This app is installed as an organization app,is made available to a specific list of users, and is enabled for those users by default.

New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser Enabled

For more information, see Install or remove apps for Outlook for your organization.

If the app is enabled for the entire organization, users can activate the new app when viewing mail or calendar items within MicrosoftOutlook or Outlook on the web. If an installed app isn't enabled, users can enable the app from Outlook on the web Options. Similarly, administrators can enable installed apps from the Exchange admin center or by using the Enable-App or Set-App cmdlet.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "apps for Outlook" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

AllowReadWriteMailbox

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DefaultStateForUser

Optional

Microsoft.Exchange.Management.Extension.DefaultStateForUser

The DefaultStateForUser parameter specifies the default initial state of an organization app. Valid values are:

  • Enabled    The organization app is enabled by default.

  • Disabled    The organization app is disabled by default. This is the default value.

  • AlwaysEnabled    The organization app is enabled, and users can't disable it.

You need to use the OrganizationApp switch when you use this parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

DownloadOnly

Optional

System.Management.Automation.SwitchParameter

The DownloadOnly switch specifies whether to get the app manifest file and prompt the user for confirmation before committing to actual installation. You don't need to specify a value with this switch.

When you use this switch, the cmdlet only downloads the app manifest file and displays the app properties without installing the app.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the app is available to users in the organization. Valid values are:

  • $true   The app is available to the specified users. This is the default value.

  • $false   The app is hidden from all users in the organization.

CautionCaution:
This setting overrides the ProvidedTo, UserList, and DefaultStateForUser settings. This setting doesn't prevent users from installing their own instance of the app if they have install permissions.

Etoken

Optional

System.String

This parameter is reserved for internal Microsoft use.

FileData

Optional

System.Byte[]

The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.

A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, ([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0)).

FileStream

Optional

System.IO.Stream

The FileStream parameter is used only by the Exchange admin center to support the app file uploader. Don't use this parameter to specify the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example:

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

MarketplaceAssetID

Optional

System.String

The MarketplaceAssetID parameter specifies the office store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter.

MarketplaceCorrelationID

Optional

System.String

PARAMVALUE: String

MarketplaceQueryMarket

Optional

System.String

The MarketplaceQueryMarket parameter specifies the locale that an app is filed under at the office marketplace. For example, an app for the United States market in English uses the value en-US. The default value isen-US.

MarketplaceServicesUrl

Optional

System.String

The MarketplaceServicesUrl parameter specifies the full services URL for the app. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.

MarketplaceUserProfileType

Optional

System.String

PARAMVALUE: String

OrganizationApp

Optional

System.Management.Automation.SwitchParameter

The OrganizationAppswitch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch.

PrivateCatalog

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

ProvidedTo

Optional

Microsoft.Exchange.Data.ApplicationLogic.Extension.ClientExtensionProvidedTo

The ProvidedTo parameter specifies the availability of the app in your organization. Valid values are:

  • Everyone   This is the default value. This app is provided to every user in the organization.

    Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions.

  • SpecificUsers   This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor will it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app.

You use this parameter with the OrganizationApp switch.

Url

Optional

System.Uri

The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.

UserList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserList parameter specifies who can usean organizational app. Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

To enter multiple values, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>"....

You use this parameter with the OrganizationApp switch.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show:
© 2016 Microsoft