アプリケーションライフサイクル管理(ALM)における変数ライブラリの管理を自動化するには、Fabric REST APIを使用します。
ライフサイクル管理の一部として API を使用している場合は、Git の更新とパイプラインのデプロイ時に項目参照のアクセス許可がチェックされます。
[前提条件]
API を使用するには、次のものが必要です。
- 変数ライブラリ項目と同じ前提条件。
- Fabric サービスの Microsoft Entra トークン。 API 呼び出しの承認ヘッダーでトークンを使用します。 トークンを取得する方法については、 Fabric API のクイック スタートを参照してください。
変数ライブラリ API
変数ライブラリ REST API を使用して、次の関数を実行できます。
- 変数ライブラリを作成する: 指定したワークスペースに変数ライブラリを作成します。
-
変数ライブラリを取得する: 変数ライブラリのプロパティを取得します。
VariableLibraryPropertiesパラメーターを使用して、アクティブな値セットを取得することもできます。 -
変数ライブラリを更新する: 変数ライブラリのプロパティを更新します。
VariableLibraryPropertiesパラメーターを使用して、アクティブな値セットを更新することもできます。 - 変数ライブラリを削除する: 指定した変数ライブラリを削除します。
- 変数ライブラリの一覧表示: 指定したワークスペース内の変数ライブラリを一覧表示します。
- 変数ライブラリの定義を取得する: 変数ライブラリのパブリック 定義 を取得します。
- 変数ライブラリの定義を更新する: 変数ライブラリの 定義 をオーバーライドします。
変数ライブラリ REST API は、サービス プリンシパルをサポートします。
例示
API の使用方法の例については、各 API の REST ドキュメント を参照してください。
変数ライブラリの定義構造の詳細については、「変数ライブラリの 定義」を参照してください。
考慮事項と制限事項
変数の制限事項
次の両方の要件を満たしている限り、 最大 1,000 個の変数と 最大 1,000 個の値セットを使用できます。
- 代替値セット内のセルの合計数が 10,000 未満です。
- 項目のサイズが 1 MB を超えていない。
これらの要件は、変更を保存するときに検証されます。
メモ フィールドの文字数は最大 2,048 文字です。
値セットの説明フィールドには、最大 2,048 文字を指定できます。
代替値セットの制限事項
- 変数ライブラリの代替値セットは、追加した順序で表示されます。 現時点では、UI で並べ替えることはできません。 順序を変更するには、JSON ファイルを直接編集します。
- 各値セットの名前は、変数ライブラリ内で一意である必要があります。
- 変数名は、変数ライブラリ内で一意である必要があります。 異なるアイテム内にある場合は、ワークスペース内に同じ名前の 2 つの変数を含めることができます。
- 変数ライブラリには、常に 1 つのアクティブな値が一度に 1 つしか設定されていません。 アクティブな間は、値セットを削除できません。 削除するには、まず別の値セットをアクティブに構成します。 デプロイ パイプラインのステージごとに異なるアクティブな値を設定できます。