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に変更します。

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

dotnet sitecore cloud environment list --project-id

情報サブコマンド

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

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

オプション

概要

--環境識別、-識別

必須。環境の一意識別子。

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

dotnet sitecore cloud environment info --environment-id

createサブコマンド

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

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

オプション

概要

--名前、-n

必須。新しい環境の名前。

--プロジェクトID

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

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

――タイムアウト

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

--cmのみ

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

注記
xmcloud.build.jsonの設定を適用し、Editing Secretなどの必要な秘密をデプロイするには、dotnet sitecore cloud deploymentコマンドを使ってSitecoreAIプロジェクトをデプロイする必要があります。

例えば:

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

updateサブコマンド

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

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

オプション

概要

--環境識別、-識別

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

--名前、-n

必須。環境の新しい名前。

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

dotnet sitecore cloud environment update --environment-id --name "Updated Name"

deleteサブコマンド

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

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

オプション

概要

--環境識別、-識別

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

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

dotnet sitecore cloud environment delete --environment-id

connectサブコマンド

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

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

オプション

概要

-ああ、--許可-書く

SitecoreAI環境へのデータの書き込み(プッシュ)が許可されているかどうかを指定するブールパラメータです。
デフォルト

。

――観客

Sitecore Cloudシステムおよび組織への認証対象を指定します。制作段階では、以下のいずれかの観客を対象にしてください:

- 環境にアクセスするために、 https://api.sitecorecloud.io。
- XM Cloud DevExプラグイン https://xmcloud-cm.sitecorecloud.io を使ってSitecore展開にアクセスするために。

--auth, --authority

Sitecore Cloudシステムおよび組織への認証に使用されるアイデンティティサーバーを指定します。
デフォルト

Identity認証URLで設定された値。

--クライアント認証情報、--非インタラクティブ

認証をインタラクティブフローで実行すべきか非インタラクティブフローで実行すべきかを示すブールパラメータ

--クライアントID

Sitecore Cloudシステムおよび組織認証に使用されるクライアントIDを指定します。

--クライアントの秘密

Sitecore Cloudシステムおよび組織への認証に使用されるクライアントシークレットを指定します。

--環境識別、-識別

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

-ホスト、--cm-ホスト

Sitecore cm URL/ホスト名

--構成

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

。

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

dotnet sitecore cloud environment connect --environment-id

disconnectサブコマンド

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

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

オプション

概要

--環境識別、-識別

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

--名前、-n

環境の名前です。

--冗長、-v

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

--トレース、-t

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

-?, -、助けて

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

例えば:

sitecore cloud environment disconnect --environment-id

昇進サブコマンド

!注promoteコマンドは、レガシー結合展開モデルを使用しているプロジェクトのみに利用可能です。

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

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

オプション

概要

--環境識別、-識別

必須。対象環境の一意識別子。

--source-id, -s

必須。プロモーションのソース展開の一意識別子。

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

――ノーウォッチ

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

――ノースタート

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

-?, -、助けて

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

--冗長、-v

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

--トレース、-t

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

例えば:

sitecore cloud environment promote --environment-id --source-id

log listサブコマンド

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

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

オプション

概要

--環境識別、-識別

必須。環境の一意識別子です。

――最新

もし正しい場合、各タイプのログファイルに対して最新のログのみを表示します。
デフォルト: false。

--JSON

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

-?, -、助けて

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

--冗長、-v

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

--トレース、-t

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

例えば:

dotnet sitecore cloud environment log list --environment-id

log downloadサブコマンド

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

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

オプション

概要

--環境識別、-識別

必須。環境の一意識別子です。

--logfile, -log

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

――パス。--出力パス、-o

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

-?, -、助けて

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

--冗長、-v

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

--トレース、-t

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

――タイムアウト

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

例えば:

dotnet sitecore cloud environment log download --environment-id --logfile

ログビューサブコマンド

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

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

オプション

概要

--環境識別、-識別

必須。環境の一意識別子です。

--logfile

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

-?, -、助けて

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

--冗長、-v

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

--トレース、-t

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

例えば:

dotnet sitecore cloud environment log view --environment-id --logfile

健康小指揮部

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

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

オプション

概要

--環境識別、-識別

必須。環境の一意識別子です。

--JSON

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

--トレース、-t

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

変数リストサブコマンド

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

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

オプション

概要

--環境識別、-識別

必須。SitecoreAI環境の一意識別子。

--JSON

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

――助けて、―h、―?

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

--冗長、-v

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

--トレース、-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サブコマンドで以下のオプションを使用できます:

オプション

概要

--環境識別、-識別

必須。対象環境の一意識別子。

--名前、-n

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

--値、-val

必須。変数の値。

--ターゲット

環境変数のターゲットです。この変数はコンテンツ管理インスタンスやレンダリングホスト用に追加できます。可能な値: CM、 EH、 、 null/省略。ホスト変数の編集では、デプロイ中に変数が正しくスコープ設定されているか確認するオプションを省略せず --target EH を使いましょう。

――秘密、―s

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

――助けて、―h、―?

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

--冗長、-v

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

--トレース、-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サブコマンドで以下のオプションを使用できます:

オプション

概要

--環境識別、-識別

必須。SitecoreAI環境の一意識別子

--名前、-n

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

――助けて、―h、―?

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

--冗長、-v

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

--トレース、-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]"に変更してください。

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

オプション

概要

--環境識別、-識別

必須。SitecoreAI環境の一意識別子。

--JSON

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

--構成

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

。

――助けて、―h、―?

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

--冗長、-v

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

--トレース、-t

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

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