New-App

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。

使用 New-App Cmdlet 安裝 Outlook 應用程式。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

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

如果應用程式已針對整個組織啟用,使用者可以在檢視 Outlook 或 Microsoft Outlook 網頁版 內的郵件或行事曆專案時,啟用新的應用程式。 如果未啟用已安裝的應用程式,使用者可以從 [選項] Outlook 網頁版啟用應用程式。 同樣地,系統管理員可以從 Exchange 系統管理中心或使用 Enable-App 或 Set-App Cmdlet 來啟用已安裝的應用程式。

如需詳細資訊,請參閱在 Exchange Server 中管理 Outlook 載入宏的使用者存取權和在Microsoft 365 系統管理中心中管理增益集的部署

您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet

範例

範例 1

New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml'))

此範例會安裝已複製到本機硬碟的財務測試應用程式資訊清單檔案。

範例 2

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

本範例會從 Contoso 公司網路上的 URL 安裝 Contoso CRM 應用程式manifest.xml。 Exchange 伺服器必須能夠連線到目標 URL。 此應用程式會安裝為組織應用程式、提供給特定的使用者清單使用,並預設會為這些使用者啟用。

參數

-AllowReadWriteMailbox

AllowReadWriteMailbox 參數會指定應用程式是否允許讀取/寫入信箱許可權。 您不需要使用此參數指定值。

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

Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。

  • 例如,具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停,可強制您在繼續之前確認命令。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:-Confirm:$false
  • 其他大部分的 Cmdlet (例如,New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
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

DefaultStateForUser 參數會指定組織應用程式的預設初始狀態。 有效值為:

  • 已啟用:預設會啟用組織應用程式。
  • 已停用:預設會停用組織應用程式。 這是預設值。
  • AlwaysEnabled:已啟用組織應用程式,且使用者無法加以停用。

當您使用此參數時,必須使用 OrganizationApp 參數。

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

此參數僅適用於內部部署 Exchange。

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,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

DownloadOnly 參數會指定是否要取得應用程式資訊清單檔案,並在認可實際安裝之前提示使用者確認。 您不需要使用此參數指定值。

當您使用此參數時,Cmdlet 只會下載應用程式資訊清單檔案,並在不安裝應用程式的情況下顯示應用程式屬性。

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

Enabled 參數會指定組織中的使用者的應用程式是否可用。 有效值為:

  • $true:應用程式可供指定的使用者使用。 這是預設值。
  • $false:應用程式會對組織中的所有使用者隱藏。

此設定會覆寫 ProvidedTo、UserList 和 DefaultStateForUser 設定。 若使用者擁有安裝權限,此設定無法讓使用者不能自行安裝應用程式的執行個體。

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

將保留此參數供 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

FileData 參數會指定應用程式資訊清單檔的位置。 您只需要為應用程式資訊清單檔指定一個來源位置。 您可以使用 MarketplaceServicesUrl、Url 或 FileData 參數來指定應用程式資訊清單檔。

此參數的有效值需要您使用下列語法,將檔案讀取至位元組編碼的物件: ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')) 。 您可以使用此命令作為參數值,也可以將輸出寫入變數 () $data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>') ,並使用 變數作為參數值 () $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

FileStream 參數僅供 Exchange 系統管理中心用來支援應用程式檔案上傳程式。 請勿使用此參數來指定應用程式資訊清單檔。 您可以使用 MarketplaceServicesUrl、Url 或 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

Mailbox 參數會指定您要安裝應用程式的信箱。 您可以使用可唯一識別信箱的任何值。 例如:例如:

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • Domain\Username
  • 電子郵件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 使用者識別碼或使用者主要名稱 (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

MarketplaceAssetID 參數會指定應用程式的 Office 市集識別碼。 如果您使用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

MarketplaceCorrelationID 參數會指定應用程式的 Office 市集相互關聯識別碼。

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

MarketplaceQueryMarket 參數會指定在 Office 市集下提出應用程式的地區設定。 例如,英文美國市場的應用程式會使用 en-US 值。 預設值為 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

MarketplaceServicesUrl 參數會指定應用程式的完整服務 URL。 您只需要為應用程式資訊清單檔指定一個來源位置。 您可以使用 MarketplaceServicesUrl、Url 或 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

MarketplaceUserProfileType 參數會指定 Office 市集的使用者設定檔類型。

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

OrganizationApp 參數會指定應用程式的範圍為組織 (不受限於特定使用者)。 您不需要使用此參數指定值。

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

PrivateCatalog 參數會指定應用程式是否位於私人目錄中。 您不需要使用此參數指定值。

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

ProvidedTo 參數會指定您組織中應用程式的可用性。 有效值為:

  • 所有人:這是預設值。 此應用程式會提供給組織中的每個使用者。 每位使用者都會在 [Outlook 網頁版 選項] 的已安裝應用程式清單中看到此應用程式。 已安裝應用程式清單中的應用程式為已啟用時,使用者即可在電子郵件中使用此應用程式的功能。 所有使用者皆無法自行安裝此應用程式的執行個體,包括但不限於擁有安裝應用程式權限的使用者。
  • SpecificUsers:此應用程式僅提供給 UserList 參數所指定的使用者。 所有其他使用者在其管理檢視中都不會看到此組織應用程式,也不會在其郵件或行事曆專案中啟動。 指定的使用者也會遭到封鎖,無法安裝自己的此應用程式實例。 未列出的使用者不會被封鎖,無法安裝自己的此應用程式實例。

您會將此參數與 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

Url 參數會指定您要安裝之應用程式資訊清單檔案的完整 URL 位置。 您只需要為應用程式資訊清單檔指定一個來源位置。 您可以使用 MarketplaceServicesUrl、Url 或 FileData 參數來指定應用程式資訊清單檔。

注意:2016 Exchange Server、2019 Exchange Server 和 Exchange Online 不支援具有重新導向的 URL。 使用資訊清單的直接 URL。

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

UserList 參數會指定誰可以使用組織應用程式。 此參數限制為 1000 位使用者。 在雲端式服務中,此值較不相關,因為 Office 增益集管理正在移至 集中式部署

有效值為組織中的信箱或郵件使用者。 您可以使用唯一識別使用者的任何值。 例如:

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • Domain\Username
  • 電子郵件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 使用者識別碼或使用者主要名稱 (UPN)

您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"

您會將此參數與 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

WhatIf 參數會模擬命令的動作。 使用此參數時,您不需要實際套用變更即可檢視可能會發生的變更。 您不需要使用此參數指定值。

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

輸入

Input types

若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。