[この記事はプレリリース ドキュメントであり、変更される可能性があります。]
Copilot マネージド ランタイム CLI は @microsoft/managed-apps-cli として発行され、 ms として呼び出されます。
ほとんどのコマンドは、現在のディレクトリ内のアプリで動作し、ローカル構成 (アプリ名、環境、リポジトリ バインディング) から既定値を読み取ります。 フラグによって別のアプリをターゲットにすることが明示的に許可されている場合を除き、アプリが含まれているディレクトリからコマンドを実行するようにしてください。
このリファレンスは、一般的な開発者ワークフロー タスクによってすべてのコマンドをグループ化しています。
| グループ | コマンド | 説明 |
|---|---|---|
| 認証 | ms auth login |
ブラウザーから Microsoft Entra ID にサインインします。 |
| 認証 | ms auth logout |
キャッシュされた資格情報をクリアし、アクティブなアカウント ポインターを削除します。 |
| 認証 | ms auth status |
キャッシュされたアカウントを一覧表示し、アクティブなアカウントを指定します。 |
| 認証 | ms auth switch |
別のキャッシュ アカウントをアクティブにします。 |
| 認証 | ms git auth refresh |
Entra から GitHub への ID マッピングを更新または確立します。 |
| アプリを作成する | ms app create |
新しいアプリを作成し、プロジェクト テンプレートをスキャフォールディングします。 |
| アプリを作成する | ms app clone |
既存のアプリのプラットフォーム管理 Git リポジトリを複製します。 |
| アプリを作成する | ms app init |
既存の Web プロジェクトをアプリとして登録します。 |
| コネクタを検出する | ms connector list |
環境で使用可能なコネクタを一覧表示します。 |
| コネクタを検出する | ms connector list-actions |
コネクタによって公開される一覧表示操作。 |
| アプリ リソースの管理 | ms app add data-source |
コネクタをテーブルまたはアクション データ ソースとしてアプリに追加します。 |
| アプリ リソースの管理 | ms app remove data-source |
以前に追加したデータ ソース (テーブルまたはアクション) をアプリから削除します。 |
| アプリ リソースの管理 | ms app refresh data-source |
スキーマを再フェッチし、バインドされたデータ ソースの TypeScript を再生成します。 |
| ローカルで開発する | ms app dev |
完全なローカル開発ループを開始します。 |
| ビルドとデプロイ | ms app pack |
アプリをローカルでビルドし、検査のために出力をステージングします。 |
| ビルドとデプロイ | ms app build |
特定のコミットのプラットフォーム ビルドをトリガーします。 |
| ビルドとデプロイ | ms app build-status |
ビルドの状態を確認します。 |
| ビルドとデプロイ | ms app deploy |
グリーン ビルドをライブ アプリに昇格します。 |
| Play | ms app play |
アプリを開き、その起動 URL を印刷します。 |
| 共有 | ms app share |
ユーザーまたはグループにアクセス権を付与します。 |
| 共有 | ms app share list |
アプリが共有されているユーザーとグループを一覧表示します。 |
| 共有 | ms app unshare |
以前に許可されたアクセス権を取り消します。 |
| 共有 | ms app share link create |
アプリのテナント全体の共有リンクを作成します。 |
| 共有 | ms app share link list |
アプリに対して発行された共有リンクを一覧表示します。 |
| 共有 | ms app share link revoke |
ID で共有リンクを取り消します。 |
| 検査と管理 | ms app list |
アクセスできる環境内のアプリを一覧表示します。 |
| 検査と管理 | ms app show |
ローカル アプリの構成とバインドされたリソースを表示します。 |
| 検査と管理 | ms app info |
アプリのサーバー側の状態を表示します。 |
| 検査と管理 | ms app get-settings |
すべてのアプリ設定とその現在の値を表示します。 |
| 検査と管理 | ms app set-setting |
1 つ以上のアプリ設定を更新します。 |
| 検査と管理 | ms app delete |
環境からアプリを削除します。 |
| テレメトリ | ms telemetry enable |
テレメトリ コレクションをオンにします。 |
| テレメトリ | ms telemetry disable |
テレメトリ コレクションをオフにします。 |
| テレメトリ | ms telemetry status |
現在のテレメトリ設定を表示します。 |
コマンド インデックス
次の表に、コマンドをアルファベット順に示します。
| command | Group | 説明 |
|---|---|---|
ms app add data-source |
アプリ リソースの管理 | コネクタをテーブルまたはアクション データ ソースとしてアプリに追加します。 |
ms app build |
ビルドとデプロイ | 特定のコミットのプラットフォーム ビルドをトリガーします。 |
ms app build-status |
ビルドとデプロイ | ビルドの状態を確認します。 |
ms app clone |
アプリを作成する | 既存のアプリのプラットフォーム管理 Git リポジトリを複製します。 |
ms app create |
アプリを作成する | 新しいアプリを作成し、プロジェクト テンプレートをスキャフォールディングします。 |
ms app delete |
検査と管理 | 環境からアプリを削除します。 |
ms app deploy |
ビルドとデプロイ | グリーン ビルドをライブ アプリに昇格します。 |
ms app dev |
ローカルで開発する | 完全なローカル開発ループを開始します。 |
ms app get-settings |
検査と管理 | すべてのアプリ設定とその現在の値を表示します。 |
ms app info |
検査と管理 | アプリのサーバー側の状態を表示します。 |
ms app init |
アプリを作成する | 既存の Web プロジェクトをアプリとして登録します。 |
ms app list |
検査と管理 | アクセスできる環境内のアプリを一覧表示します。 |
ms app pack |
ビルドとデプロイ | アプリをローカルでビルドし、検査のために出力をステージングします。 |
ms app play |
Play | アプリを開き、その起動 URL を印刷します。 |
ms app refresh data-source |
アプリ リソースの管理 | スキーマを再フェッチし、バインドされたデータ ソースの TypeScript を再生成します。 |
ms app remove data-source |
アプリ リソースの管理 | 以前に追加したデータ ソース (テーブルまたはアクション) をアプリから削除します。 |
ms app set-setting |
検査と管理 | 1 つ以上のアプリ設定を更新します。 |
ms app share |
共有 | ユーザーまたはグループにアクセス権を付与します。 |
ms app share list |
共有 | アプリが共有されているユーザーとグループを一覧表示します。 |
ms app share link create |
共有 | アプリのテナント全体の共有リンクを作成します。 |
ms app share link list |
共有 | アプリに対して発行された共有リンクを一覧表示します。 |
ms app share link revoke |
共有 | ID で共有リンクを取り消します。 |
ms app show |
検査と管理 | ローカル アプリの構成とバインドされたリソースを表示します。 |
ms app unshare |
共有 | 以前に許可されたアクセス権を取り消します。 |
ms auth login |
認証 | ブラウザーから Microsoft Entra ID にサインインします。 |
ms auth logout |
認証 | キャッシュされた資格情報をクリアし、アクティブなアカウント ポインターを削除します。 |
ms auth status |
認証 | キャッシュされたアカウントを一覧表示し、アクティブなアカウントを指定します。 |
ms auth switch |
認証 | 別のキャッシュ アカウントをアクティブにします。 |
ms connector list |
コネクタを検出する | 環境で使用可能なコネクタを一覧表示します。 |
ms connector list-actions |
コネクタを検出する | コネクタによって公開される一覧表示操作。 |
ms git auth refresh |
認証 | Entra から GitHub への ID マッピングを更新または確立します。 |
ms telemetry disable |
テレメトリ | テレメトリ コレクションをオフにします。 |
ms telemetry enable |
テレメトリ | テレメトリ コレクションをオンにします。 |
ms telemetry status |
テレメトリ | 現在のテレメトリ設定を表示します。 |
グローバル フラグ
すべてのコマンドは、次のフラグを受け入れます。
| Flag | Alias | 必須 | 説明 |
|---|---|---|---|
--json |
いいえ | 結果を単一の JSON オブジェクト (またはストリーミング コマンドの場合は NDJSON) として出力します。 これをスクリプトと CI で使用します。 | |
--non-interactive |
不要 | プロンプトなしで実行します。 必要な値はすべて、フラグまたは環境変数で指定する必要があります。 これをスクリプトと CI で使用します。 | |
--no-color |
不要 | カラー出力を無効にします。 | |
--cloud <cloud> |
不要 | ターゲットとするクラウド環境。 有効な値は、 public (既定値)、 usgov、 usgovhigh、 usgovdod、および china です。 |
|
--version |
-v |
不要 | CLI バージョンを出力します。 |
--help |
-h |
不要 | 使用可能なすべてのフラグを含むコマンドのヘルプを表示します。 |
ヒント
グループ化された最上位ヘルプ、アプリ サブコマンドms app、および動詞のフラグのms app <verb> --helpの引数を指定せずにmsを実行します。 能力は、穴を開けるにつれて徐々に表面化します。
認証
マシンごとに 1 回サインインします。 他のすべてのコマンドは、Copilot マネージド ランタイムが有効なテナントに対する認証セッションを想定しています。
ms auth login
ブラウザーから Microsoft Entra ID にサインインします。 新しいアカウントをキャッシュに追加してアクティブにします。
ms auth login [--account <email>]
ms auth login
account パラメーター
選択したアカウントとしてログインを試みます。複数アカウントのシナリオに役立ちます。 既にキャッシュされているアカウントの中から選択するには、代わりに ms auth switch を使用します。
ms auth logout
すべてのキャッシュされた資格情報をクリアし、アクティブなアカウント ポインターを削除します。
ms auth logout
サインアウトせずにアクティブなアカウントを変更するには、 ms auth switch を使用します。
ms auth status
キャッシュされたアカウントを一覧表示します。 複数のアカウントがキャッシュされている場合、アクティブなアカウント (他のコマンドで使用されるアカウント) は * でマークされます。
ms auth status
ms auth switch
後続のコマンド用に別のキャッシュ アカウントをアクティブにします。
ms auth switch [--account <email>]
ms auth switch
account パラメーター
アクティブにするアカウント。 複数のキャッシュされたアカウントがある対話モードでは、このフラグが省略されると、CLI から選択を求めるメッセージが表示されます。 非対話モードで、および --json を使用する場合に必要です。
Git 認証
一部のコマンドでは、Microsoft Entra ID が、バインドされたリポジトリにアクセスできる GitHub ユーザーにマップされていることを確認する必要があります。 マッピングを初めて必要にするときは、 ms app create、 ms app build、 ms app deploy GitHub Device Code Flow をインラインで実行します。初回セットアップ時に事前に更新する必要はありません。
ms git auth refresh を使用して、明示的に再認証します (たとえば、GitHub アカウントを切り替える場合など)。
ms git auth refresh
GitHub Enterprise Cloud organization が所有するリポジトリの Microsoft Entra ↔ GitHub ID マッピングを更新または確立します。
ms git auth refresh --repo <url> [--open-browser]
このコマンドにより、ブラウザーに貼り付ける検証 URL とユーザー コードが出力されます。 成功すると、認証された GitHub ログインとマッピングの有効期限タイムスタンプが出力されます。
Ctrl+C キーを押して、ポーリング ループを完全にキャンセルします。
ms git auth refresh parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--repo |
-r |
はい | GitHub Enterprise Cloud organization が所有するリポジトリの完全な URL。 たとえば、https://contoso.ghe.com/contoso/my-app および https://github.com/contoso/my-app が禁止となります。 CLI は、URL にホスト (サインイン エンドポイントの派生に使用) を持っていることについて最小限のチェックのみを実行し、ホストまたはスキームのルール自体は適用しません。 プラットフォームは、ホストとプロバイダーがサポートされる機関です。 この値を設定しない場合、CLI は対話モードでプロンプトを表示します。 |
--open-browser |
不要 | ベストエフォート: 確認 URL を印刷するだけでなく、システム ブラウザーを起動します。 既定値は印刷のみです。 |
アプリを作成する
これらのコマンドを使用して、新しい Copilot ランタイム アプリを作成するか、既存のプロジェクトを登録します。
GitHub Enterprise Cloud でリポジトリの可視性とその他のリポジトリ管理ポリシーを構成します。 詳しくは、 企業でのリポジトリ管理ポリシーの強制を参照してください。
ms app create
新しいアプリを作成し、プロジェクト テンプレートをディレクトリにスキャフォールディングし、ソース管理を設定します。
ms app create --display-name <name> [directory] [options]
ms app create parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--display-name <name> |
-n | はい | アプリの表示名。 |
[directory] |
不要 | ターゲット ディレクトリ。 既定は現在のディレクトリです。 空にする必要があります。 | |
--environment-id <id> |
-e | 不要 | ターゲット環境。 省略した場合、CLI は開発環境を使用し、初回実行時に 1 つをプロビジョニングします。 |
--description <text> |
-d | 不要 | アプリ レコードに保存されたフリーテキストによる説明。 |
--template <name> |
-t | 不要 | GitHub リポジトリまたはアプリのスキャフォールド元のサブパス ( github:owner/repo/subdir など)。 既定では、組み込みの Vite テンプレートが使用されます。 すべての --repo モードに適用されます。 |
--repo <url> |
不要 | ソース管理バインド。 プラットフォーム管理 (GRS) Git (既定値) では省略します。 GitHub Enterprise Cloud organization (https://contoso.ghe.com/contoso/my-app や https://github.com/contoso/my-app など) が所有するリポジトリの完全な https:// URL を渡して、既存の空の外部 GitHub リポジトリを複製してバインドします。
noneを渡してすべての Git バインディングをスキップします (テンプレートをスキャフォールドし、ローカル リポジトリまたはリモートなしで ms.config.json のみ書き込みます)。
--repository-id と組み合わせることはできません。 |
|
--repository-id <id> |
-r | 不要 | ソース管理のためにアプリに関連付けるリポジトリ ID。
--repo と組み合わせることはできません。 |
--build-path <path> |
-b | 不要 | 出力ディレクトリをビルドします。 既定値は ./dist です。 |
--build-command <cmd> |
-S | 不要 | アプリのビルドに使用される完全なシェル コマンド。 既定値は npm run build です。 |
--build-entry-point <file> |
不要 | エントリ ポイントの HTML ファイル。 既定値は index.html です。 |
|
--open-browser |
不要 | ベストエフォート: デバイス コード フローの再認証が必要な場合は、システム ブラウザーを起動します。
--jsonには影響しません。 |
|
--force-reauth |
不要 | マッピングの有効期限が切れたかのように、保存されている GitHub マッピングをバイパスし、デバイス コード フローを強制します。 外部 GitHub リポジトリにバインドされているアプリにのみ影響します。 |
注:
-
--repo <url>の場合、CLI は外部 GitHub リポジトリをディレクトリに複製し、テンプレートをオーバーレイします。 リポジトリは存在し、空である必要があります。 -
--repo noneの場合、CLI はテンプレートをスキャフォールディングしてms.config.json書き込みを行いますが、ローカル Git リポジトリを初期化したり、リモートをバインドしたりすることはありません。 これにより、自分でビルドしてデプロイする外部アーティファクトデプロイ用のアプリが作成されます。 例については、「GitHub Actions を使用して Microsoft Copilot マネージド ランタイム アプリをデプロイする」を参照してください。 - GitHub マッピングが見つからないか期限切れの場合、
ms app createはデバイス コード フローを帯域内で実行し、1 回再試行します。
ms app init
スキャフォールディング ファイルを使用せずに、既存の Web プロジェクトをアプリとして登録します。
ms app init --display-name <name> [options]
ms app init parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--display-name <name> |
-n | はい | アプリの表示名。 |
--environment-id <id> |
-e | 不要 | ターゲット環境。 既定は、ユーザーの開発者環境です。 |
--description <text> |
-d | 不要 | フリーテキストによる説明。 |
--build-path <path> |
-b | 不要 | 出力ディレクトリをビルドします。 既定値は ./dist です。 |
--build-command <cmd> |
-S | 不要 | アプリのビルドに使用される完全なシェル コマンド。 既定値は npm run build です。 |
--build-entry-point <file> |
不要 | エントリ ポイントの HTML ファイル。 既定値は index.html です。 |
|
--repo <value> |
不要 | リポジトリの動作。 現在の Git セットアップを自動検出する (および対話モードでプロンプトを表示する) 省略します。
nativeを渡して、プラットフォーム管理 (GRS) リポジトリ、外部アーティファクト配置 (プラットフォーム管理リポジトリなし) のnone、またはリポジトリ URL を、既に現在のディレクトリにクローン作成された既存の GitHub リポジトリにバインドします。 |
|
--icon-path <path> |
不要 |
.png または .jpg アプリ アイコンへの省略可能なパスです。ms.config.jsonに iconPath として書き込まれます。 |
|
--local-app-url <url> |
不要 |
localAppUrlとして ms.config.json に書き込まれる、省略可能なローカル開発 URL。 |
|
--open-browser |
不要 | ベストエフォート: デバイス コード フロー中にシステム ブラウザーを起動します。
--jsonには影響しません。 |
|
--force-reauth |
不要 | 保存されている GitHub マッピングをバイパスし、最初の試行でデバイス コード フローを強制します。 破損したマッピングの回復に役立ちます。 |
注:
- 現在のディレクトリが既にアプリである場合は失敗します。
- テンプレート ファイルをスキャフォールディングしません。 ソース管理の動作は
--repoによって異なります (省略すると現在のディレクトリから自動的に検出されます)。 - 外部 GitHub ブランチの場合、
ms app createの場合と同じインライン デバイス コード フローの再認証が適用されます。
ms app clone
既存のアプリのプラットフォーム管理 Git リポジトリを複製し、将来のフェッチ操作とプッシュ操作のために Git 認証を構成します。
ms app clone --app <app-id> [directory]
ms app clone parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <app-id> |
はい | 編集アクセス権を持つアプリのアプリ ID。
ms app list --permission edit を使用してアプリ ID を見つけます。 |
|
[directory] |
不要 | 複製されたリポジトリのターゲット ディレクトリ。 省略した場合、CLI は現在のディレクトリーを使用します。これは空でなければなりません。 |
注:
ms app clone プラットフォームで管理される Git リポジトリをサポートします。 外部 GitHub または GitHub Enterprise Cloud リポジトリを使用するアプリの場合は、代わりに git clone <repository-url> を使用します。 ソース管理バインディングがないアプリを複製することはできません。
コネクタを検出する
次のコマンドを使用して、使用可能なコネクタを検索し、アプリに追加する前にその操作を調べます。
ms connector list
環境で使用可能なコネクタを一覧表示します。
ms connector list [--environment-id <id>] [--search <term>] [--include-blocked]
出力には、コネクタ ID、認証の種類、表形式のサポート フラグ、データ損失防止 (DLP) と高度なコネクタ ポリシー (ACP) の状態が含まれます。 デザイン時にガバナンス状態を確認することで、展開時または実行時にポリシーがブロックするコネクタに対してビルドすることを回避できます。
ms connector list parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--environment-id <id> |
-e | 不要 | クエリする環境。 既定値は ms.config.json (存在する場合) から。 |
--search <term> |
-s | 不要 | コネクタの表示名または ID に一致する部分文字列でフィルター処理します (大文字と小文字の区別なし)。 |
--include-blocked |
不要 | また、テナント ポリシーによってブロックされているコネクタも一覧表示します。 既定では、許可されたコネクタのみが表示されます。 |
ms connector list-actions
操作ごとの DLP 状態など、コネクタによって公開される操作を一覧表示します。
ms connector list-actions [--environment-id <id>] --connector <connector> [--search <term>]
ms connector list-actions parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--connector <connector> |
はい | ID による検査するコネクタ。 | |
--environment-id <id> |
-e | 不要 | クエリする環境。 既定値は ms.config.json (存在する場合) から。 |
--search <term> |
-s | 不要 | 操作の概要またはアクション ID の部分文字列の一致でフィルター処理します (大文字と小文字の区別なし)。 |
アプリ リソースの管理
次のコマンドを使用して、アプリが依存するデータ ソースを追加、削除、更新します。
アプリ リソースの追加
アプリが含まれているディレクトリからすべての add コマンドを実行します。 既定では、 generated/ で TypeScript モデルとサービスが生成されます。
ms app add data-source
コネクタをアプリに追加して、テーブルとアクションのデータ ソースを自動的に選択します。
ms app add data-source --connector <connector> [options]
注:
- CLI は、非表形式コネクタをアクションとして自動的に追加します。
- CLI は、表形式コネクタの対話モードではテーブルとアクションのどちらを求めるかを表示します。 非対話モードでは
--asを指定する必要があります。 - DLP と ACP プリフライトは、アクションまたはテーブルが追加される前に実行されます。 CLI は、ブロックされた操作をフィルター処理し、スキップされたカウントを報告します。
ms app add data-source parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--connector <connector> |
はい |
ms connector listから ID (shared_office365 など) や表示名で追加するコネクタ。 |
|
--as <mode> |
条件付き | 強制的に table または action ディスパッチします。 コネクタがテーブルをサポートしている場合、非対話モードで必要です。 |
|
--connection-id <id> |
-c | 不要 | 使用する既存の接続。 省略した場合、CLI によりプロンプトが表示されます。 |
--dataset <name> |
-d | 不要 | データセット ( --as table で使用)。 |
--table <name> |
-t | 不要 | 追加するテーブル ( --as tableと一緒に使用)。 Dataverse (shared_commondataserviceforapps) の場合、テーブルの論理名。 |
--dataverse-environment-id <guid> |
不要 | Dataverse 環境 ID。 特定のテーブルにバインドするために --connector shared_commondataserviceforapps でのみ使用されます。 |
|
--use-sso |
不要 | シングル サインオン (Entra ID) 接続を優先する: 最初の既存の SSO 接続を再利用するか、サイレントに作成します。 コネクタが SSO に対応していない場合はエラー。
--connection-id が指定されている場合は無視されます。 |
アプリ リソースを削除する
--force を渡さない限り、削除コマンドは確認を求めます。
ms app remove data-source
以前に追加したデータ ソース (テーブルまたはアクション) をアプリから削除します。
ms app remove data-source [--name <name>] [--force]
ms app remove data-source parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--name <name> |
-n | 不要 | 削除するデータ ソースの名前。 省略した場合、CLI はアプリのデータ ソースから選択するように求めるプロンプトを表示します。 |
--force |
-f | 不要 | 確認プロンプトをスキップします。 |
アプリ リソースの更新
生成されたアプリの種類を最新のソース スキーマの変更と同期するには、このコマンドを使用します。
ms app refresh data-source
スキーマを再フェッチし、バインドされたデータ ソースの TypeScript を再生成します。
ms app refresh data-source [--name <name>]
生成された TypeScript の同期を維持するには、基になるスキーマが変更された後 (SharePoint リストの新しい列など) このコマンドを実行します。
ms app refresh data-source parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--name <name> |
-n | 不要 | 特定のデータ ソースを更新する。 省略して、バインドされたすべてのソースを更新します。 |
ローカルで開発する
反復開発のために、次のコマンドを使用して、構成サーバーでアプリをローカルで実行します。
ms app dev
完全なローカル開発ループを開始します。
ms app dev [--port <n>] [--local-app-url <url>] [--config-only]
CLI は、ローカル構成サーバーと共にプロジェクトの開発プロセスを開始します。 両方に到達可能になると、再生 URL が印刷されます。
Ctrl+Cを押してきれいに止めます。
ms app dev parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--port <n> |
-p | 不要 | 構成サーバーのポート。 既定値は 8080 です。 |
--local-app-url <url> |
-l | 不要 | 開発サーバーが到達可能な URL。 既定値は http://localhost:3000 です。 |
--config-only |
-C | 不要 | 開発サーバーを個別に実行する場合 (たとえば、プロセス マネージャーで) 構成サーバーのみを起動します。 |
ビルドとデプロイ
これらのコマンドを使用して、ローカルでのパッケージ化、リモート ビルドの実行、検証済みのコミットの配置を行います。
ms app pack
アプリをローカルにビルドし、出力をステージングしてどこにもアップロードしません。
ms app pack
リモート ビルドをトリガーする前に、クリーンなローカル ビルドが成功することを確認するには、このコマンドを使用します。
ms app build
Git ベースのアプリで特定のコミットのプラットフォーム ビルドをトリガーします。
ms app build --app <name> --commit <sha> [--no-wait] [--open-browser] [--force-reauth]
ms app build parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | アプリ名。 既定値は ms.config.json (存在する場合) から。 |
|
--commit <sha> |
-c | 不要 | ビルドにコミットします。 既定は、現在の HEADです。 |
--no-wait |
不要 | 送信後すぐに戻って、 ms app build-statusでフォローアップするためのヒントを出力します。 既定では、このコマンドはビルドが最終状態になるまで待機します。 |
|
--open-browser |
不要 | 外部 GitHub リポジトリにデバイス コード フローの再認証が必要な場合は、ベストエフォート型システム ブラウザーを起動します。
--jsonには影響しません。 |
|
--force-reauth |
不要 | 保存されている GitHub マッピングをバイパスし、デバイス コード フローを強制します。 外部 GitHub リポジトリにバインドされているアプリにのみ影響します。 |
ms app build-status
ビルドの状態を確認します。
ms app build-status --app <name> --commit <sha> [--show-log]
ビルドが失敗した場合は、出力に理由が含まれているため、コードを修正して再度プッシュできます。
ms app build-status parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 検査するアプリ。 既定値は ms.config.json (存在する場合) から。 |
|
--commit <sha> |
-c | 不要 | コミットしてビルド状態をチェックします。 既定は、現在の HEADです。 |
--show-log |
不要 | ビルド ログを取得して出力 (使用可能な場合) 。 |
ms app deploy
グリーン ビルドをライブ アプリに昇格します。
ms app deploy [--app <name>] [--commit <sha>] [--artifact <path>] [--open-browser] [--force-reauth]
注:
- このコマンドは、アプリに関連付けられている環境に展開されます。 展開環境は選択されません。
- Git ベースのアプリの場合、CLI はコミット (既定の
HEAD) を解決し、コミットされていないローカルの変更について警告し、リモート ビルドをキューに入れ、完了するまでポーリングし、結果のビルドを配置します。 - ソース管理 (
repoType: none) のないアプリの場合、CLI はローカル ビルドをパッキングしてアップロードするか、--artifactが提供されている場合に事前ビルド済みの.zipをアップロードします。
ms app deploy parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | デプロイするアプリ。 既定値は ms.config.json からです。 |
|
--commit <sha> |
-c | 不要 | デプロイをコミットします (Git ベースのアプリのみ)。 既定は、現在の HEADです。
--artifactと同時に使用することはできません。 |
--artifact <path> |
不要 | アップロードして配置するローカル .zip ビルド成果物へのパス。 ソース管理 (repoType: none) なしで作成されたアプリに対してのみ有効です。Git ベースのアプリでは拒否されます。
--commitと同時に使用することはできません。 |
|
--open-browser |
不要 | ベストエフォート: デバイス コード フローの再認証が必要な場合は、システム ブラウザーを起動します。
--jsonには影響しません。 |
|
--force-reauth |
不要 | 保存されている GitHub マッピングをバイパスし、デバイス コード フローを強制します。 外部 GitHub リポジトリにバインドされているアプリにのみ影響します。 |
ms app deploy --artifact <path> プラットフォームで管理されたビルドを使用せずに成果物をアップロードして配置します。 外部アーティファクトの配置は既定では許可されません。
外部アーティファクトのデプロイメントを参照してください。
organization は、展開前に外部でビルドされた成果物を検証し、ビルド パイプラインを保護する責任があります。
Play
ライブ モードまたはプレビュー モードでアプリを開くには、このコマンドを使用します。
ms app play
ブラウザーでアプリを開き、その起動 URL を印刷します。
ms app play [--app <name>] [--mode live | preview] [--commit <sha>] [--no-browser]
ms app play parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 開くアプリ。 既定値は ms.config.json からです。 |
|
--mode <mode> |
-m | 不要 |
live 展開されたアプリを開きます。
preview
main の最新のビルドを開くか、--commit と組み合わせる場合は特定のコミットを開きます。 既定値は live です。 |
--commit <sha> |
-c | 不要 | 特定のコミットでプレビューを開きます。
--mode preview でのみ有効です。 |
--no-browser |
不要 | 既定のブラウザーを開かずに起動 URL を出力します。 SSH セッション、CI、およびスクリプトに役立ちます。 |
注:
--mode liveライブ ビルドはスナップショットであり、自動更新されないことを警告します。
ms app deploy を再実行して更新します。 アプリがデプロイされていない場合は、ms app deployを示す使用エラーが発生し、--mode liveが失敗します。
共有
これらのコマンドを使用して、アプリのアクセスを許可、取り消し、管理し、リンクを共有します。
ms app share
ユーザーまたはグループにアクセス権を付与します。
ms app share <principals> [--app <name>] [--access play | edit]
このコマンドは、電子メール アドレスを自動的に検索します。 解決されないエントリについては警告が報告されますが、解決されたエントリには警告が送信されます。 エントリが解決されない場合、コマンドは失敗します。
ms app share parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
<principals> |
はい | メール アドレスまたは Microsoft Entra オブジェクト ID のコンマ区切りのリスト。 | |
--app <name> |
不要 | 共有するアプリ。 既定値は ms.config.json からです。 |
|
--access <level> |
不要 | ランタイム アクセス (play、既定) またはリポジトリ編集アクセス (edit) を許可します。 |
ms app unshare
以前に許可されたアクセス権を取り消します。
ms app unshare <principals> [--app <name>] [--access play | edit]
unshare コマンドは、要求されたアクセス レベルにのみ影響します。 たとえば、unshare --access editplayアクセスはそのままのままにします。 要求されたレベルで既存のロール割り当てがないプリンシパルは no-op です。
ms app unshare parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
<principals> |
はい | メール アドレスまたは Microsoft Entra オブジェクト ID のコンマ区切りのリスト。 | |
--app <name> |
不要 | 共有を解除するアプリ。 既定値は ms.config.json からです。 |
|
--access <level> |
不要 | ランタイム アクセス (play、既定) またはリポジトリ編集アクセス (edit) を取り消します。 |
ms app share list
特定のアクセス レベルで、アプリが共有されているユーザーとグループを一覧表示します。
ms app share list --access <level> [--app <name>] [--environment-id <id>]
ms app share list parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--access <level> |
はい | 一覧のアクセス レベル。
play (アプリの実行) または edit (基になるリポジトリの変更) のいずれかです。 |
|
--app <name> |
不要 | 検査するアプリ。 既定値は ms.config.json からです。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 既定値は ms.config.json (存在する場合) から。 |
ms app share link create
アプリのテナント全体の共有リンクを作成します。
ms app share link create [--app <name>] [--environment-id <id>]
ms app share link create parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 共有するアプリ。 既定値は ms.config.json からです。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 既定値は ms.config.json (存在する場合) から。 |
ms app share link list
アプリに対して発行された共有リンクを一覧表示します。
ms app share link list [--app <name>] [--environment-id <id>]
ms app share link list parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 検査するアプリ。 既定値は ms.config.json からです。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 既定値は ms.config.json (存在する場合) から。 |
ms app share link revoke
ID で共有リンクを取り消します。 このコマンドは、リンク レコードを破棄する前に、以前のすべての引き換え者の役割を削除します。
ms app share link revoke --link-id <id> [--app <name>] [--environment-id <id>] [--force]
ms app share link revoke parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--link-id <id> |
-l | はい |
ms app share link create から返されたリンク ID。 |
--app <name> |
不要 | リンクを所有するアプリ。 既定値は ms.config.json からです。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 既定値は ms.config.json (存在する場合) から。 |
--force |
-f | 不要 | 確認プロンプトをスキップします。 |
検査と管理
これらのコマンドを使用して、アプリの状態を表示し、設定を更新し、必要に応じてアプリを削除します。
ms app list
アクセスできるすべてのアプリを一覧表示します。 既定では、テナント内のすべてのアプリが一覧表示されます。スコープを 1 つの環境にするように --environment-id 渡します。
ms app list [--environment-id <id>] [--permission <level>]
各アプリの表示名、アプリ ID、リポジトリ URL、所有者を返します。
ms app list parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--environment-id <id> |
-e | 不要 | 登録情報の範囲を 1 つの環境にします。 省略した場合、テナント全体でアクセスできるすべてのアプリが返されます。 |
--permission <level> |
-p | 不要 | アクセス許可フィルター。
edit (貢献可能なアプリ、既定) または play (再生/表示できるアプリ) のいずれかです。 大文字と小文字は区別されません。 |
ms app show
ローカル アプリの構成と、バインドされているすべてのリソースを表示します。
ms app show
現在のディレクトリでアプリのローカル構成を読み取ります。
ms app info
アプリのサーバー側の状態を表示します。
ms app info [--app <name>] [--environment-id <id>]
表示名、アプリ ID、リポジトリ URL、所有者、環境 ID、最後に展開されたコミット、およびライブ URL とプレビュー URL を返します。
ms app info parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 検査するアプリの名前。 既定値は ms.config.json からです。 明示的な名前を渡して、現在の作業ディレクトリの外部にあるアプリを検査します。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 既定値は ms.config.json からです。どちらも設定されていない場合、環境はアプリ名から自動的に解決されます。 |
ms app get-settings
すべてのアプリ設定とその現在の値を表示します。
ms app get-settings
ms app set-setting
1 つ以上のアプリ設定をUpdatesします。
ms app set-setting [--show-header <bool>] [other-settings...]
設定を名前付きフラグとして渡します。 指定したキーのみが更新されます。
ms app set-setting parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--show-header <bool> |
いいえ | アプリのヘッダー バーを表示または非表示にします。 | |
[other-settings...] |
不要 | 更新する 1 つ以上の名前付き設定フラグ。 指定されたキーのみが変更されます。 |
ms app delete
環境からアプリを削除します。 ローカル ソース コードや Git リポジトリは削除しません。
ms app delete [--app <name>] [--environment-id <id>] [--force]
アプリが存在しない場合、コマンドはエラーなしに正常に終了します。
ms app delete parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--app <name> |
いいえ | 削除するアプリ。 既定値は ms.config.json からです。 |
|
--environment-id <id> |
-e | 不要 | 環境 ID をオーバーライドします。 省略した場合、環境はアプリから自動的に解決されます。 スキャフォールド ディレクトリの外部からアプリを削除する場合に便利です。 |
--force |
-f | 不要 | 確認プロンプトをスキップします。 |
テレメトリ
CLI は、既定で匿名化されたテレメトリを送信します。 次のコマンドを使用して、収集を制御します。
ms telemetry enable
テレメトリ コレクションをオンにします。
ms telemetry enable [--remote] [--console]
ms telemetry enable parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--remote |
いいえ | リモート サービスへのテレメトリの送信を制御します。 このオプションは、フラグが指定されていない場合の既定値です。 | |
--console |
不要 | テレメトリ イベントをローカルの本体に出力します。 |
両方のフラグを渡して、両方のターゲットを一度に切り替えます。
ms telemetry disable
テレメトリ コレクションをオフにします。
ms telemetry disable [--remote] [--console]
ms telemetry disable parameters
| パラメーター | Alias | 必須 | 説明 |
|---|---|---|---|
--remote |
いいえ | リモート サービスへのテレメトリの送信を停止します。 このオプションは、フラグが指定されていない場合の既定値です。 | |
--console |
不要 | ローカル コンソールへのテレメトリ イベントの出力を停止します。 |
両方のフラグを渡して、両方のターゲットを同時に無効にします。
ms telemetry status
現在のテレメトリ設定を表示します。
ms telemetry status