1. CLIクラウドコマンド

クラウド環境コマンド

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecore CLIのXM Cloudプラグインは、プロジェクトの環境管理を支援するcloud environmentコマンドを提供します。

注記

ホストの編集管理にはeditinghostコマンドを使ってください。

使用例

cloud environmentコマンドは以下の通りに使えます:

dotnet sitecore cloud environment [subcommand] [options]

サブコマンド

以下のサブコマンドを使用できます:

  • list - 接続された組織のすべての環境と編集ホストを一覧化します。

  • info - 特定の環境に関する情報を表示すること。

  • create - 接続された組織内に新しい環境を創出すること。

  • update - 既存の環境の設定を更新する。

  • delete - 既存の環境を削除すること。

  • connect - 環境の接続情報を確立する。

  • disconnect - 環境から接続情報を取り除きます。

  • promote - 既存の 環境へのデプロイ を促進すること。

  • log list - 指定された環境のデプロイ時のログファイル名を一覧化します。

  • log download - 指定されたログファイルの内容をダウンロードし保存する。

  • log view - 指定されたログファイルの内容をダウンロードし、コンソールに印刷します。

  • health - 環境資源の健康状態を表示する。

  • variable list - 環境のすべての変数を一覧化します。

  • variable upsert - 環境変数の作成または更新。

  • variable delete - 環境変数を削除すること。

  • restart - ダウンタイムなしでオーサリング環境を再起動すること。

リストサブコマンド

listサブコマンドは、プロジェクトのすべての環境と編集ホストを一覧表示します。プロジェクトIDを提出しなければなりません。

listサブコマンドで以下のオプションを使用できます:

オプション

概要

--json

存在する場合は、レスポンス形式をプレーンテキストからJSONに変更します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

dotnet sitecore cloud environment list --project-id <project ID>

情報サブコマンド

infoサブコマンドは特定の環境に関する情報を提供します。環境の一意識別子を提供しなければなりません。

getサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

環境の一意識別子。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

dotnet sitecore cloud environment info --environment-id <environment-id>

createサブコマンド

createサブコマンドを使って新しい環境を作成できます。新しい環境名と親プロジェクトの一意識別子を指定する必要があります。

createサブコマンドで以下のオプションを使用できます:

オプション

概要

--name, -n

必須。

新しい環境の名前。

--project-id

必須。

環境が属するプロジェクトの一意識別子です。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

--timeout

作成プロセスが終わるまでの待つの時間(秒単位)。デフォルトは100です。

--cm-only

編集ホストなしでオーサリング環境を作成します。

例えば：

dotnet sitecore cloud environment create --name "Staging" --project-id <project-id>

updateサブコマンド

updateサブコマンドは既存の環境を更新します。環境の一意識別子と更新すべき情報を指定する必要があります。

updateサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

更新する環境の一意識別子。

--name, -n

必須。

環境の新しい名前。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

dotnet sitecore cloud environment update --environment-id <env-id> --name "Updated Name"

deleteサブコマンド

deleteサブコマンドは環境を除去します。環境の一意識別子を指定する必要があります。

deleteサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

削除する環境の一意識別子。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

dotnet sitecore cloud environment delete --environment-id <environment-id>

connectサブコマンド

Sitecoreソリューションを既存の環境にconnectサブコマンドで接続できます。

connectサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

接続を確立するために使われた環境の一意識別子。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

dotnet sitecore cloud environment connect --environment-id <environment-id>

disconnectサブコマンド

Sitecoreソリューションを既存の環境からdisconnectサブコマンドで切断できます。

disconnectサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

ソリューションから切り離す環境の一意識別子です。

--name, -n

環境の名前です。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

例えば：

sitecore cloud environment disconnect --environment-id <environment-id>

昇進サブコマンド

promoteサブコマンドを使って、既存の展開を特定の環境に進めることもできます。

promoteサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

ターゲット環境の一意識別子です。

--source-id, -s

必須。

プロモーションの送信元展開の一意識別子。

注記

ソース展開のために作成されたイメージは指定された環境に適用されます。デプロイメントをプロモートしても、そのデプロイメントが再構築されるわけではありません。

--no-watch

使用時には展開状況や進行状況の情報が展開プロセス中に表示されず、展開コマンドは即座に切り離されます。

--no-start

使用された場合、展開エンティティは展開プロセスを開始せずに作成されます。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

sitecore cloud environment promote --environment-id <environment-id> --source-id <deployment-id>

log listサブコマンド

log listサブコマンドは、指定された環境のデプロイ時のログファイル名を一覧にします。

log listサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

環境の一意識別子です。

--latest

trueの場合、各タイプのログファイルに対して最新のログのみを表示します。

デフォルト: false。

--json

デフォルトのレスポンスをプレーンテキストからJSONに変更してください。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

dotnet sitecore cloud environment log list --environment-id <env-id>

log downloadサブコマンド

log downloadサブコマンドは指定されたログファイルの内容をダウンロードし保存します。

log downloadサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

環境の一意識別子です。

--logfile, -log

必須。

ダウンロードできるファイルの固有のファイル名識別子。

--path. --outputpath、-o

必須。

ファイルを保存するための経路。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

--timeout

ダウンロードが完了するまでの待機時間は数秒です。デフォルトは100です。

例えば：

dotnet sitecore cloud environment log download --environment-id <env-id> --logfile <filename>

ログビューサブコマンド

log viewサブコマンドは指定されたログファイルの内容をダウンロードし、コンソールに印刷します。

log viewサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

環境の一意識別子です。

--logfile

必須。

ダウンロードできるファイルの固有のファイル名識別子。

-?、-h、--help

開発者のヘルプやコマンドの使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

dotnet sitecore cloud environment log view --environment-id <env-id> --logfile <filename>

健康小指揮部

healthサブコマンドは環境の資源の健康状態を表示します。

healthサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

環境の一意識別子です。

--json

デフォルトのテキスト形式レスポンスをJSON形式に変更します。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

変数リストサブコマンド

variable listサブコマンドは、その環境のすべての環境変数を一覧にします。

variable listサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

SitecoreAI環境の一意識別子。

--json

デフォルトのテキスト形式レスポンスをJSON形式に変更します。

--help、-h、-?

コマンドに関するヘルプ情報や使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

dotnet sitecore cloud environment variable list --environment-id env1
Found 3 variable(s)
LOG_LEVEL_VALUE Environment variable detailed information:
LOG_LEVEL_VALUE Environment variable detailed information:
Name   : LOG_LEVEL_VALUE
Secret : False
Value  : INFO
Target : CM

Sitecore_GraphQL_ExposePlayground Environment variable detailed information:
Name   : Sitecore_GraphQL_ExposePlayground
Secret : False
Value  : false
Target : *

SITECORE_SPE_ELEVATION Environment variable detailed information:
Name   : SITECORE_SPE_ELEVATION
Secret : False
Value  : BLOCK
Target : Default

SECRET_VARIABLE Environment variable detailed information:
Name   : SECRET_VARIABLE
Secret : True
Value  : *****
Target : CM

変数upsertサブコマンド

variable upsertサブコマンドは環境変数を作成または更新します。

大事な

環境変数の追加や変更には、変更が適用されるために環境の再構築や再デプロイが必要です。

variable upsertサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

対象環境の一意識別子。

--name, -n

必須。

変数の名前です。環境の中で唯一無二でなければなりません。

--value, -val

必須。

変数の値。

--target

環境変数のターゲット。この変数はコンテンツ管理インスタンスやレンダリングホスト用に追加できます。

可能な値: CM, <rendering-host-name>

--secret, -s

ブール数。暗号化された環境変数が必要だということを示しています。

--help、-h、-?

コマンドに関するヘルプ情報や使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

dotnet sitecore cloud environment variable upsert --environment-id env1 --name testvar --value testval --target CM
'testvar' Environment variable was accepted for upsert within 'env1' Environment.

変数deleteサブコマンド

variable deleteサブコマンドは、指定された環境変数を環境から削除します。

大事な

環境変数を削除するには、変更が適用されるために環境の再構築や再デプロイが必要です。

variable deleteサブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

SitecoreAI環境の一意識別子

--name, -n

必須。

削除対象となる変数の名前。

--help、-h、-?

コマンドに関するヘルプ情報や使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

例えば：

dotnet sitecore cloud environment variable delete --environment-id env1 --name testvar
'testvar' Environment variable was deleted within 'env1' Environment.

restartサブコマンド

restartサブコマンドはダウンタイムなしでオーサリング環境を再起動します。このサブコマンドはSitecore CLI XM Cloudプラグインバージョン1.1.73以降で利用可能です。

XM Cloudは現在SitecoreAIとなっています

一部のコード例、画像、UIラベルは、エンジニアリング資産の更新中もXM Cloudを使用している場合があります。

ヒント

プラグインを更新するには、sitecore.jsonファイルのプラグインエントリを "Sitecore.DevEx.Extensibility.XMCloud@<older_version>" から "[email protected]"に変更してください。

サブコマンドで以下のオプションを使用できます:

オプション

概要

--environment-id, -id

必須。

SitecoreAI環境の一意識別子。

--json

デフォルトのテキスト形式レスポンスをJSON形式に変更します。

--config

sitecore.jsonファイルを含むフォルダへのパス。

デフォルト:Sitecoreプロジェクトソリューションのルートディレクトリ。

--help、-h、-?

コマンドに関するヘルプ情報や使用情報を表示します。

--verbose, -v

コマンドについて追加情報を書きましょう。

--trace, -t

コマンドに関する診断や詳細な情報を書きましょう。

この記事を改善するための提案がある場合は、 お知らせください!