New-App — usage, script and reference

Quick start script

# New-App — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-App
$before | Format-List

# 3. Make the change (dry run first)
New-App  -WhatIf
New-App

# 4. Verify and diff
$after = Get-App
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax — 4 parameter sets

ExtensionOfficeMarketplace

New-App [-Etoken <String>] [-MarketplaceCorrelationID <String>] [-MarketplaceAssetID <String>] [-MarketplaceQueryMarket <String>] [-MarketplaceServicesUrl <String>] [-MarketplaceUserProfileType <String>]
 [-AddInOverrides <AddInOverrides>]
 [-AllowReadWriteMailbox]
 [-AllowSetting <AllowSetting>]
 [-AppState <String>]
 [-AppType <String>]
 [-Confirm]
 [-DefaultStateForUser <DefaultStateForUser>]
 [-DomainController <Fqdn>]
 [-DownloadOnly]
 [-Enabled <Boolean>]
 [-Identity <String>]
 [-Mailbox <MailboxIdParameter>]
 [-OrganizationApp]
 [-PrivateCatalog]
 [-ProvidedTo <ClientExtensionProvidedTo>]
 [-UpdateAppState]
 [-UserList <MultiValuedProperty>]
 [-Version <String>]
 [-WhatIf]
 [<CommonParameters>]

ExtensionFileData

New-App [-FileData <Byte[]>]
 [-AddInOverrides <AddInOverrides>]
 [-AllowReadWriteMailbox]
 [-AllowSetting <AllowSetting>]
 [-AppState <String>]
 [-AppType <String>]
 [-Confirm]
 [-DefaultStateForUser <DefaultStateForUser>]
 [-DomainController <Fqdn>]
 [-DownloadOnly]
 [-Enabled <Boolean>]
 [-Identity <String>]
 [-Mailbox <MailboxIdParameter>]
 [-OrganizationApp]
 [-PrivateCatalog]
 [-ProvidedTo <ClientExtensionProvidedTo>]
 [-UpdateAppState]
 [-UserList <MultiValuedProperty>]
 [-Version <String>]
 [-WhatIf]
 [<CommonParameters>]

ExtensionFileStream

New-App [-FileStream <Stream>]
 [-AddInOverrides <AddInOverrides>]
 [-AllowReadWriteMailbox]
 [-AllowSetting <AllowSetting>]
 [-AppState <String>]
 [-AppType <String>]
 [-Confirm]
 [-DefaultStateForUser <DefaultStateForUser>]
 [-DomainController <Fqdn>]
 [-DownloadOnly]
 [-Enabled <Boolean>]
 [-Identity <String>]
 [-Mailbox <MailboxIdParameter>]
 [-OrganizationApp]
 [-PrivateCatalog]
 [-ProvidedTo <ClientExtensionProvidedTo>]
 [-UpdateAppState]
 [-UserList <MultiValuedProperty>]
 [-Version <String>]
 [-WhatIf]
 [<CommonParameters>]

ExtensionPrivateURL

New-App [-Url <Uri>]
 [-AddInOverrides <AddInOverrides>]
 [-AllowReadWriteMailbox]
 [-AllowSetting <AllowSetting>]
 [-AppState <String>]
 [-AppType <String>]
 [-Confirm]
 [-DefaultStateForUser <DefaultStateForUser>]
 [-DomainController <Fqdn>]
 [-DownloadOnly]
 [-Enabled <Boolean>]
 [-Identity <String>]
 [-Mailbox <MailboxIdParameter>]
 [-OrganizationApp]
 [-PrivateCatalog]
 [-ProvidedTo <ClientExtensionProvidedTo>]
 [-UpdateAppState]
 [-UserList <MultiValuedProperty>]
 [-Version <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (28)

Parameter	Type	What it controls
-AddInOverrides	AddInOverrides	This parameter is available only in the cloud-based service.
-AllowReadWriteMailbox	SwitchParameter	The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch.
-AllowSetting	AllowSetting	This parameter is available only in the cloud-based service.
-AppState	String	This parameter is available only in the cloud-based service.
-AppType	String	This parameter is available only in the cloud-based service.
-Confirm	SwitchParameter	The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DefaultStateForUser	DefaultStateForUser	The DefaultStateForUser parameter specifies the default initial state of an organization app. Valid values are:
-DomainController	Fqdn	This parameter is available only in on-premises Exchange.
-DownloadOnly	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.
-Enabled	Boolean	The Enabled parameter specifies whether the app is available to users in the organization. Valid values are:
-Etoken	String	This parameter is reserved for internal Microsoft use.
-FileData	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...
-FileStream	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...
-Identity	String	This parameter is available only in the cloud-based service.
-Mailbox	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:
-MarketplaceAssetID	String	The MarketplaceAssetID parameter specifies the Office Store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter.
-MarketplaceCorrelationID	String	The MarketplaceCorrelationID parameter specifies the Office Store correlation identifier for the app.
-MarketplaceQueryMarket	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 is en-US.
-MarketplaceServicesUrl	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...
-MarketplaceUserProfileType	String	The MarketplaceUserProfileType parameter specifies the user profile type for the Office Store.
-OrganizationApp	SwitchParameter	The OrganizationApp switch 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	SwitchParameter	The PrivateCatalog switch specifies whether the app is located in a private catalog. You don't need to specify a value with this switch.
-ProvidedTo	ClientExtensionProvidedTo	The ProvidedTo parameter specifies the availability of the app in your organization. Valid values are:
-UpdateAppState	SwitchParameter	This parameter is available only in the cloud-based service.
-Url	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...
-UserList	MultiValuedProperty	The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to...
-Version	String	This parameter is available only in the cloud-based service.
-WhatIf	SwitchParameter	The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.