Note
- これはプレビュー機能です。
- プレビュー機能は運用環境での使用を想定しておらず、機能が制限されている可能性があります。 これらの機能は正式リリース前に利用できるため、お客様は早期にアクセスしてフィードバックを提供できます。
この記事では、 Dataverse CLI で使用できるコマンドについて説明します。 すべてのコマンドは、その使用法、オプション、例を一覧表示する --help オプションをサポートしています。 データを返すコマンドは、スクリプトで役立つ生の JSON 出力の --json オプションをサポートします。
次のグローバル オプションは、任意のコマンドで使用できます。
| Option | Description |
|---|---|
--log-level <level> |
ログ 記録レベル ( Trace、 Debug、 Information、 Warning、 Error、または Critical) を設定します。 既定値: Warning。 |
--log-file |
コンソールではなく、一時ディレクトリ内のファイルにログを記録します。 |
--context <value> |
ユーザー エージェントに追加された操作コンテキスト。
DATAVERSE_OPERATION_CONTEXT環境変数を設定することもできます。 |
| Command | Description |
|---|---|
api describe |
API について説明する |
api invoke |
名前で API を呼び出す |
api list |
検出可能な API を一覧表示する |
api request |
認証された HTTP 要求を送信する |
auth create |
新しい認証プロファイルを作成する |
auth list |
すべての認証プロファイルを一覧表示する |
auth remove |
認証プロファイルを削除する |
auth select |
アクティブな認証プロファイルを選択する |
auth who |
現在の認証プロファイルを表示する |
data associate |
リレーションシップを介して 2 つのレコードをリンクする |
data count |
テーブル内のレコードをカウントする |
data create |
新しいレコードを作成します |
data delete |
レコードを削除する |
data describe |
エンティティのスキーマについて説明する |
data disassociate |
2 つのレコード間のリレーションシップを削除する |
data get |
ID または代替キーで 1 つのレコードを取得する |
data query |
OData、FetchXML、または SQL クエリを実行する |
data update |
既存のレコードを更新 |
data upload |
既存のレコードのファイル列にファイルをアップロードする |
data upsert |
代替キーを使用してレコードを作成または更新する |
erp batch cancel |
Finance and Operations バッチ ジョブを取り消す |
erp batch list |
Finance と Operations のバッチ ジョブを一覧表示する |
install |
特定のバージョンをインストールするか、最新バージョンに更新する |
mcp |
Dataverse または ERP 用の MCP サーバーを起動する |
mcp allow |
MCP クライアントとしてアプリを許可する |
org list |
アクセス可能なすべての環境を一覧表示する |
org who |
現在の組織とユーザー情報を表示する |
skill delete |
Dataverse からスキルを削除する |
skill download |
Dataverse からスキルをダウンロードする |
skill list |
環境内のアクティブなスキルを一覧表示する |
skill upload |
スキルを Dataverse にアップロードする |
Note
多くのコマンドでは、Dataverse (既定) またはリンクされた Finance and Operations (ERP) 環境に操作をルーティングする --target <dataverse\|erp> オプションがサポートされています。 環境に接続するコマンドは、現在のプロファイルの環境 URL をオーバーライドする --environment <url> (-env) オプションをサポートします。
api describe コマンド
1 つの API のメタデータを表示します。 Dataverse カスタム API の場合、メタデータによって提供される要求パラメーターと応答プロパティの説明が出力に含まれます。
既定では、データバース名は前置されません。 ERP 修飾名は、 erp:ServiceGroup/Service/Operationの形式で使用できます。
api describe パラメーター
| Parameter | Description |
|---|---|
--target |
dataverseまたはerpに対して修飾されていない名前を解決します。 |
--service-group |
ERP のみ。 操作参照を 1 つのサービス グループに絞り込みます。 |
--service |
ERP のみ。 操作参照を 1 つのサービスに絞り込みます。 |
--environment |
Dataverse 環境の URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
api describe の例
dataverse api describe sample_CustomAPIExample
dataverse api describe msdyn_DoesKBExist
dataverse api describe GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService
api invoke コマンド
検出された API を名前で呼び出します。 パラメーター name=value 構文を使用します。 値にスペースが含まれている場合は、トークン全体を引用符で囲みます。 一部の Dataverse API は、内容自体が JSON である文字列パラメーターを受け入れます。 その場合は、シェルの通常の引用符とエスケープルールを使用して、JSON テキストを値として渡します。
既定では、JSON 応答は、出力プロパティ名を保持するわかりやすいテキスト形式でレンダリングされます。
--jsonを使用して、生の JSON ペイロードを保持します。
api invoke パラメーター
| Parameter | Description |
|---|---|
--target |
dataverseまたはerpに対して修飾されていない名前を解決します。 |
--service-group |
ERP のみ。 操作参照を 1 つのサービス グループに絞り込みます。 |
--service |
ERP のみ。 操作参照を 1 つのサービスに絞り込みます。 |
--param |
フォームに名前付きパラメーター name=value 追加します。 再現。 |
--bind |
エンティティ バインド Dataverse API のバインド パス。 |
--method、-X |
推論された HTTP メソッドをオーバーライドします。 |
--body |
名前付きパラメーターの代わりに生の JSON 本文を使用します。 |
--body-file |
ファイルから生の JSON 本文を読み取る。 |
--header、-H |
フォームに HTTP ヘッダー key:value 追加します。 |
--include、-i |
応答の状態とヘッダーを含めます。 |
--environment |
Dataverse 環境の URL をオーバーライドします。 |
--json |
わかりやすいテキストではなく生の JSON を出力します。 |
api invoke の例
Dataverse 関数を呼び出します。 この例では、Dynamics 365 Contact Center CCaaS_GetPresence関数の使用を示します。
dataverse api invoke CCaaS_GetPresence ApiVersion=1.0
パラメーター値にスペースを含む Dataverse AISummarize アクション を呼び出します。
dataverse api invoke AISummarize "Text=The customer reported intermittent login failures..."
ERP カスタム サービスを呼び出す:
dataverse api invoke GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService
api list コマンド
Dataverse カスタム API や ERP の発行可能なサービス エンドポイントなど、検出可能な API を一覧表示します。 結果には、API ID、フレンドリ名、種類、説明 (使用可能な場合) が表示されます。 オプションのクエリ用語を渡して、結果をフィルター処理できます。
api list パラメーター
| Parameter | Description |
|---|---|
--target |
検索するターゲット システム: dataverse (既定) または erp。 |
--service-group |
ERP のみ。 1 つのサービス グループにフィルターを適用します。 |
--service |
ERP のみ。 1 つのサービスにフィルター処理します。 |
--limit |
返される API の最大数。 既定値: 50。 |
--page |
結果をページングするときの 1 から始まるページ番号。 既定値: 1。 |
--environment |
Dataverse 環境の URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
api list の例
dataverse api list
dataverse api list invoice --target dataverse
dataverse api list --target erp GetUserSessionInfo
dataverse api list --target erp --service-group UserSessionService --service AifUserSessionService
api request コマンド
未加工の認証済み HTTP 要求を Dataverse または ERP に送信します。 パス、メソッド、ヘッダー、および本文を完全に制御する必要がある場合は、このコマンドを使用します。
api request パラメーター
| Parameter | Description |
|---|---|
--target |
ターゲット システム: dataverse または erp。 必須です。 |
--path |
要求パス。 必須です。 |
--method、-X |
HTTP メソッド。 既定値: GET、または本文が指定されたときに POST 。 |
--body |
インライン JSON 要求本文。 |
--body-file |
JSON オブジェクト要求本文を含むファイル。 |
--header、-H |
フォームに HTTP ヘッダー key:value 追加します。 |
--include、-i |
応答の状態とヘッダーを含めます。 |
--environment |
Dataverse 環境の URL をオーバーライドします。 |
api request の例
dataverse api request --target dataverse --path /api/data/v9.2/sample_CustomAPIExample --body "{\"Input\":\"value\"}"
dataverse api request --target erp --path /api/services/UserSessionService/AifUserSessionService/GetUserSessionInfo --body "{}"
auth create コマンド
新しい認証プロファイルを作成します。
auth create パラメーター
これらのパラメーターを使用して、 auth create コマンドの動作を指定します。
| Parameter | Description |
|---|---|
--environment、-env |
認証する Dataverse 環境の URL。 |
--name、-n |
プロファイルの省略可能な名前。 後でプロファイルを選択するには、名前を使用します。 |
--cloud、-ci |
ターゲット クラウド: Public、 UsGov、 UsGovHigh、 UsGovDod、または China。 |
--deviceCode、-dc |
ブラウザーのない環境では、デバイス コード認証フローを使用します。 |
--username、-un |
ユーザー名とパスワード認証のユーザー名。 |
--password、-p |
ユーザー名とパスワード認証のパスワード。 |
--applicationId、-id |
サービス プリンシパル (SPN) 認証のアプリケーション (クライアント) ID。 |
--clientSecret、-cs |
サービス プリンシパル認証のクライアント シークレット。 |
--certificateDiskPath、-cdp |
証明書ベースの認証用の .pfx 証明書ファイルへのパス。 |
--certificatePassword、-cp |
証明書のパスワードです。 |
--tenant、-t |
テナント ID。 サービス プリンシパル認証に必要です。 |
--managedIdentity、-mi |
Azureマネージド ID を使用します。 |
--githubFederated、-ghf |
フェデレーション認証GitHub Actions使用します。 |
--azureDevOpsFederated、-adof |
フェデレーション認証Azure DevOps使用します。 |
--clientid、-cid |
既定の Dataverse CLI アプリの代わりに使用するカスタム Microsoft Entra アプリ クライアント ID。 |
--no-default-environment |
環境を既定として設定しないでください。 |
--accept-cleartext-caching |
Linux でプレーンテキスト トークン キャッシュを許可します。 |
auth create の例
次の例では、 auth create コマンドの使用方法を示します。
対話型認証
このコマンドを実行すると、ブラウザーまたはシステム ダイアログが開き、追加情報が表示されます。
dataverse auth create --environment https://myorg.crm.dynamics.com
名前付きプロファイル
特定の名前のプロファイルを作成します。
dataverse auth create --environment https://myorg.crm.dynamics.com --name prod
デバイス コード フロー
ブラウザーを使用しない環境では、デバイス コード フローを使用します。
dataverse auth create --environment https://myorg.crm.dynamics.com --deviceCode
クライアント シークレットを含むサービス プリンシパル
CI/CD パイプラインや対話型サインインができない別の自動スクリプトなど、無人認証が必要な場合は、サービス プリンシパルを使用します。 環境にアクセスできるアプリ登録のアプリケーション ID、クライアント シークレット、テナント ID を指定します。
dataverse auth create --applicationId <appId> --clientSecret <secret> --tenant <tenantId>
カスタム Entra アプリ クライアント ID
既定ではなく、独自のアプリ登録を使用します。
dataverse auth create --environment https://myorg.crm.dynamics.com --clientid <your-app-guid>
auth list コマンド
すべての認証プロファイルを一覧表示します。 生の JSON 出力の --json を追加します。
auth list の例
dataverse auth list
dataverse auth list --json
auth remove コマンド
1 つまたはすべての認証プロファイルを削除します。
auth remove パラメーター
| Parameter | Description |
|---|---|
--index、-i |
auth listに示すように、指定した 1 ベースのインデックスを持つプロファイルを削除します。 |
--name、-n |
指定した名前のプロファイルを削除します。 |
--all |
すべてのプロファイルを削除します。 |
auth remove の例
dataverse auth remove --index 1
dataverse auth remove --name prod
dataverse auth remove --all
auth select コマンド
アクティブな認証プロファイルを選択します。 オプションを指定せずにコマンドを実行して、すべてのプロファイルを一覧表示します。
auth select パラメーター
| Parameter | Description |
|---|---|
--index、-i |
auth listに示すように、プロファイルを 1 ベースのインデックスで選択します。 |
--name、-n |
名前でプロファイルを選択します。 |
auth select の例
対話型ピッカーを開きます。 方向キーを使用するか、次のように入力してフィルター処理します。
dataverse auth select
インデックスまたは名前でプロファイルを選択します。
dataverse auth select --index 1
dataverse auth select --name prod
auth who コマンド
現在アクティブな認証プロファイルを表示します。 生の JSON 出力の --json を追加します。
auth who の例
dataverse auth who
dataverse auth who --json
data associate コマンド
ナビゲーション プロパティ (リレーションシップ) を使用して 2 つのレコードを関連付けます。 このコマンドは、Dataverse でのみサポートされています。
data associate パラメーター
| Parameter | Description |
|---|---|
--table、-t |
プライマリ レコードのエンティティ セット名。 必須です。 |
--id、-i |
プライマリ レコードの GUID。 必須です。 |
--relationship、-rel |
ナビゲーション プロパティ名。 必須です。 |
--related |
関連テーブルのエンティティ セット名。 必須です。 |
--related-id |
関連レコードの GUID。 必須です。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data associate の例
dataverse data associate --table accounts --id <guid> --relationship contact_customer_accounts --related contacts --related-id <related-guid>
data count コマンド
必要に応じてフィルター処理されたテーブル内のレコードをカウントします。
data count パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。
--fetchxmlを使用しない場合は必須です。 |
--filter、-f |
OData $filter 式。 |
--fetchxml |
複雑なカウントに対する FetchXML 集計クエリ。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--cross-company |
ERP のみ。 すべての企業に対してカウントします。 既定値: ユーザーの既定の会社。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data count の例
dataverse data count --table accounts
dataverse data count --target erp --table Currencies --filter "CurrencyCode eq 'AED'"
data create コマンド
Dataverse テーブルに新しいレコードを作成します。
@odata.bind構文を使用して参照列を設定します。
data create パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。 必須です。 |
--data、-d |
フィールド値を含む JSON オブジェクト。 |
--data-file |
レコード データを含む JSON ファイルへのパス。 |
--return、-r |
作成された完全なレコードを返します。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data create の例
dataverse data create --table accounts --data '{"name":"Contoso"}'
dataverse data create --table contacts --data '{"firstname":"Alice","parentcustomerid_account@odata.bind":"accounts(<guid>)"}'
Tip
複雑な JSON には --data-file を使用します。
--return --jsonを使用して、作成されたレコード全体を取得します。
data delete コマンド
1 つのレコードを主キーまたは代替キーで削除します。
data delete パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。 必須です。 |
--id、-i |
レコード GUID。 |
--key、-k |
代替キー。 |
--no-confirm |
確認プロンプトをスキップします。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data delete の例
dataverse data delete --table accounts --id 00000000-0000-0000-0000-000000000001 --no-confirm
data describe コマンド
OData エンティティのスキーマについて説明します。 Dataverse の場合、コマンドは--includeによって駆動される$expandを使用してEntityDefinitions(LogicalName='<table>')を呼び出し、--include actionsが設定されたときにcustomapisする 2 番目の呼び出しを呼び出します。
AssignやSetStateなどの組み込みの Dataverse アクションは列挙されません。 ERP の場合、 /Metadata/PublicEntities を 1 回呼び出すと、プロパティ、バインドされたアクション、ナビゲーションが一緒に返されます。
data describe パラメーター
| Parameter | Description |
|---|---|
--target |
ターゲット: dataverse (既定) または erp。 |
--table、-t |
必須です。 Dataverse の場合、論理名 ( accountなど)。 ERP の場合、エンティティ セット名 ( BatchJobsなど)。 |
--include |
entity、properties、relations、actions、allなど、セクションのコンマ区切りのリスト。 エイリアス: attributes=properties、 relationships=relations。 ERP の既定値: all。 Dataverse の既定値: entity,properties。 |
--json |
生の JSON を出力します。 |
data describe の例
dataverse data describe --table account
dataverse data describe --target dataverse --table account --include all
dataverse data describe --target erp --table BatchJobs
data disassociate コマンド
2 つのレコード間のリレーションシップを削除します。 このコマンドは、Dataverse でのみサポートされています。
data disassociate パラメーター
| Parameter | Description |
|---|---|
--table、-t |
プライマリ レコードのエンティティ セット名。 必須です。 |
--id、-i |
プライマリ レコードの GUID。 必須です。 |
--relationship、-rel |
ナビゲーション プロパティ名。 必須です。 |
--related-id |
多対多リレーションシップの関連レコードの GUID。 ルックアップをクリアするには、このパラメーターを省略します。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data disassociate の例
dataverse data disassociate --table accounts --id <guid> --relationship contact_customer_accounts --related-id <related-guid>
data get コマンド
ID (主キー) または代替キーによって 1 つのレコードを取得します。
data get パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。 必須です。 |
--id、-i |
レコード GUID (主キー)。 |
--key、-k |
代替キー ( "col='val'"など)。 |
--select、-s |
列のコンマ区切りリスト ($select)。 |
--expand、-x |
関連レコードの OData $expand 式。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data get の例
dataverse data get --table accounts --id 00000000-0000-0000-0000-000000000001
dataverse data get --target erp --table Currencies --key "CurrencyCode='AED'" --select "CurrencyCode,Name"
data query コマンド
Dataverse テーブルに対して OData、FetchXML、または SQL クエリを実行します。
data query パラメーター
| Parameter | Description |
|---|---|
--table、-t |
クエリを実行するエンティティ セット名。 OData クエリに必要です。 |
--select、-s |
列のコンマ区切りリスト ($select)。 |
--filter、-f |
OData $filter 式。 |
--orderby、-o |
OData $orderby 式。 |
--top |
返されるレコードの最大数 (1 ~ 5000)。 |
--expand、-x |
関連レコードの OData $expand 式。 |
--fetchxml |
インライン FetchXML クエリ。 |
--fetchxml-file |
FetchXML クエリを含むファイルへのパス。 |
--sql |
SQL SELECT クエリ (プレビュー)。 |
--sql-file |
SQL クエリを含むファイルへのパス。 |
--all、-a |
改ページ位置に従ってすべてのレコードを取得します。 |
--max-records |
--allを使用するときに取得するレコードの最大数。 既定値: 100000。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--cross-company |
ERP のみ。 すべての企業に対してクエリを実行します。 既定値: ユーザーの既定の会社。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data query の例
dataverse data query --table accounts --select "name,revenue" --filter "revenue gt 1000000"
dataverse data query --fetchxml "<fetch><entity name='account'><attribute name='name'/></entity></fetch>"
dataverse data query --sql "SELECT name, revenue FROM account WHERE revenue > 1000000"
dataverse data query --target erp --table Currencies --select "CurrencyCode,Name" --top 10
詳細情報
- OData を使用してデータのクエリを実行する
- Dataverse で FetchXML を使用してデータのクエリを実行する
- SQL を使用して Dataverse Web API を使用してデータにクエリを実行する
data update コマンド
既存のレコードの 1 つ以上のフィールドを、その ID または代替キーで識別して更新します。
@odata.bind構文を使用して参照列を設定します。
data update パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。 必須です。 |
--id、-i |
レコード GUID。 |
--key、-k |
代替キー。 |
--data、-d |
更新するフィールドを含む JSON オブジェクト。 |
--data-file |
更新データを含む JSON ファイルへのパス。 |
--return、-r |
更新されたレコード全体を返します。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data update の例
dataverse data update --table accounts --id 00000000-0000-0000-0000-000000000001 --data '{"name":"Contoso (updated)"}'
data upload コマンド
既存のレコードの Dataverse ファイル列にローカル ファイルをアップロードします。 このコマンドは、 --modeを指定しない限り、ファイル サイズに基づいて単一要求またはチャンク アップロードを自動的に選択します。 自動モードでは、128 MB 未満のファイルは 1 つの要求でアップロードされ、大きいファイルではチャンク アップロードが使用されます。
--mime-typeを省略すると、ファイル拡張子から MIME の種類が推測されます。 不明な拡張機能は、既定で application/octet-streamされます。
data upload パラメーター
| Parameter | Description |
|---|---|
--table、-t |
テーブル スキーマまたは論理名 ( accountなど)。 必須です。 このコマンドは、メタデータからエンティティ セットを解決します。 |
--id、-i |
レコード GUID。 必須です。 |
--column、-c |
ファイル列の属性名。 必須です。 |
--file、-f |
ローカル ファイルへのパス。 必須です。 |
--mode、-m |
アップロード戦略: auto (既定)、 small、または chunk。 |
--mime-type |
明示的な MIME の種類。 既定値: ファイル拡張子から推論されます。 |
--overwrite |
既存のファイルを上書きします。 既定では、列が空でない場合、コマンドは失敗します。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data upload の例
dataverse data upload --table account --id <guid> --column new_document --file report.pdf
dataverse data upload -t account -i <guid> -c new_document -f photo.jpg --overwrite
dataverse data upload -t account -i <guid> -c new_document -f big.bin --mode chunk
data upsert コマンド
存在しない場合はレコードを作成し、存在する場合は更新します。 レコードは代替キーによって識別されます。 代替キーを使用してレコードを参照する方法について説明します
data upsert パラメーター
| Parameter | Description |
|---|---|
--table、-t |
エンティティ セット名。 必須です。 |
--key、-k |
代替キー。 必須です。 |
--data、-d |
フィールド値を含む JSON オブジェクト。 |
--data-file |
JSON ファイルへのパス。 |
--update-only |
レコードが存在しない場合は失敗します (If-Match: *)。 |
--create-only |
レコードが既に存在する場合は失敗します (If-None-Match: *)。 |
--return、-r |
操作の後に完全なレコードを返します。 |
--target |
dataverse (既定) またはリンクされたerp環境にルーティングします。 |
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
data upsert の例
dataverse data upsert --table accounts --key "accountnumber='ACC-100'" --data '{"name":"Contoso"}'
erp batch cancel コマンド
RecIdで Finance and Operations バッチ ジョブを取り消します。
erp batch listを使用してRecIdを見つけます。
erp batch cancel の例
dataverse erp batch cancel <recid>
erp batch list コマンド
Dataverse 環境にリンクされている Finance and Operations インスタンスでバッチ ジョブを一覧表示します。 このコマンドには、Finance and Operations インスタンスがリンクされた Dataverse 環境に接続された認証プロファイルが必要です。 Finance and Operations URL は、現在の Dataverse 接続から自動的に派生します。
erp batch list パラメーター
| Parameter | Description |
|---|---|
--company |
USMFなど、法人 (dataAreaId) でフィルター処理します。 |
--status |
状態でフィルター処理する: Waiting、 Executing、 Finished、 Error、または Cancelled。 |
--top |
返される結果の最大数。 既定値: 20。 |
--caption |
キャプションでフィルター処理します (大文字と小文字を区別しない部分文字列の一致)。 |
--json |
生の JSON を出力します。 |
erp batch list の例
dataverse erp batch list
dataverse erp batch list --status Waiting
dataverse erp batch list --status Executing --top 20
install コマンド
特定のバージョンの Dataverse CLI をインストールするか、最新バージョンに更新します。 このコマンドは、CLI をグローバルにインストールしたか、 npx を使用しているかを検出し、それに応じてインストールします。
install の例
最新バージョンをインストールする:
dataverse install latest
特定のバージョンをインストールします。
dataverse install 1.0.0
mcp コマンド
Claude Desktop などの AI アシスタントがデータを操作できるように、環境に接続するモデル コンテキスト プロトコル (MCP) サーバーを起動します。 ターゲットは URL から自動検出されます。Dataverse URL は Dataverse MCP サーバーを起動し、Finance and Operations URL ( https://myorg.operations.dynamics.com など) は ERP MCP サーバーを起動します。
mcp の構文
dataverse mcp <orgUrl> [options]
<orgUrl>引数は、組織の URL (https://myorg.crm.dynamics.comなど) です。
mcp パラメーター
| Parameter | Description |
|---|---|
--validate |
サーバーを起動せずに、MCP エンドポイントと認証のセットアップを検証します。 |
--log-level |
ログ 記録レベル ( Trace、 Debug、 Information、 Warning、 Error、または Critical) を設定します。 既定値: Warning。 |
--log-file |
一時ディレクトリ内のファイルにログを記録します。 |
--preview |
プレビュー MCP エンドポイント (api/mcpではなくapi/mcp_preview) を使用します。 ERP ではサポートされていません。 |
mcp の例
セットアップを検証します (推奨される最初の手順)。
dataverse mcp https://myorg.crm.dynamics.com --validate
stdio トランスポートを使用してサーバーを起動します。
dataverse mcp https://myorg.crm.dynamics.com
プレビュー エンドポイントを使用するか、デバッグ ファイルのログ記録を有効にします。
dataverse mcp https://myorg.crm.dynamics.com --preview
dataverse mcp https://myorg.crm.dynamics.com --log-level Debug --log-file
mcp allow コマンド
Microsoft Entra アプリケーションが、現在のプロファイルの環境の Dataverse MCP 許可クライアントの一覧にあることを確認します。 このコマンドは、前提条件で説明されている手動管理手順の代わりに使用 できます。 認証されたユーザーには、ターゲット環境に対する Dataverse 管理者アクセス許可が必要です。
mcp allow の構文
dataverse mcp allow <appId> [options]
<appId>引数は、GUID として許可するアプリケーション (クライアント) ID です。
mcp allow パラメーター
| Parameter | Description |
|---|---|
--erp |
Dataverse ではなく、リンクされた Finance and Operations インスタンスでアプリケーションを許可します。 |
mcp allow の例
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457 --erp
Note
Finance and Operations では許可リストが AOS にキャッシュされるため、新しく許可されたアプリ ID が有効になるまでに最大で約 5 分かかることがあります。
org list コマンド
アクセスできるすべての環境を一覧表示します。
org list パラメーター
| Parameter | Description |
|---|---|
--filter |
検索語句で環境の一覧をフィルター処理します。 |
--json |
生の JSON を出力します。 |
org list の例
dataverse org list
dataverse org list --filter contoso
dataverse org list --json
org who コマンド
アクティブな認証プロファイルを使用して、現在の組織とユーザーに関する情報を表示します。
env コマンドは、orgのエイリアスです。
org who パラメーター
| Parameter | Description |
|---|---|
--environment、-env |
環境 URL をオーバーライドします。 |
--json |
生の JSON を出力します。 |
org who の例
dataverse org who
dataverse org who --environment https://myorg.crm.dynamics.com
dataverse org who --json
skill コマンド
接続環境に格納されている Dataverse スキル (AI エージェントが使用する再利用可能な命令セット ( SKILL.md ファイルとそのリソース ファイル) を管理します。 最上位 skill コマンドは、環境に対する作成、読み取り、更新、および削除操作を提供します。 ローカルでは、スキルは .claude/skills/<name>/の下に格納されます。
Note
スキルの作成と評価のコマンド ( make、 update、 get、 evalなど) は、これらのコマンドとは別です。 詳細を確認するには、dataverse workspace skill --help を実行してください。
skill delete コマンド
アクティブな Dataverse 環境からスキルとそのすべてのリソースを削除します。
skill listを使用してスキルの一意の名前を検索します。
dataverse skill delete new_lead-qualification
skill download コマンド
アクティブな Dataverse 環境からディスクに 1 つ以上のスキルをダウンロードします。 このコマンドは、ディレクトリ構造を維持しながら、 SKILL.md ファイルとすべてのリソース ファイルをダウンロードします。
skill listを使用してスキルの一意の名前を検索します。
| Parameter | Description |
|---|---|
--all |
環境からアクティブなすべてのスキルをダウンロードします。 スキルの一意の名前と組み合わせることはできません。 |
--output、-o |
出力のベース ディレクトリ。 既定値: .claude/skills/。
--allでは、各スキルは<path>/<name>/に書き込まれます。 |
--json |
ファイルを書き込まずに、スキルの内容を JSON として出力します。 必要に応じて、書き込み対象のファイル パスを指定します。 |
dataverse skill download new_lead-qualification
dataverse skill download --all --output ./skills
skill list コマンド
接続された Dataverse 環境でアクティブなすべてのスキルを一覧表示します。
| Parameter | Description |
|---|---|
--resources、-r |
各スキルのリソース ファイルも一覧表示します。 |
--json |
JSON として出力します。 必要に応じて、書き込み対象のファイル パスを指定します。 |
dataverse skill list
dataverse skill list --resources
skill upload コマンド
ディスクからアクティブな Dataverse 環境に 1 つ以上のスキルをアップロードします。 このコマンドは、ディレクトリ、 .zip ファイル、 .skill ファイル、 および .md ファイルをサポートします。
.claude/skills/<name>/に解決されるスキル <name>、またはディレクトリまたはファイルに明示的な<path>を渡すことができます。
| Parameter | Description |
|---|---|
--all |
.claude/skills/のすべてのスキルをアップロードします。 スキル名またはパスと組み合わせることはできません。 |
--json |
結果を JSON として出力します。 必要に応じて、書き込み対象のファイル パスを指定します。 |
dataverse skill upload lead-qualification
dataverse skill upload ./my-skill.zip
dataverse skill upload --all