Citrix Virtual Apps and Desktops

SDK 和 API

此版本提供了多个 SDK 和 API。要访问这些 SDK 和 API,请访问 Build anything with Citrix。在此页面上,选择 Citrix Workspace 以访问 Citrix Virtual Apps and Desktops 及其相关组件的编程信息。

注意:

Citrix Virtual Apps and Desktops™ SDK 和 Citrix Group Policy SDK 可以作为模块或管理单元安装。多个组件 SDK(例如 Citrix Licensing、Citrix Provisioning 和 StoreFront)仅使用管理单元进行安装。

本产品支持 PowerShell 版本 3 到 5。

Citrix Virtual Apps™ and Desktops SDK

当您安装 Delivery Controller™ 或 Studio 时,此 SDK 会自动作为 PowerShell 模块安装。这使您无需添加管理单元即可使用此 SDK 的 cmdlet。(如果您选择将此 SDK 作为管理单元安装,下面提供了说明。)

权限

您必须使用具有 Citrix 管理权限的身份运行 shell 或脚本。尽管 Controller 上的本地管理员组成员自动拥有完全管理权限以允许安装 Citrix Virtual Apps 或 Citrix Virtual Desktops™,但 Citrix 建议在正常操作中,您创建具有适当权限的 Citrix 管理员,而不是使用本地管理员帐户。

访问并运行 cmdlet

  1. 在 PowerShell 中启动 shell:打开 Studio,选择 PowerShell 选项卡,然后单击 Launch PowerShell
  2. 要在脚本中使用 SDK cmdlet,请在 PowerShell 中设置执行策略。有关 PowerShell 执行策略的信息,请参阅 Microsoft 文档。
  3. 如果要使用管理单元(而不是模块),请使用 Add-PSSnapin(或 asnp)cmdlet 添加管理单元。

    V1 和 V2 表示管理单元的版本。XenDesktop 5 管理单元是版本 1。Citrix Virtual Apps and Desktops 以及更早的 XenDesktop 7 版本管理单元是版本 2。例如,要安装 Citrix Virtual Apps and Desktops 管理单元,请键入 Add-PSSnapin Citrix.ADIdentity.Admin.V2。要导入所有 cmdlet,请键入:Add-PSSnapin Citrix.*.Admin.V*

您现在可以使用 cmdlet 和帮助文件。

Group Policy SDK

Citrix Group Policy SDK 使您能够显示和配置组策略设置和筛选器。此 SDK 使用 PowerShell 提供程序来创建与计算机和用户设置及筛选器对应的虚拟驱动器。该提供程序显示为 New-PSDrive 的扩展。

要使用 Group Policy SDK,必须安装 Studio 或 Citrix Virtual Apps and Desktops SDK。

Citrix Group Policy PowerShell 提供程序可作为模块或管理单元使用。

  • 要使用模块,无需执行额外操作。
  • 要添加管理单元,请键入 Add-PSSnapin citrix.common.grouppolicy

要访问帮助,请键入:help New-PSDrive -path localgpo:/

要创建虚拟驱动器并加载设置,请键入 New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>,其中 Controller 字符串是您要连接并从中加载设置的站点中 Controller 的完全限定域名。

Citrix Virtual Apps and Desktops REST API

借助 Citrix Virtual Apps and Desktops REST API,您可以自动执行 Citrix Virtual Apps and Desktops 部署中资源的管理。

Citrix Virtual Apps and Desktops REST API 可在 https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apis 获取。不适用于 Citrix Virtual Apps and Desktops 的 API 已相应标记。请遵循其中的指南来配置对 API 服务的访问并使用 API 管理和优化您的资源。

Monitor Service OData

Monitor API 允许使用 OData API 的版本 3 或 4 访问 Monitor Service 数据。您可以根据从 Monitor Service 数据查询的数据创建自定义监视和报告仪表板。OData V.4 基于 ASP.NET Web API 并支持聚合查询。

有关详细信息,请参阅 Monitor Service OData API

SDK 和 API