uip gov aops-policy

'uip gov aops-policy' のポリシー CRUD、製品カタログ、ライセンスの種類カタログ、および Form.io テンプレートコマンドの構文とオプション。

uip gov aops-policy は、UiPath の AOps ガバナンス ポリシーを管理します。このポリシーは、製品設定ルール (許可するプロジェクト設定を制限する StudioX ポリシーなど) であり、入力済みの Form.io フォームとして作成され、テナント、ユーザー、グループにわたって割り当てられます。このページでは、作成側について説明します。ポリシー レコード自体 (list/get/create/update/delete)、読み取り専用の参照カタログ (product、 license-type)、およびポリシーのdataペイロードの構築元となる入力可能なフォーム データのブループリントを生成する template コマンドです。サブジェクトにポリシーを割り当て、実行時に実際に適用される内容の解決については、「 aops-policy deployment 」および「 deployed-policy」をご覧ください。親ツールの概要とアクセス ポリシーについては、「 uip gov」をご覧ください。

注:

一般的なフロー: template get <product> →、出力された form-data.json → policy create --product-name <product> --name <name> --input form-data.json →deployment tenant configure (またはユーザー/グループ) を編集してロールアウトします。

概要

uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>

uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>

uip gov aops-policy license-type list

uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>

すべての動詞は、その 1 回の呼び出しの対話型ログイン トークンの有効期間を上書きする --login-validity <minutes> も受け入れます (必要になることはめったにありません)。

uip gov aops-policy list

ガバナンス ポリシーを、任意のフィルター処理とページネーションとともに一覧表示します。BLOB data ポリシーではなく、ポリシーのメタデータ (識別子、名前、製品、優先度、可用性) を返します。

オプション

長押し	値 (Value)	説明
--product-name <product-name>	string	1 つの製品に制限します (例:StudioX)。product.nameを照合します — product listをご覧ください。
--product-label <productLabel>	string	表示ラベルで 1 つの製品に制限します (例:'Studio X')。スクリプティング用の --product-name を優先します。
--search <searchTerm>	string	部分文字列と大文字と小文字を区別せず、ポリシー名/説明と照合します。
--sort-by <field>	string	並べ替えの基準にするフィールドです (例:name、 createdOn、 priority)。ガバナンス API に渡されます。
--sort-order <direction>	asc | desc	--sort-byの並べ替え方向。大文字と小文字を区別しません。それ以外の値は、クライアント側では失敗します。
--limit <n>	integer	ページ サイズ。既定 20です。
--offset <n>	integer	ゼロから始まるページ インデックス。

例

uip gov aops-policy list --product-name StudioX --limit 2

データシェイプ(--output json)

{
  "Code": "AopsPolicyList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
  ]
}

uip gov aops-policy get

完全な data ペイロード (入力されたフォーム データのブループリント) を含む、識別子で 1 つのポリシーを取得します。送信された値を検査したり、フォローアップ updateをシードしたりするために使用します。

引数

名前	Required	目的
<policyIdentifier>	○	ポリシー GUID ( listから)。

例

uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001

データシェイプ(--output json)

{
  "Code": "AopsPolicyGet",
  "Data": {
    "identifier": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "Baseline StudioX Policy",
    "productName": "StudioX",
    "priority": 10,
    "availability": 1,
    "data": { "allowAnalytics": true, "maxProjects": 5 }
  }
}

dataのキーは、パスカルケースではなく、Form.io 形式 (camelCase / kebab-case) で表示されているとおりに保持されます — このペイロードは、変更されていない update --input にラウンドトリップするように設計されています。

uip gov aops-policy 作成

製品の新しいガバナンス ポリシーを作成します。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	人間が判読できるポリシー名です (製品内で一意)。
--product-name <product-name>	string	○	対象製品 (例:StudioX、 AITrustLayer) — product listの名前と一致する必要があります。
--description <description>	string	×	ガバナンスの UI にフリー テキストで記述が表示されます。
--priority <n>	integer	×	同じ主題に複数のポリシーが適用される場合、数字が多いほど勝ちます。
--availability <n>	integer	×	提供状況フラグ (製品固有の列挙型) — 有効な値については、ガバナンス UI またはサービスのドキュメントをご覧ください。
--input <path>	パス	×	入力されたフォーム データ オブジェクトを含む JSON ファイル ( template get --output-form-dataから)。データ ペイロードのないポリシーの場合は省略します。

例

uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

データシェイプ(--output json)

{
  "Code": "AopsPolicyCreate",
  "Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}

応答は、フラット化された図形ではなく、生の (二重にラップされた) データ blob をエコーします。get返されます。フォローアップ update --input用のフォーム データを生成するには、getを使用します。

UIP Gov AOPS-Policy の更新

既存のポリシーのフィールドを置き換えます。パッチではなく完全な更新 — 保持するすべてのフィールドを再度渡す必要があります。 --description/--priority/--availability/--input を省略すると、サーバー上のそのフィールドがクリアされます。

オプション

長押し	値 (Value)	Required	説明
--identifier <identifier>	GUID	○	ポリシーを更新します。list/getから。
--name <name>	string	○	ポリシー名。既存の名前を渡すと、名前は保持されます。
--product-name <product-name>	string	○	ポリシーの既存の製品と一致する必要があります。更新時の製品の変更はサポートされていません。
--description <description>	string	×	完全置換: 既存の値を get から再渡して保持します。
--priority <n>	integer	×	完全置換: 既存の値を渡して保持します。
--availability <n>	integer	×	完全置換: 既存の値を渡して保持します。
--input <path>	パス	×	完全置換: 既存の data ( getから保存) を再渡して保持します。

基になる Form.io テンプレートを移行中の場合は、「テンプレートのアップグレードを進行中です。」というエラーが発生して失敗します。移行が完了したらリトライしてください。

例

uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

データシェイプ(--output json)

createと同じ形状で、 Code: "AopsPolicyUpdate"が付いています。

uip gov aops-policy delete

ガバナンス ポリシーを完全に削除する。

注:

ポリシーがまだ任意のテナント/ユーザー/グループに割り当てられている場合は失敗します。最初にすべてのサブジェクトで deployment tenant\|user\|group remove を実行してから、リトライします。

引数

名前	Required	目的
<policyIdentifier>	○	ポリシー GUID ( listから)。

例

uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001

データシェイプ(--output json)

{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }

UIP Gov AOPS-Policy 製品

ガバナンス テンプレートをパブリッシュする製品の読み取り専用カタログです。有効な --product-name 値を検出するには、 を使用します。

UIP Gov AOPS-Policy 製品リスト

例

uip gov aops-policy product list

データシェイプ(--output json)

{
  "Code": "AopsProductList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
  ]
}

name、template get <productIdentifier>、およびdeployment ... configureのエントリpolicy create --product-name期待するものです。label は表示名です。

uip gov aops-policy product get

引数

名前	Required	目的
<productIdentifier>	○	製品名 (例:StudioX) または GUID — product listからnameまたはidentifier。

例

uip gov aops-policy product get StudioX

データシェイプ(--output json)

{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }

uip gov aops-policy license-type

ライセンスの種類の読み取り専用カタログ (例:Attended、Unattended) — エントリdeployment tenant configureスコープの設定に使用され、deployed-policy get/listの<license-type>引数として使用されます。

uip gov aops-policy license-type list

例

uip gov aops-policy license-type list

データシェイプ(--output json)

{
  "Code": "AopsLicenseTypeList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
  ]
}

この identifier は、 deployment tenant configure エントリをフィードします。表示 name は、 deployed-policy get/list <license-type>として受け入れるものです。

UIP Gov AOPS-Policy テンプレート

製品の Form.io ポリシー テンプレート (ポリシーの data ペイロードのソース) から、入力可能なフォーム データのブループリント (および人間が判読できる参照) を生成します。

uip gov aops-policy テンプレート get

1 つの製品のアクティブな Form.io テンプレートを取得し、ポリシー成果物を出力します。

引数

名前	Required	目的
<productIdentifier>	○	製品名または識別子 (例:StudioX)。

オプション

長押し	値 (Value)	説明
--output-form-data <path>	パス	入力可能なフォーム データ ブループリント JSON を記述します。これは、 create/updateで編集して送信するオブジェクトです。表示専用のコンポーネント (非表示、ボタン、送信、HTML、コンテンツ) はスキップされます。欠落しているリーフは、種類に適した既定値 ([チェックボックス] にはfalse 、編集グリッドには [] 、選択ボックスには {} 、テキスト/選択には null が割り当てられます)。
--output-template-locale-resource <path>	パス	ロケールで解決された人間が判読できる参照を記述する: 製品スコープのすべてのロケール キーは英語の文字列に置き換えられ (元のロケールを保持する兄弟 <prop>-key )、 defaultData.data フラットなアノテーション付きマップ ({ value, type, label, description?, tooltip? }) になります。製品間のプレフィックス (例:AutomationOps.submit) は未解決のままです。

どちら --output-* フラグも渡されない場合は、代わりにテンプレートとフォーム データの両方が stdout Data ペイロードで返されます。

例

uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json

データシェイプ(--output json)

{
  "Code": "AopsPolicyTemplateGet",
  "Data": {
    "formDataFile": "/Users/alice/aops/form-data.json",
    "templateLocaleResourceFile": "/Users/alice/aops/reference.json"
  }
}

--output-*フラグが渡されない場合、Data には代わりに template (生の Form.io DTO) と formData (ブループリント) が直接含まれます — どちらも Pascal 大文字と小文字ではなく、ネイティブの Form.io キーの大文字と小文字を保持するため、create/update --input へのラウンドトリップがformDataされます。

UnsupportedTemplateComponentError (製品のテンプレートで CLI では変換できないコンポーネントの種類を使用している) が失敗して ErrorCode: "configuration_error" と Retry: "RetryWillNotFix" (その場合は、ポリシーを手動で作成dataしてください)。

UIP Gov AOPS-Policy テンプレートのリスト

すべての製品のテンプレートを取得し、製品ごとに完全な成果物セットをダンプします — ループする代わりに を使用します template getを使用します。

オプション

長押し	値 (Value)	Required	説明
--output-dir <path>	パス	○	製品ごとに 1 つの<ProductName>/ フォルダー ( 、 、 form-template.jsonform-data.json、 form-template-locale-resource.jsonを含む) が 1 つ作成されるディレクトリ。

製品ごとの失敗が収集され、実行は中止されません。コマンドは、すべての製品が失敗した場合にのみ、ゼロ以外で終了します。

例

uip gov aops-policy template list --output-dir ./aops-templates

データシェイプ(--output json)

{
  "Code": "AopsPolicyTemplateList",
  "Data": {
    "outputDir": "/Users/alice/aops-templates",
    "results": [
      {
        "productName": "StudioX",
        "status": "Success",
        "templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
        "formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
        "templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
      }
    ]
  }
}

失敗した製品のエントリには、3 つのファイル パスではなく status: "Failure" と message フィールドがあります。

関連

• uip gov — ツールの概要とアクセス ポリシー
• aops-policy deploymentとdeployed-policy — テナント/ユーザー/グループにポリシーを割り当て、有効なポリシーを解決します。
• compliance-packs — ポリシーを指定したフレームワークにバンドルします。

参照

• ツール (プラグイン)
• グローバル オプション
• 終了コード