New-App
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 New-App cmdlet 安装 Outlook 应用。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
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>]
说明
如果为整个组织启用了应用,则用户可以在 Outlook 或 Outlook 网页版 Microsoft 查看邮件或日历项目时激活新应用。 如果未启用已安装的应用,用户可以从Outlook 网页版选项启用该应用。 同样,管理员可以从 Exchange 管理中心或使用 Enable-App 或 Set-App cmdlet 启用已安装的应用。
有关详细信息,请参阅在 Exchange Server 中管理用户对 Outlook 加载项的访问和管理Microsoft 365 管理中心中的外接程序部署。
您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml'))
此示例安装了已复制到本地硬盘的 Finance Test 应用程序清单文件。
示例 2
New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser Enabled
此示例通过 Contoso corporate 网络上的 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)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (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 参数指定应用清单文件。
注意:Exchange Server 2016、Exchange Server 2019 和 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)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
Update 如果值包含空格或需要引号,请使用以下语法: "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
若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。