New-App

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 某些參數和設定可能僅限於一個環境或另一個環境。

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

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

語法

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>]

Description

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

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

您必須已獲指派權限,才能執行此指令程式。 雖然本文列出 Cmdlet 的所有參數,但如果指派給您的權限中未包含某些參數,您可能無法存取這些參數。 若要尋找在組織中執行任何 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 manifest.xml 安裝 Contoso CRM 應用程式。 Exchange 伺服器必須能夠連線到目標 URL。 此應用程式是安裝為組織應用程式,可供特定使用者清單使用,並且預設為這些使用者啟用。

參數

-AddInOverrides

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填滿 AddInOverrides 描述 }}

參數屬性

類型:AddInOverrides
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AllowReadWriteMailbox

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AllowSetting

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填滿 AllowSetting 描述 }}

參數屬性

類型:AllowSetting
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AppState

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填寫 AppState 描述 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AppType

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填滿 AppType 說明 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

  • 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:-Confirm:$false。
  • 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet,指定不帶值的 Confirm 參數會造成暫停,強制您在繼續之前先確認命令。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:CF

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultStateForUser

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

  • 已啟用:組織應用程式預設為啟用。
  • 已停用:組織應用程式預設為停用。 此值為預設值。
  • AlwaysEnabled:組織應用程式已啟用且使用者無法停用它。

使用此參數時,您需要使用 OrganizationApp 參數。

參數屬性

類型:DefaultStateForUser
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DomainController

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。

參數屬性

類型:Fqdn
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DownloadOnly

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Enabled

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

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

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Etoken

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-FileData

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

參數屬性

類型:

Byte[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionFileData
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-FileStream

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

FileStream 參數只會由 Exchange 系統管理中心用來支援應用程式檔案上傳程式。 請勿使用此參數來指定應用程式資訊清單檔案。 您可以使用 MarketplaceServicesUrl、Url 或 FileData 參數來指定應用程式資訊清單檔案。

參數屬性

類型:Stream
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionFileStream
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填入身分識別描述 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Mailbox

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

參數屬性

類型:MailboxIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MarketplaceAssetID

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

MarketplaceAssetID 參數會指定應用程式的 Office 市集識別碼。 如果您使用 MarketplaceServicesUrl 參數,則需要使用此參數。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MarketplaceCorrelationID

適用項目:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MarketplaceQueryMarket

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

MarketplaceQueryMarket 參數會指定在 Office 市集中歸檔應用程式的地區設定。 例如,美國市場英文版應用程式會使用值 en-US。 預設值為 en-US。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MarketplaceServicesUrl

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MarketplaceUserProfileType

適用項目:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionOfficeMarketplace
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-OrganizationApp

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PrivateCatalog

適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ProvidedTo

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

您會將此參數與 OrganizationApp 參數搭配使用。

參數屬性

類型:ClientExtensionProvidedTo
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-UpdateAppState

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填滿 UpdateAppState 描述 }}

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Url

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

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

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

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ExtensionPrivateURL
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-UserList

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

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

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

您會將此參數與 OrganizationApp 參數搭配使用。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Version

適用:Exchange Online

此參數只能在雲端式服務中使用。

{{ 填滿版本描述 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

適用項目:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署信箱的內建安全性附加元件

WhatIf 參數會顯示命令在不進行任何變更的情況下執行的動作。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:WI

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

Input types

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

輸出

Output types

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