SDKおよびAPI

最終公開日 : Nov 13, 2026
このリリースでは、いくつかの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をサポートしています。

シトリックス バーチャルアップス アンド デスクトップス™ SDK

このSDKは、Delivery Controller™またはStudioをインストールすると、PowerShellモジュールとして自動的にインストールされます。これにより、スナップインを追加することなく、このSDKのコマンドレットを使用できます。（このSDKをスナップインとしてインストールすることを選択した場合の指示は以下に記載されています。）

権限

Citrix管理権限を持つIDを使用してシェルまたはスクリプトを実行する必要があります。Controller上のローカル管理者グループのメンバーは、Citrix Virtual AppsまたはCitrix Virtual Desktops™をインストールするための完全な管理権限を自動的に持っていますが、Citrixは、通常の操作では、ローカル管理者アカウントを使用するのではなく、適切な権限を持つCitrix管理者を作成することを推奨します。

コマンドレットにアクセスして実行する

  1. PowerShellでシェルを起動します。Studioを開き、PowerShellタブを選択し、Launch PowerShellをクリックします。
  2. スクリプト内でSDKコマンドレットを使用するには、PowerShellで実行ポリシーを設定します。PowerShellの実行ポリシーについては、Microsoftのドキュメントを参照してください。
  3. (モジュールではなく) スナップインを使用する場合は、Add-PSSnapin (またはasnp) コマンドレットを使用してスナップインを追加します。
    V1とV2はスナップインのバージョンを示します。XenDesktop 5のスナップインはバージョン1です。Citrix Virtual Apps and Desktops、およびそれ以前のXenDesktop 7バージョンのスナップインはバージョン2です。例えば、Citrix Virtual Apps and Desktopsスナップインをインストールするには、Add-PSSnapin Citrix.ADIdentity.Admin.V2と入力します。すべてのコマンドレットをインポートするには、次のように入力します: Add-PSSnapin Citrix.*.Admin.V*
これで、コマンドレットとヘルプファイルを使用できます。
  • このSDKのヘルプファイルにアクセスするには、Categoriesリストで製品またはコンポーネントを選択し、次にCitrix Virtual Apps and Desktops SDKを選択します。
  • PowerShellのガイダンスについては、Windows PowerShell Integrated Scripting Environment (ISE)を参照してください。

グループポリシー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 の完全修飾ドメイン名です。

シトリックス バーチャル アプリケーションズ アンド デスクトップ 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 を使用してリソースを管理および最適化してください。

モニターサービス OData

Monitor API を使用すると、OData API のバージョン 3 または 4 を使用して Monitor Service データにアクセスできます。Monitor Service データからクエリされたデータに基づいて、カスタマイズされた監視およびレポートダッシュボードを作成できます。OData V.4 は ASP.NET Web API に基づいており、集計クエリをサポートしています。
詳細については、Monitor Service OData API を参照してください。