使用集中式部署 PowerShell cmdlet 管理加载项

  • 项目

作为 Microsoft 365 全局管理员，可以通过集中部署功能将 Office 外接程序部署到用户 (请参阅在 管理中心) 部署 Office 外接程序 。 除了通过Microsoft 365 管理中心部署 Office 加载项外，还可以使用 Microsoft PowerShell。 安装适用于Windows PowerShell的 O365 集中式 Add-In 部署模块。

下载模块后，打开常规Windows PowerShell窗口并运行以下 cmdlet：

 Import-Module -Name O365CentralizedAddInDeployment

使用管理员凭据进行连接

在使用集中部署 cmdlet 之前，需要登录。

  1. 启动 PowerShell。

  2. 使用公司管理员凭据连接到 PowerShell。 运行以下 cmdlet。

Connect-OrganizationAddInService
  1. 在打开的登录提示中，选择或输入 Microsoft 365 用户管理员或全局管理员凭据。

注意

有关使用 PowerShell 的详细信息，请参阅 使用 PowerShell 连接到 Microsoft 365。

上传加载项清单

运行 New-OrganizationAdd-In cmdlet 以从路径（可以是文件位置或 URL）上传外接程序清单。 以下示例显示了 ManifestPath 参数值的文件位置。

New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US'

还可以运行 New-OrganizationAdd-In cmdlet 来上传外接程序，并使用 Members 参数直接将其分配给用户或组，如以下示例所示。 用逗号分隔成员的电子邮件地址。

New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US' -Members  'KathyBonner@contoso.com', 'MaxHargrave@contoso.com'

从 Office 应用商店上传加载项

运行 New-OrganizationAddIn cmdlet 以从 Office 应用商店上传清单。

在以下示例中，New-OrganizationAddIn cmdlet 为美国位置和内容市场的外接程序指定 AssetId。

New-OrganizationAddIn -AssetId 'WA104099688' -Locale 'en-US' -ContentMarket 'en-US'

若要确定 AssetId 参数的值，可以从加载项的 Office 应用商店网页的 URL 复制它。 AssetIds 始终以“WA”开头，后跟数字。 例如，在前面的示例中，WA104099688 的 AssetId 值的源是加载项的 Office 应用商店网页 URL： https://store.office.com/en-001/app.aspx?assetid=WA104099688。

Locale 参数和 ContentMarket 参数的值相同，并指示你尝试从其安装加载项的国家/地区。 格式为 en-US、fr-FR 等。

注意

从 Office 应用商店上传的加载项将在 Office 应用商店提供最新更新后的几天内自动更新。

获取加载项的详细信息

运行 Get-OrganizationAddIn cmdlet，如下所示，以获取上传到租户的所有加载项的详细信息，其中包括加载项的产品 ID。

Get-OrganizationAddIn

使用 ProductId 参数的值运行 Get-OrganizationAddIn cmdlet，以指定要为其检索详细信息的加载项。

Get-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122

若要获取所有加载项以及分配的用户和组的完整详细信息，请通过管道将 Get-OrganizationAddIn cmdlet 的输出传递到 Format-List cmdlet，如以下示例所示。

foreach($G in (Get-organizationAddIn)){Get-OrganizationAddIn -ProductId $G.ProductId | Format-List}

打开或关闭加载项

若要关闭加载项，以便分配给加载项的用户和组不再具有访问权限，请运行 Set-OrganizationAddIn cmdlet，并将 ProductId 参数和 Enabled 参数设置为 $false，如以下示例中所示。

Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Enabled $false

若要重新打开加载项，请运行同一 cmdlet，并将 Enabled 参数设置为 $true。

Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Enabled $true

在加载项中添加或删除用户

若要将用户和组添加到特定外接程序，请使用 ProductId、Add 和 Members 参数运行 Set-OrganizationAddInAssignments cmdlet。 用逗号分隔成员的电子邮件地址。

Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Add -Members 'KathyBonner@contoso.com','sales@contoso.com'

若要删除用户和组，请使用 Remove 参数运行同一 cmdlet。

Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Remove -Members 'KathyBonner@contoso.com','sales@contoso.com'

若要将外接程序分配给租户上的所有用户，请使用 AssignToEveryone 参数运行同一 cmdlet，并将值设置为 $true。

Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -AssignToEveryone $true

若要不向所有人分配外接程序并将还原分配给以前分配的用户和组，可以运行同一 cmdlet 并通过将其值设置为 $false来关闭 AssignToEveryone 参数。

Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -AssignToEveryone $false

更新加载项

若要从清单更新加载项，请使用 ProductId、ManifestPath 和 Locale 参数运行 Set-OrganizationAddIn cmdlet，如以下示例所示。

Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US'

注意

从 Office 应用商店上传的加载项将在 Office 应用商店提供最新更新后的几天内自动更新。

删除加载项

若要删除加载项，请使用 ProductId 参数运行 Remove-OrganizationAddIn cmdlet，如以下示例所示。

Remove-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122

获取每个 cmdlet 的详细帮助

可以使用 Get-help cmdlet 查看每个 cmdlet 的详细帮助。 例如，以下 cmdlet 提供有关 Remove-OrganizationAddIn cmdlet 的详细信息。

Get-help Remove-OrganizationAddIn -Full