製品ドキュメント
Citrix Virtual Apps and Desktops
Service Current Release 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
PDFを表示

SDKおよびAPI

January 9, 2024
寄稿者: 
C

このリリースでは、複数のSDKおよびAPIを使用できます。SDKとAPIにアクセスするには、「Build anything with Citrix」に移動します。そこから、［Citrix Workspace］ を選択して、Citrix Virtual Apps and Desktopsとその関連コンポーネントのプログラミング情報にアクセスします。

注：

Citrix Virtual Apps and Desktops SDKおよびCitrixグループポリシーSDKは、モジュールまたはスナップインとしてインストールできます。いくつかのコンポーネントSDK（Citrix Licensing、Citrix Provisioning、StoreFrontなど）は、スナップインのみを使用してインストールします。

この製品は、PowerShellのバージョン3から5までをサポートします。

Citrix Virtual Apps and Desktops SDK

このSDKは、Delivery ControllerまたはStudioをインストールするとPowerShellモジュールとして自動的にインストールされます。これにより、スナップインを追加しなくても、このSDKのコマンドレットを使用できるようになります。（このSDKをスナップインとしてインストールする場合の手順は後で説明します。）

アクセス権

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

コマンドレットのアクセスと実行

  1. PowerShellのシェルを開きます。Studioを開き、［PowerShell］ タブを選択して ［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

CitrixグループポリシーSDKにより、グループポリシーの設定およびフィルターを表示して構成できます。このSDKは、PowerShellプロバイダーを使用して、マシン、ユーザー設定、およびフィルターに対応する仮想ドライブを作成します。このプロバイダーは、New-PSDriveに対する拡張として表示されます。

Group Policy SDKを使用するには、StudioまたはCitrix Virtual Apps and Desktops SDKのいずれかをインストールする必要があります。

CitrixグループポリシーのPowerShellプロバイダーは、モジュールまたはスナップインとして利用できます。

  • このモジュールを使用するために追加で作業が必要になることはありません。
  • このスナップインを追加するには、「Add-PSSnapin citrix.common.grouppolicy」と入力します。

ヘルプにアクセスするには、「help New-PSDrive -path localgpo:/」と入力します。

仮想ドライブを作成して設定を読み込むには、「New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>」と入力します。ここで、<string>は接続して設定を読み込むサイトの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
January 9, 2024
寄稿者: 
C
January 9, 2024
寄稿者: 
C

この記事の概要

サイトに関するフィードバック | Your privacy choices footer linkプライバシーに関する選択肢 | プライバシーと法令 | Cookieの設定 | 同意設定 | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.