プロジェクト CLI リファレンス

IBM Cloud® コマンドラインインターフェイス ( IBM Cloud CLI) は、サービス提供のための追加機能を提供する。 IBM Cloud CLIを使用して、アクセス権を持つプロジェクトを管理することができます。

開始前に

IBM Cloud CLI をインストールします。
以下のコマンドを実行してProject CLIをインストールする：

ibmcloud plugin install project

IBM Cloud CLI およびプラグインに対する更新が使用可能になると、コマンド・ラインで通知されます。最新のコマンドを使用できるように、CLI をいつも最新の状態にしておいてください。 ibmcloud plugin list を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。

プロジェクト

プロジェクト・リソースのコマンド。

`ibmcloud project select`

通称： target

プロジェクトを現行コンテキストとして選択します。

ibmcloud project select PROJECT_ID|PROJECT_NAME [--unset-project] [--output FORMAT] [-q, --quiet]

例

ibmcloud project select db4da927-80bc-4161-960d-7ce2b5e1be96

または、プロジェクト名で選択することもできます

ibmcloud project select ProjectA

プロジェクトの選択を解除するには

ibmcloud project select --unset-project

コマンド・オプション

--unset-project (ブール): 目標未設定プロジェクト
--output (文字列): 出力形式を選択する - 'json'または'table'。(デフォルトは'table')
-q, --quiet (ブール): 冗長メッセージを抑制します。

ibmcloud project select --unset-project

`ibmcloud project create`

プロジェクトを作成し、それを管理するツールを非同期にセットアップする。構成をカスタマイズして、デプロイ可能アーキテクチャーを追加します。変更が検証されて承認されたら、プロジェクトが構成するリソースをデプロイします。詳しくは、プロジェクトの作成を参照してください。

ibmcloud project create [--definition DEFINITION | --definition-name DEFINITION-NAME --definition-description DEFINITION-DESCRIPTION --definition-auto-deploy-mode DEFINITION-AUTO-DEPLOY-MODE --definition-monitoring-enabled=DEFINITION-MONITORING-ENABLED --definition-destroy-on-delete=DEFINITION-DESTROY-ON-DELETE --definition-store DEFINITION-STORE --definition-terraform-engine DEFINITION-TERRAFORM-ENGINE --definition-auto-deploy=DEFINITION-AUTO-DEPLOY] --location LOCATION --resource-group RESOURCE-GROUP [--configs CONFIGS] [--environments ENVIRONMENTS] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--definition (ProjectPrototypeDefinition)

プロジェクトの定義です。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition=@path/to/file.json ）。

--location (文字列)

リソースがデプロイされている IBM Cloud のロケーション。必須。

許容値は、 us-south、 us-east、 eu-gb、 eu-de、 ca-tor です。

--resource-group (文字列)

プロジェクトのデータおよびツールが作成されるリソース・グループ名。必須。

最大長は64文字です。最小長は0文字です。値は正規表現/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/と一致する必要があります。

--configs (ProjectConfigPrototype[])

プロジェクト構成。これらの構成は、要求ペイロードで構成配列が指定されている場合にのみ、プロジェクト作成の応答に含まれます。

デフォルト値は []です。最大長さは 100。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --configs=@path/to/file.json ）。

--environments (EnvironmentPrototype[])

プロジェクト環境。これらの環境は、要求ペイロードで環境配列が指定されている場合にのみ、プロジェクト作成の応答に含まれます。

デフォルト値は []です。最大長さは 20。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --environments=@path/to/file.json ）。

--definition-name (文字列)

プロジェクトの名前。これは、複数の地域にわたってアカウント内で固有です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/と一致する必要があります。

--definition-description (文字列)

デプロイ可能アーキテクチャーの構成におけるプロジェクトの使用についての簡単な説明。説明はなくてもプロジェクトは作成できる。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値はです。最大長は 1024 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-auto-deploy-mode (文字列)

これは自動デプロイの高度な設定で、自動デプロイが有効になっているときの動作を指定します。以下の 2 つのオプションがあります。

auto_approval は、ユーザー確認なしで検証された後、自動的に設定を承認します。

manual_approval は、コンフィギュレーションのデプロイを開始する前に、検証後にコンフィギュレーションを承認するためのユーザー確認を要求します。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値は manual_approvalです。許容値は以下の通り： auto_approval manual_approval.

--definition-monitoring-enabled (ブール)

自動ドリフト検出を有効にするブール・フラグ。このフィールドを使用して、デイリーチェックを実行し、配置されたリソースとコンフィギュレーションを比較し、差異を検出する。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値は falseです。

--definition-destroy-on-delete (ブール)

プロジェクトの削除時にリソースをアンデプロイするかどうかを示すポリシー。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値は trueです。

--definition-store (ProjectDefinitionStore)

プロジェクト設定をカスタム保存するために必要な詳細。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-store=@path/to/file.json ）。

--definition-terraform-engine (ProjectTerraformEngineSettings)

実験的スキーマ - これはプロトタイプ用です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-terraform-engine=@path/to/file.json ）。

--definition-auto-deploy (ブール)

設定の自動デプロイを有効にするブーリアン・フラグ。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値は falseです。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project create \
    --definition '{"name": "acme-microservice", "description": "A microservice to deploy on top of ACME infrastructure.", "auto_deploy_mode": "manual_approval", "monitoring_enabled": false, "destroy_on_delete": true, "store": {"type": "gh", "url": "exampleString", "token": "exampleString", "config_directory": "exampleString"}, "terraform_engine": {"id": "exampleString", "type": "terraform-enterprise"}, "auto_deploy": false}' \
    --location us-south \
    --resource-group Default \
    --configs '[{"definition": {"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage account configuration.", "name": "account-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}, "schematics": {"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}}]' \
    --environments '[{"definition": {"description": "exampleString", "name": "exampleString", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {}}}]'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project create \
    --location us-south \
    --resource-group Default \
    --configs '[projectConfigPrototype]' \
    --environments '[environmentPrototype]' \
    --definition-name exampleString \
    --definition-description exampleString \
    --definition-auto-deploy-mode manual_approval \
    --definition-monitoring-enabled=false \
    --definition-destroy-on-delete=true \
    --definition-store projectDefinitionStore \
    --definition-terraform-engine projectTerraformEngineSettings \
    --definition-auto-deploy=false

`ibmcloud project list`

既存のプロジェクトをリストします。プロジェクトは ID でソートされます。注意: --all-pages オプションが設定されていない場合、コマンドはコレクションの単一ページのみを取得する。

ibmcloud project list [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--token (文字列)

サーバーはこのパラメーターを使用して、次のページに返される最初のエントリーを決定します。このパラメーターを指定しない場合は、論理先頭ページが返されます。

デフォルト値はです。最大長は 1536 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--limit (int64)

返すリソースの最大数。返されるリソースの数は、最後のページを除き、同じです。

デフォルト値は 10です。最大値は 100 である。最小値は 1 です。

--all-pages (ブール)

コレクションのすべてのページをリスト表示するために、複数のリクエストを呼び出します。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project list \
    --token exampleString \
    --limit 10

出力例

プロジェクトをリストする要求の例。

{
  "limit" : 10,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/12349050-1234-ac97-0000-ba5a12fe9087"
  },
  "projects" : [ {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "description" : "A project example.",
      "name" : "iaas-infra-prestage-env",
      "destroy_on_delete" : false
    },
    "location" : "us-south",
    "state" : "ready",
    "resource_group" : "Default",
    "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
    "cumulative_needs_attention_view" : [ {
      "event" : "project.instance.update"
    }, {
      "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
    }, {
      "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
    }, {
      "config_version" : 1
    } ]
  }, {
    "id" : "1123ed42-4356-efa1-1101-235900fe9087",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "description" : "A project example.",
      "name" : "iaas-infra-stage-env",
      "destroy_on_delete" : false
    },
    "crn" : "crn:v1:staging:public:project:eu-de:a/06580d923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "location" : "eu-gb",
    "state" : "ready",
    "resource_group" : "Default",
    "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
    "cumulative_needs_attention_view" : [ ]
  } ]
}

デフォルトJMESPath

JMESPathクエリは、ユーザーによって提供されなければ、デフォルトでこのコマンドの出力に適用される。正確なクエリは、シナリオと要求される出力形式によって異なります。各デフォルトJMESPathクエリの条件は以下の表で確認できる：

デフォルトJMESPath
応答	出力	照会
成功	デフォルト
	表	`projects[].{id: id, name: definition.name, state: state}`
エラー	デフォルト
	表	`projects[].{id: id, name: definition.name, state: state}`
すべてのページ	デフォルト
	表	`projects[].{id: id, name: definition.name, state: state}`

カスタムJMESPathクエリが提供された場合、それは上の表のJMESPathのいずれかを置き換える。

`ibmcloud project get`

プロジェクトに関する情報を得る。

ibmcloud project get [--id ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

例

ibmcloud project get \
    --id exampleString

出力例

構成を含むプロジェクトを取得するためのサンプル応答。

{
  "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
  "definition" : {
    "name" : "acme-microservice",
    "description" : "A microservice to deploy on top of ACME infrastructure.",
    "auto_deploy_mode" : "manual_approval",
    "auto_deploy" : false,
    "destroy_on_delete" : true,
    "monitoring_enabled" : false
  },
  "configs" : [ {
    "id" : "673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "common-variables",
      "description" : "The common-variables configuration."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "update_available" : false,
    "version" : 1
  }, {
    "id" : "4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "account-stage",
      "description" : "The stage account configuration. The stage account hosts test environments prestage, performance, stage. This configuration configures services that are common to all these environments and regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration. It includes services that are common to all the environment regions. A blueprint must be used to configure all the services that are common to the stage regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the Terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/293c3c36-a094-4115-a12b-de0a9ca39be5",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-us-south-stage",
      "description" : "The stage `us-south` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `us-south`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `eu-de`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  } ],
  "environments" : [ {
    "id" : "b0c44146-1ef6-40c2-82ba-74d51149770a",
    "definition" : {
      "name" : "dev-environment",
      "description" : "The development environment."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-02-10T10:05:35.787Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments/b0c44146-1ef6-40c2-82ba-74d51149770a"
  } ],
  "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
  "cumulative_needs_attention_view" : [ {
    "event" : "project.instance.update"
  }, {
    "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
  }, {
    "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
  }, {
    "config_version" : 1
  } ],
  "event_notifications_crn" : "crn:v1:staging:public:event-notifications:us-south:a/06580c923e40314421d3b6cb40c01c68:instance-id::",
  "location" : "us-south",
  "resource_group" : "Default",
  "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
  "state" : "ready"
}

デフォルトJMESPath

デフォルトJMESPath
応答	出力	照会
成功	デフォルト
	表	`{id: id, name: definition.name, state: state}`
エラー	デフォルト
	表	`{id: id, name: definition.name, state: state}`
すべてのページ	デフォルト
	表	`{id: id, name: definition.name, state: state}`

カスタムJMESPathクエリが提供された場合、それは上の表のJMESPathのいずれかを置き換える。

`ibmcloud project update`

ID を指定してプロジェクトを更新します。

ibmcloud project update [--id ID] {--definition DEFINITION | --definition-name DEFINITION-NAME --definition-description DEFINITION-DESCRIPTION --definition-auto-deploy-mode DEFINITION-AUTO-DEPLOY-MODE --definition-monitoring-enabled=DEFINITION-MONITORING-ENABLED --definition-destroy-on-delete=DEFINITION-DESTROY-ON-DELETE --definition-store DEFINITION-STORE --definition-terraform-engine DEFINITION-TERRAFORM-ENGINE --definition-auto-deploy=DEFINITION-AUTO-DEPLOY} [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (ProjectDefinitionPatch)

--definition-name (文字列)

最大長は128文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/と一致する必要があります。

--definition-description (文字列)

最大長は1024文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-auto-deploy-mode (文字列)

これは自動デプロイの高度な設定で、自動デプロイが有効になっているときの動作を指定します。以下の 2 つのオプションがあります。

auto_approval は、ユーザー確認なしで検証された後、自動的に設定を承認します。

manual_approval は、コンフィギュレーションのデプロイを開始する前に、検証後にコンフィギュレーションを承認するためのユーザー確認を要求します。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

使用できる値は、auto_approval、manual_approvalです。

--definition-monitoring-enabled (ブール)

自動ドリフト検出を有効にするブール・フラグ。このフィールドを使用して、デプロイされたリソースとコンフィギュレーションを比較するデイリーチェックを実行し、差異を検出する。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

--definition-destroy-on-delete (ブール)

--definition-store (ProjectDefinitionStore)

--definition-terraform-engine (ProjectTerraformEngineSettings)

--definition-auto-deploy (ブール)

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project update \
    --id exampleString \
    --definition '{"name": "acme-microservice", "description": "A microservice to deploy on top of ACME infrastructure.", "auto_deploy_mode": "auto_approval", "monitoring_enabled": true, "destroy_on_delete": true, "store": {"type": "gh", "url": "exampleString", "token": "exampleString", "config_directory": "exampleString"}, "terraform_engine": {"id": "exampleString", "type": "terraform-enterprise"}, "auto_deploy": true}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project update \
    --id exampleString \
    --definition-name exampleString \
    --definition-description exampleString \
    --definition-auto-deploy-mode auto_approval \
    --definition-monitoring-enabled=true \
    --definition-destroy-on-delete=true \
    --definition-store projectDefinitionStore \
    --definition-terraform-engine projectTerraformEngineSettings \
    --definition-auto-deploy=true

出力例

構成を含むプロジェクトを取得するためのサンプル応答。

{
  "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
  "definition" : {
    "name" : "acme-microservice",
    "description" : "A microservice to deploy on top of ACME infrastructure.",
    "auto_deploy_mode" : "manual_approval",
    "auto_deploy" : false,
    "destroy_on_delete" : true,
    "monitoring_enabled" : false
  },
  "configs" : [ {
    "id" : "673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "common-variables",
      "description" : "The common-variables configuration."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "update_available" : false,
    "version" : 1
  }, {
    "id" : "4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "account-stage",
      "description" : "The stage account configuration. The stage account hosts test environments prestage, performance, stage. This configuration configures services that are common to all these environments and regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration. It includes services that are common to all the environment regions. A blueprint must be used to configure all the services that are common to the stage regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the Terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/293c3c36-a094-4115-a12b-de0a9ca39be5",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-us-south-stage",
      "description" : "The stage `us-south` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `us-south`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `eu-de`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  } ],
  "environments" : [ {
    "id" : "b0c44146-1ef6-40c2-82ba-74d51149770a",
    "definition" : {
      "name" : "dev-environment",
      "description" : "The development environment."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-02-10T10:05:35.787Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments/b0c44146-1ef6-40c2-82ba-74d51149770a"
  } ],
  "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
  "cumulative_needs_attention_view" : [ {
    "event" : "project.instance.update"
  }, {
    "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
  }, {
    "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
  }, {
    "config_version" : 1
  } ],
  "event_notifications_crn" : "crn:v1:staging:public:event-notifications:us-south:a/06580c923e40314421d3b6cb40c01c68:instance-id::",
  "location" : "us-south",
  "resource_group" : "Default",
  "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
  "state" : "ready"
}

`ibmcloud project delete`

ID を指定してプロジェクト文書を削除します。プロジェクトは、そのリソースをすべて削除してからでないと削除できません。

ibmcloud project delete [--id ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

例

ibmcloud project delete \
    --id exampleString

出力例

プロジェクトを削除する要求に対する応答例。

{
  "id" : "4059955c-ccb3-4fd3-aa48-34e3b8334f80"
}

環境

環境リソース用のコマンド。

`ibmcloud project environment-create`

デプロイメントを容易にするために、関連する構成をグループ化し、それらの構成間で値を共有するための環境を作成します。詳しくは、環境の作成を参照してください。

ibmcloud project environment-create [--project-id PROJECT-ID] [--definition DEFINITION | --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (EnvironmentDefinitionRequiredProperties)

環境定義。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

--definition-description (文字列)

環境の説明。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値はです。最大長は 1024 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-name (文字列)

環境の名前。これは、複数のプロジェクトおよび地域にわたってアカウント内で固有です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/と一致する必要があります。

--definition-authorizations (ProjectConfigAuth)

許可の詳細。 Secrets Manager内の信頼できるプロファイルまたは API キーを使用して許可することができます。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-authorizations=@path/to/file.json ）。

--definition-inputs (汎用マップ)

構成定義および環境に使用される入力変数。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-inputs=@path/to/file.json ）。

--definition-compliance-profile (ProjectComplianceProfile)

準拠のために必要なプロファイル。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-compliance-profile=@path/to/file.json ）。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project environment-create \
    --project-id exampleString \
    --definition '{"description": "The environment development.", "name": "development", "authorizations": {"trusted_profile_id": "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12", "method": "trusted_profile", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {"id": "some-profile-id", "instance_id": "some-instance-id", "instance_location": "us-south", "attachment_id": "some-attachment-id", "profile_name": "some-profile-name", "wp_policy_id": "exampleString", "wp_instance_id": "exampleString", "wp_instance_name": "exampleString", "wp_instance_location": "us-south", "wp_zone_id": "exampleString", "wp_zone_name": "exampleString", "wp_policy_name": "exampleString"}}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project environment-create \
    --project-id exampleString \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-compliance-profile projectComplianceProfile

出力例

サンプル環境応答。

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environments`

使用可能なすべての環境をリストします。詳しくは、環境の作成を参照してください。注意: --all-pages オプションが設定されていない場合、コマンドはコレクションの単一ページのみを取得する。

ibmcloud project environments [--project-id PROJECT-ID] [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--token (文字列)

デフォルト値はです。最大長は 1536 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--limit (int64)

返すリソースの最大数。返されるリソースの数は、最後のページを除き、同じです。

デフォルト値は 10です。最大値は 100 である。最小値は 1 です。

--all-pages (ブール)

複数のリクエストを呼び出して、環境のためにコレクションのすべてのページを表示する。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project environments \
    --project-id exampleString \
    --token exampleString \
    --limit 10

出力例

リストに対するサンプル環境応答。

{
  "limit" : 1,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments?limit=1"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments?limit=1&token=da969bff-vf9q-3t1t-b677-d6rt5c0de54e"
  },
  "environments" : [ {
    "id" : "env123",
    "definition" : {
      "name" : "development",
      "description" : "The environment development.",
      "authorizations" : {
        "method" : "trusted_profile",
        "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
      },
      "inputs" : {
        "resource_group" : "stage",
        "region" : "us-south"
      },
      "compliance_profile" : {
        "id" : "some-profile-id",
        "instance_id" : "some-instance-id",
        "instance_location" : "us-south",
        "profile_name" : "some-profile-name",
        "attachment_id" : "some-attachment-id"
      }
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-06-29T03:28:14.709Z",
    "modified_at" : "2023-06-29T03:28:14.709Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
  } ]
}

`ibmcloud project environment`

環境を取得します。詳細はこちらをご覧ください。

ibmcloud project environment --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

環境 ID。必須。

最大長は256文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$).+$/と一致する必要があります。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project environment \
    --project-id exampleString \
    --id exampleString

出力例

サンプル環境応答。

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environment-update`

環境の ID を指定して環境を更新します。詳細はこちらをご覧ください。

ibmcloud project environment-update [--project-id PROJECT-ID] --id ID [--definition DEFINITION | --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

環境 ID。必須。

最大長は256文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$).+$/と一致する必要があります。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (EnvironmentDefinitionPropertiesPatch)

更新に使用される環境定義。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

--definition-description (文字列)

最大長は1024文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-name (文字列)

最大長は128文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/と一致する必要があります。

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (汎用マップ)

--definition-compliance-profile (ProjectComplianceProfile)

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project environment-update \
    --project-id exampleString \
    --id exampleString \
    --definition '{"description": "The environment development.", "name": "development", "authorizations": {"trusted_profile_id": "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12", "method": "trusted_profile", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {"id": "some-profile-id", "instance_id": "some-instance-id", "instance_location": "us-south", "attachment_id": "some-attachment-id", "profile_name": "some-profile-name", "wp_policy_id": "exampleString", "wp_instance_id": "exampleString", "wp_instance_name": "exampleString", "wp_instance_location": "us-south", "wp_zone_id": "exampleString", "wp_zone_name": "exampleString", "wp_policy_name": "exampleString"}}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project environment-update \
    --project-id exampleString \
    --id exampleString \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-compliance-profile projectComplianceProfile

出力例

サンプル環境応答。

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environment-delete`

プロジェクト内の環境を、その ID を指定して削除します。

ibmcloud project environment-delete --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

環境 ID。必須。

最大長は256文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$).+$/と一致する必要があります。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project environment-delete \
    --project-id exampleString \
    --id exampleString

出力例

環境削除の応答例。

{
  "id" : "env123"
}

構成

構成リソースのコマンド。

`ibmcloud project config-create`

プロジェクトに新しい設定を追加します。

ibmcloud project config-create [--project-id PROJECT-ID] [--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS] [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (ProjectConfigDefinitionPrototype)

代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

--schematics (SchematicsWorkspace)

このデプロイ可能アーキテクチャーをデプロイするために使用する Schematics ワークスペース。

カートでバックアップされていない既存の Schematics ワークスペースからデータをインポートする場合は、 locator_id を提供する必要があります。カートでバックアップされている Schematics ワークスペースを使用する場合、 Schematics ワークスペースには locator_id があるため、は必要ない。

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定された場合、指定された locator_id が既存の Schematics ワークスペースの locator_id と一致しない場合は 400 コードが返される。

詳しくはワークスペースの作成とTerraformテンプレートのインポートを参照。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --schematics=@path/to/file.json ）。

--definition-compliance-profile (ProjectComplianceProfile)

--definition-locator-id (文字列)

カタログ内のデプロイ可能アーキテクチャーを識別する、カタログ ID とバージョン ID を一意に連結したもの。カートにバックアップされていない既存の Schematics ワークスペースからインポートする場合は、 locator_id が必要です。カートでバックアップされている Schematics ワークスペースを使用する場合、 Schematics ワークスペースには locator_id があるため、は必要ない。

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定されている場合、指定された locator_id が既存の Schematics ワークスペース内の locator_id と一致しなければ、 400 メッセージが返されます。 Schematics ワークスペースの作成については、ワークスペースの作成とTerraformテンプレートのインポートを参照。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は512文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/と一致する必要があります。

--definition-members (StackMember[])

スタックに含まれる展開可能なアーキテクチャのメンバー。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長さは 100。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-members=@path/to/file.json ）。

--definition-uses (ProjectConfigUses[])

このコンフィギュレーションによって参照される、依存する配備アーキテクチャ。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長さは 100。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-uses=@path/to/file.json ）。

--definition-description (文字列)

プロジェクト構成の説明。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値はです。最大長は 1024 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-name (文字列)

構成名。これは、複数のプロジェクトおよび地域にわたってアカウント内で固有です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。最小文字数は 1。値は正規表現/^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/と一致する必要があります。

--definition-authorizations (ProjectConfigAuth)

許可の詳細。 Secrets Manager、信頼されたプロファイルまたはAPIキーを使用して認証することができます。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

--definition-inputs (汎用マップ)

--definition-settings (汎用マップ)

構成をデプロイするために使用する Schematics 環境変数。設定は、構成の初期作成時に指定された場合にのみ使用可能です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --definition-settings=@path/to/file.json ）。

--definition-environment-id (文字列)

プロジェクト環境のID。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition-resource-crns ([]ストリング)

この構成に関連付けられているリソースの CRN です。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

リスト項目は正規表現 /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ にマッチしなければならない。最大長さは 110。最小の長さは 0。

--schematics-workspace-crn (文字列)

リソースを一意的に識別する IBM Cloud リソース名。このオプションは、JSON オプション「schematics」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は512文字です。最小長は4文字です。値は正規表現/^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/と一致する必要があります。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-create \
    --project-id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage environment configuration.", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}' \
    --schematics '{"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project config-create \
    --project-id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

`ibmcloud project configs`

構成のコレクションを取得します。注意: --all-pages オプションが設定されていない場合、コマンドはコレクションの単一ページのみを取得する。

ibmcloud project configs [--project-id PROJECT-ID] [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--token (文字列)

デフォルト値はです。最大長は 1536 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--limit (int64)

返すリソースの最大数。返されるリソースの数は、最後のページを除き、同じです。

デフォルト値は 10です。最大値は 100 である。最小値は 1 です。

--all-pages (ブール)

コンフィグコレクションの全ページを表示するために複数のリクエストを呼び出す。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project configs \
    --project-id exampleString \
    --token exampleString \
    --limit 10

出力例

プロジェクト構成を取得するための要求の応答例。

{
  "limit" : 2,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs?limit=2"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs?limit=2&token=da969bff-vf9q-3t1t-b677-d6rt5c0de54e"
  },
  "configs" : [ {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "version" : 1,
    "state" : "validated",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5"
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration."
    },
    "approved_version" : {
      "definition" : {
        "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
      },
      "version" : 1,
      "state" : "approved",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd/versions/1"
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "version" : 2,
    "state" : "draft",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd"
  } ]
}

デフォルトJMESPath

デフォルトJMESPath
応答	出力	照会
成功	デフォルト
	表	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
エラー	デフォルト
	表	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
すべてのページ	デフォルト
	表	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

カスタムJMESPathクエリが提供された場合、それは上の表のJMESPathのいずれかを置き換える。

`ibmcloud project config`

特定のプロジェクト内の指定されたプロジェクト構成を取得します。

ibmcloud project config --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q,--quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

例

ibmcloud project config \
    --project-id exampleString \
    --id exampleString

デフォルトJMESPath

デフォルトJMESPath
応答	出力	照会
成功	デフォルト
	表	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
エラー	デフォルト
	表	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
すべてのページ	デフォルト
	表	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

カスタムJMESPathクエリが提供された場合、それは上の表のJMESPathのいずれかを置き換える。

`ibmcloud project config-update`

ID を指定して、プロジェクト内の構成を更新します。詳細はこちらをご覧ください。

ibmcloud project config-update --id ID {--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (ProjectConfigDefinitionPatch)

--definition-compliance-profile (ProjectComplianceProfile)

--definition-locator-id (文字列)

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定されている場合、指定された locator_id が既存の Schematics ワークスペース内の locator_id と一致しなければ、 400 メッセージが返されます。 Schematics ワークスペースの作成については、ワークスペースの作成とTerraformテンプレートのインポートを参照。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は512文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/と一致する必要があります。

--definition-members (StackMember[])

最大長さは 100。最小の長さは 0。

--definition-uses (ProjectConfigUses[])

最大長さは 100。最小の長さは 0。

--definition-description (文字列)

最大長は1024文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-name (文字列)

最大長は128文字です。最小文字数は 1。値は正規表現/^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/と一致する必要があります。

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (汎用マップ)

--definition-settings (汎用マップ)

--definition-environment-id (文字列)

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition-resource-crns ([]ストリング)

リスト項目は正規表現 /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ にマッチしなければならない。最大長さは 110。最小の長さは 0。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-update \
    --project-id exampleString \
    --id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "exampleString", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "exampleString", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project config-update \
    --project-id exampleString \
    --id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString

`ibmcloud project config-delete`

プロジェクト内の構成を、その ID を指定して削除します。

ibmcloud project config-delete --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

例

ibmcloud project config-delete \
    --project-id exampleString \
    --id exampleString

出力例

構成を削除する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

`ibmcloud project config-force-approve`

承認コメント付きでメイン構成の編集を強制的に承認します。

ibmcloud project config-force-approve --id ID --comment COMMENT [--project-id PROJECT-ID]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--comment (文字列)

プロジェクトのドラフト・アクションに関するメモ。このアクションがドラフトコンフィギュレーションに対する強制承認である場合、空でないコメントを含まなければならない。必須。

最大長は1024文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/と一致する必要があります。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-force-approve \
    --project-id exampleString \
    --id exampleString \
    --comment 'Approving the changes'

出力例

デプロイ可能なアーキテクチャー構成ドラフトに対する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-approve`

メイン構成に対する構成編集を承認してマージします。

ibmcloud project config-approve --id ID --comment COMMENT [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--comment (文字列)

プロジェクトのドラフト・アクションに関するメモ。このアクションがドラフトコンフィギュレーションに対する強制承認である場合、空でないコメントを含まなければならない。

最大長は1024文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/と一致する必要があります。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-approve \
    --project-id exampleString \
    --id exampleString \
    --comment 'Approving the changes'

出力例

デプロイ可能なアーキテクチャー構成ドラフトに対する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-validate`

プロジェクト内の特定の構成に対して検証チェックを実行します。このチェックには、計画ジョブを使用した関連 Schematics ワークスペースの作成または更新、CRA スキャンの実行、およびコスト見積もりが含まれます。

ibmcloud project config-validate --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-validate \
    --project-id exampleString \
    --id exampleString

出力例

デプロイ可能なアーキテクチャー構成ドラフトに対する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-prevalidate`

API経由で渡された設定のバリデーションチェックを実行します。このチェックには、 Schematics のワークスペースをプランジョブとともに作成し、CRAスキャンを実行し、コストを見積もることが含まれる。

ibmcloud project config-prevalidate --id ID [--project-id PROJECT-ID] {--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS} [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition (ProjectConfigDefinitionPrototype)

--schematics (SchematicsWorkspace)

このデプロイ可能アーキテクチャーをデプロイするために使用する Schematics ワークスペース。

カートでバックアップされていない既存の Schematics ワークスペースからデータをインポートする場合は、 locator_id を提供する必要があります。カートでバックアップされている Schematics ワークスペースを使用する場合、 Schematics ワークスペースには locator_id があるため、は必要ない。

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定された場合、指定された locator_id が既存の Schematics ワークスペースの locator_id と一致しない場合は 400 コードが返される。

--definition-compliance-profile (ProjectComplianceProfile)

--definition-locator-id (文字列)

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定されている場合、指定された locator_id が既存の Schematics ワークスペース内の locator_id と一致しなければ、 400 メッセージが返されます。 Schematics ワークスペースの作成については、ワークスペースの作成とTerraformテンプレートのインポートを参照。このオプションは、JSON オプション「definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は512文字です。最小文字数は 1。値は正規表現/^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/と一致する必要があります。

--definition-members (StackMember[])

最大長さは 100。最小の長さは 0。

--definition-uses (ProjectConfigUses[])

最大長さは 100。最小の長さは 0。

--definition-description (文字列)

デフォルト値はです。最大長は 1024 文字です。最小長は0文字です。値は正規表現/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/と一致する必要があります。

--definition-name (文字列)

最大長は128文字です。最小文字数は 1。値は正規表現/^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/と一致する必要があります。

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (汎用マップ)

--definition-settings (汎用マップ)

--definition-environment-id (文字列)

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--definition-resource-crns ([]ストリング)

リスト項目は正規表現 /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ にマッチしなければならない。最大長さは 110。最小の長さは 0。

--schematics-workspace-crn (文字列)

最大長は512文字です。最小長は4文字です。値は正規表現/^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/と一致する必要があります。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage environment configuration.", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}' \
    --schematics '{"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project config-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

出力例

prevalidate の結果オブジェクト。

{
  "result_id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

`ibmcloud project get-prevalidate`

キーを使用して、プリビデートの結果を取得する。

ibmcloud project get-prevalidate --id ID --result-id RESULT-ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--result-id (文字列)

prevalidateイベントを取得するための一意な識別子。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project get-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --result-id exampleString

出力例

プリビデートの結果を得るための応答例。

{
  "cost_estimate" : { },
  "cra_logs" : {
    "cra_version" : "2.0.4",
    "status" : "passed"
  },
  "job" : {
    "id" : "ba98208b61efa490153b72adfd672251",
    "summary" : {
      "version" : "1.0.5",
      "plan_summary" : { },
      "apply_summary" : { },
      "destroy_summary" : { },
      "message_summary" : { },
      "plan_messages" : { },
      "apply_messages" : { },
      "destroy_messages" : { }
    }
  },
  "result" : "succeeded"
}

`ibmcloud project config-deploy`

プロジェクトの構成をデプロイします。この操作は非同期であり、完全なメタデータとともにプロジェクト設定APIを取得することで追跡できる。

ibmcloud project config-deploy --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-deploy \
    --project-id exampleString \
    --id exampleString

出力例

デプロイ可能なアーキテクチャー構成ドラフトに対する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-undeploy`

プロジェクトの構成リソースをアンデプロイします。この操作により、特定の構成でデプロイされたすべてのリソースがアンデプロイされます。コンフィギュレーション・リソースは、完全なメタデータとともにプロジェクト・コンフィギュレーション取得APIを使うことで追跡できる。

ibmcloud project config-undeploy --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-undeploy \
    --project-id exampleString \
    --id exampleString

出力例

デプロイ可能なアーキテクチャー構成ドラフトに対する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-sync`

関連付けられたパイプライン実行と Schematics ワークスペース・ログを分析してプロジェクト構成を同期し、構成を作業状態に戻します。

ibmcloud project config-sync --id ID [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--schematics (SchematicsWorkspace)

このデプロイ可能アーキテクチャーをデプロイするために使用する Schematics ワークスペース。

カートでバックアップされていない既存の Schematics ワークスペースからデータをインポートする場合は、 locator_id を提供する必要があります。カートでバックアップされている Schematics ワークスペースを使用する場合、 Schematics ワークスペースには locator_id があるため、は必要ない。

以下の 3 つのシナリオがあります。

locator_id のみを指定した場合は、新しい Schematics ワークスペースがその locator_id でインスタンス化されます。

Schematics workspace_crn のみが指定されている場合、既存の schematics ワークスペースに locator_id が見つからないと、 400 が返されます。

Schematics workspace_crn と locator_id の両方が指定された場合、指定された locator_id が既存の Schematics ワークスペースの locator_id と一致しない場合は 400 コードが返される。

--schematics-workspace-crn (文字列)

最大長は512文字です。最小長は4文字です。値は正規表現/^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/と一致する必要があります。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-sync \
    --project-id exampleString \
    --id exampleString \
    --schematics '{"workspace_crn": "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project config-sync \
    --project-id exampleString \
    --id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

`ibmcloud project config-resources`

構成によってデプロイされたリソースをリストします。

ibmcloud project config-resources --project-id PROJECT-ID --id ID

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-resources \
    --project-id exampleString \
    --id exampleString

出力例

プロジェクト構成リソースを取得する要求に対する応答例。

{
  "resources" : [ {
    "resource_crn" : "crn:v1:staging:public:toolchain:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::",
    "resource_name" : "toolchain_instance",
    "resource_type" : "ibm_cd_toolchain",
    "resource_tainted" : false,
    "resource_group_name" : "",
    "account_id" : "499b176abb3e1c9727df87ae48b27c7b",
    "location" : "us-south",
    "resource_status" : "active",
    "tags" : [ ],
    "service_tags" : [ ],
    "catalog_tags" : [ ]
  }, {
    "resource_crn" : "crn:v1:staging:public:cloud-object-storage:global:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::",
    "resource_name" : "cos_bucket_instance",
    "resource_type" : "ibm_cos_bucket",
    "resource_tainted" : false,
    "resource_group_name" : "",
    "account_id" : "499b176abb3e1c9727df87ae48b27c7b",
    "location" : "us-south",
    "resource_status" : "active",
    "tags" : [ ],
    "service_tags" : [ ],
    "catalog_tags" : [ ]
  } ],
  "resources_count" : 2
}

`ibmcloud project stack-definition-create`

ユーザーがメンバー・レベルで入力値とともに構成する必要がある入力をスタック・レベルで定義します。これらの値は、展開可能なアーキテクチャ・スタックがプライベート・カタログにエクスポートされるときにカタログ・エントリに含まれ、展開可能なアーキテクチャ・スタックが展開するために必要となる。参照を値に追加することも、メンバ・レベルで明示的に値を追加することもできます。

ibmcloud project stack-definition-create --id ID {--stack-definition STACK-DEFINITION | --stack-definition-inputs STACK-DEFINITION-INPUTS --stack-definition-outputs STACK-DEFINITION-OUTPUTS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--stack-definition (StackDefinitionBlockPrototype)

スタック定義用の定義ブロック。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --stack-definition=@path/to/file.json ）。

--stack-definition-inputs (StackDefinitionInputVariable[])

ユーザーがスタック・レベルで構成する必要がある入力を定義します。これらの入力は、デプロイ可能なアーキテクチャー・スタックがプライベート・カタログにエクスポートされるときに、カタログ・エントリーに組み込まれます。このオプションは、JSON オプション「stack-definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長さは 300。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --stack-definition-inputs=@path/to/file.json ）。

--stack-definition-outputs (StackDefinitionOutputVariable[])

このスタック定義に関連付けられた出力。このオプションは、JSON オプション「stack-definition」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長さは 100。最小の長さは 0。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --stack-definition-outputs=@path/to/file.json ）。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project stack-definition-create \
    --project-id exampleString \
    --id exampleString \
    --stack-definition '{"inputs": [{"name": "region", "type": "string", "description": "The IBM Cloud location where a resource is deployed.", "default": "us-south", "required": true, "hidden": false}], "outputs": [{"name": "vpc_cluster_id", "value": "cluster_id"}]}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project stack-definition-create \
    --project-id exampleString \
    --id exampleString \
    --stack-definition-inputs '[stackDefinitionInputVariable]' \
    --stack-definition-outputs '[stackDefinitionOutputVariable]'

出力例

「スタック・テンプレートの作成」操作からの応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "us-south",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    }, {
      "name" : "resource_group",
      "type" : "string",
      "default" : "Default",
      "required" : true,
      "hidden" : false,
      "description" : "The IBM Cloud resource group where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "region",
        "value" : "us-south"
      }, {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    }, {
      "name" : "middleware-architecture",
      "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.4d86732e-04b9-4dab-bfdc-5b514d86ecd8",
      "inputs" : [ {
        "name" : "kube_version",
        "value" : 1.29
      } ]
    } ]
  },
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template",
  "references" : { }
}

`ibmcloud project stack-definition`

構成に関連付けられているスタック定義を取得します。

ibmcloud project stack-definition --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project stack-definition \
    --project-id exampleString \
    --id exampleString

出力例

「スタック・テンプレートの作成」操作からの応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "us-south",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    }, {
      "name" : "resource_group",
      "type" : "string",
      "default" : "Default",
      "required" : true,
      "hidden" : false,
      "description" : "The IBM Cloud resource group where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "region",
        "value" : "us-south"
      }, {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    }, {
      "name" : "middleware-architecture",
      "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.4d86732e-04b9-4dab-bfdc-5b514d86ecd8",
      "inputs" : [ {
        "name" : "kube_version",
        "value" : 1.29
      } ]
    } ]
  },
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template",
  "references" : { }
}

`ibmcloud project stack-definition-update`

構成に関連付けられているスタック定義を更新します。

ibmcloud project stack-definition-update --id ID {--stack-definition STACK-DEFINITION | --stack-definition-inputs STACK-DEFINITION-INPUTS --stack-definition-outputs STACK-DEFINITION-OUTPUTS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--stack-definition (StackDefinitionBlockPrototype)

--stack-definition-inputs (StackDefinitionInputVariable[])

最大長さは 300。最小の長さは 0。

--stack-definition-outputs (StackDefinitionOutputVariable[])

最大長さは 100。最小の長さは 0。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project stack-definition-update \
    --project-id exampleString \
    --id exampleString \
    --stack-definition '{"inputs": [{"name": "region", "type": "string", "description": "The IBM Cloud location where a resource is deployed.", "default": "eu-gb", "required": true, "hidden": false}], "outputs": [{"name": "exampleString", "value": "exampleString"}]}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project stack-definition-update \
    --project-id exampleString \
    --id exampleString \
    --stack-definition-inputs '[stackDefinitionInputVariable]' \
    --stack-definition-outputs '[stackDefinitionOutputVariable]'

出力例

パッチ・スタック・テンプレート操作からのサンプル応答。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "eu-gb",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    } ]
  },
  "state" : "draft",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template"
}

`ibmcloud project stack-definition-export`

デプロイ可能なアーキテクチャー・スタックをプライベート・カタログにエクスポートします。スタックをエクスポートする前に、スタック内のすべてのデプロイ可能なメンバー・アーキテクチャーを検証してデプロイする必要があります。スタックをエクスポートする前に、スタック定義も存在している必要があります。スタックは新製品として、または既存製品の新バージョンとしてエクスポートできます。

ibmcloud project stack-definition-export --id ID [--settings SETTINGS | --settings-catalog-id SETTINGS-CATALOG-ID --settings-target-version SETTINGS-TARGET-VERSION --settings-variation SETTINGS-VARIATION --settings-label SETTINGS-LABEL --settings-tags SETTINGS-TAGS --settings-product-id SETTINGS-PRODUCT-ID] [--project-id PROJECT_ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--settings (StackDefinitionExportRequest)

プライベート・カタログのエクスポート要求のペイロード。代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。これらのオプションと同時に使用することはできません。

JSON文字列オプションを指定するか、 @ で始まるfilepath オプションを指定して、読み込むJSONファイルを指定する（例： --settings=@path/to/file.json ）。

--settings-catalog-id (文字列)

公開するカタログ ID。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は36文字です。値は正規表現 /^[\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--settings-target-version (文字列)

この新バージョンのセンバ値。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は60文字です。最小長は5文字です。値は正規表現/^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/と一致する必要があります。

--settings-variation (文字列)

現在搭載されているソフトウェアのバリエーション。製品の種類がモジュールまたはソリューションの場合のみ有効です。カタログのインポートオファーの flavor を参照。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。値は正規表現 /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ にマッチしなければならない。

--settings-label (文字列)

製品ラベル。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は128文字です。値は正規表現 /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ にマッチしなければならない。

--settings-tags ([]ストリング)

カタログ商品に関連付けられたタグ。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

デフォルト値は []です。リスト項目は正規表現 /^[a-zA-Z0-9][a-zA-Z0-9-_]*$/ にマッチしなければならない。最大長さは 10。最小の長さは 0。

--settings-product-id (文字列)

公開する製品 ID。このオプションは、JSON オプション「settings」のサブフィールドの値を提供します。このオプションと同時に指定することはできません。

最大長は36文字です。値は正規表現 /^[\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--output (文字列)

出力形式を選択します。'json'、'yaml'、'tui'、'table' のいずれかです。(デフォルトは 'table')

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project stack-definition-export \
    --project-id exampleString \
    --id exampleString \
    --settings '{"catalog_id": "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c", "target_version": "exampleString", "variation": "exampleString", "label": "Stack Deployable Architecture", "tags": []}'

あるいは、JSON ストリング・オプションのサブフィールドに対して細分化されたオプションを使用できます。

ibmcloud project stack-definition-export \
    --project-id exampleString \
    --id exampleString \
    --settings-catalog-id exampleString \
    --settings-target-version exampleString \
    --settings-variation exampleString \
    --settings-label exampleString \
    --settings-tags '[]'

出力例

プライベート・カタログへのスタック定義のエクスポートからの応答例

{
  "catalog_id" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c",
  "product_id" : "b60b5876-d074-478a-ac73-f979898c527b",
  "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.f9f73bdb-5c7d-4ea6-82ef-9debc6340df8",
  "kind" : "terraform",
  "format" : "stack",
  "tags" : [ ]
}

`ibmcloud project config-versions`

特定のプロジェクト内のプロジェクト構成の以前のバージョンと現行バージョンのリストを取得します。

ibmcloud project config-versions --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-versions \
    --project-id exampleString \
    --id exampleString

出力例

プロジェクト構成ドラフトをリストする要求に対する応答例。

{
  "versions" : [ {
    "definition" : {
      "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
    },
    "version" : 1,
    "state" : "approved",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5/versions/1"
  }, {
    "definition" : {
      "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
    },
    "version" : 2,
    "state" : "validated",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5/versions/2"
  } ]
}

デフォルトJMESPath

デフォルトJMESPath
応答	出力	照会
成功	デフォルト
	表	`versions`
エラー	デフォルト
	表	`versions`
すべてのページ	デフォルト
	表	`versions`

カスタムJMESPathクエリが提供された場合、それは上の表のJMESPathのいずれかを置き換える。

`ibmcloud project config-version`

プロジェクト内の構成の特定のバージョンを取得します。

ibmcloud project config-version [--project-id PROJECT-ID] --id ID --version VERSION

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--version (int64)

構成バージョン。必須。

最大値は 10000 である。最小値は 0です。

-q, --quiet (ブール)

冗長メッセージを抑制します。

例

ibmcloud project config-version \
    --project-id exampleString \
    --id exampleString \
    --version 0

V2 コンフィギュレーション

V2Configurations リソースのコマンド。

`ibmcloud project config-version-delete`

プロジェクト ID を指定して構成バージョンを削除します。

ibmcloud project config-version-delete [--project-id PROJECT-ID] --id ID --version VERSION

コマンド・オプション

--project-id (文字列)

固有のプロジェクト ID。プロジェクトが選択されていない場合は必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--id (文字列)

固有の構成 ID。必須。

最大長は128文字です。値は正規表現 /^[\\.\\-0-9a-zA-Z]+$/ にマッチしなければならない。

--version (int64)

構成バージョン。必須。

最大値は 10000 である。最小値は 0です。

例

ibmcloud project config-version-delete \
    --project-id exampleString \
    --id exampleString \
    --version 0

出力例

構成を削除する要求に対する応答例。

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

スキーマの例

以下のスキーマの例は、コマンド・オプションに指定する必要があるデータを表しています。これらの例はデータ構造を表すためのものであり、予期される値のタイプとして、プレースホルダーの値が含まれています。コマンドを実行するときには、これらの値を実際の環境に当てはまる値に適宜置き換えてください。

EnvironmentDefinitionPropertiesPatch

次の例は、 EnvironmentDefinitionPropertiesPatch オブジェクトのフォーマットを示している。


{
  "description" : "The environment development.",
  "name" : "development",
  "authorizations" : {
    "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
    "method" : "trusted_profile",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "compliance_profile" : {
    "id" : "some-profile-id",
    "instance_id" : "some-instance-id",
    "instance_location" : "us-south",
    "attachment_id" : "some-attachment-id",
    "profile_name" : "some-profile-name",
    "wp_policy_id" : "exampleString",
    "wp_instance_id" : "exampleString",
    "wp_instance_name" : "exampleString",
    "wp_instance_location" : "us-south",
    "wp_zone_id" : "exampleString",
    "wp_zone_name" : "exampleString",
    "wp_policy_name" : "exampleString"
  }
}

EnvironmentDefinitionRequiredProperties

次の例は、 EnvironmentDefinitionRequiredProperties オブジェクトのフォーマットを示している。


{
  "description" : "The environment development.",
  "name" : "development",
  "authorizations" : {
    "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
    "method" : "trusted_profile",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "compliance_profile" : {
    "id" : "some-profile-id",
    "instance_id" : "some-instance-id",
    "instance_location" : "us-south",
    "attachment_id" : "some-attachment-id",
    "profile_name" : "some-profile-name",
    "wp_policy_id" : "exampleString",
    "wp_instance_id" : "exampleString",
    "wp_instance_name" : "exampleString",
    "wp_instance_location" : "us-south",
    "wp_zone_id" : "exampleString",
    "wp_zone_name" : "exampleString",
    "wp_policy_name" : "exampleString"
  }
}

EnvironmentPrototype[]

次の例は、 EnvironmentPrototype[] オブジェクトのフォーマットを示している。


[ {
  "definition" : {
    "description" : "exampleString",
    "name" : "exampleString",
    "authorizations" : {
      "trusted_profile_id" : "exampleString",
      "method" : "exampleString",
      "api_key" : "exampleString"
    },
    "inputs" : {
      "anyKey" : "anyValue"
    },
    "compliance_profile" : { }
  }
} ]

ProjectComplianceProfile

次の例は、 ProjectComplianceProfile オブジェクトのフォーマットを示している。


{
  "id" : "exampleString",
  "instance_id" : "exampleString",
  "instance_location" : "us-south",
  "attachment_id" : "someattachmentid",
  "profile_name" : "SCCProfilev1.0",
  "wp_policy_id" : "exampleString",
  "wp_instance_id" : "exampleString",
  "wp_instance_name" : "exampleString",
  "wp_instance_location" : "us-south",
  "wp_zone_id" : "exampleString",
  "wp_zone_name" : "exampleString",
  "wp_policy_name" : "exampleString"
}

ProjectConfigAuth

次の例は、 ProjectConfigAuth オブジェクトのフォーマットを示している。


{
  "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
  "method" : "trusted_profile",
  "api_key" : "exampleString"
}

ProjectConfigDefinitionPatch

次の例は、 ProjectConfigDefinitionPatch オブジェクトのフォーマットを示している。


{
  "compliance_profile" : { },
  "locator_id" : "exampleString",
  "members" : [ {
    "name" : "exampleString",
    "config_id" : "exampleString"
  } ],
  "description" : "exampleString",
  "name" : "env-stage",
  "authorizations" : {
    "trusted_profile_id" : "exampleString",
    "method" : "exampleString",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "settings" : {
    "anyKey" : "anyValue"
  },
  "environment_id" : "exampleString"
}

ProjectConfigDefinitionPrototype

次の例は、 ProjectConfigDefinitionPrototype オブジェクトのフォーマットを示している。


{
  "compliance_profile" : { },
  "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
  "members" : [ {
    "name" : "exampleString",
    "config_id" : "exampleString"
  } ],
  "description" : "The stage environment configuration.",
  "name" : "env-stage",
  "authorizations" : {
    "trusted_profile_id" : "exampleString",
    "method" : "exampleString",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "settings" : {
    "anyKey" : "anyValue"
  },
  "environment_id" : "exampleString"
}

ProjectConfigPrototype[]

次の例は、 ProjectConfigPrototype[] オブジェクトのフォーマットを示している。


[ {
  "definition" : {
    "compliance_profile" : { },
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "members" : [ {
      "name" : "exampleString",
      "config_id" : "exampleString"
    } ],
    "description" : "The stage account configuration.",
    "name" : "account-stage",
    "authorizations" : {
      "trusted_profile_id" : "exampleString",
      "method" : "exampleString",
      "api_key" : "exampleString"
    },
    "inputs" : {
      "anyKey" : "anyValue"
    },
    "settings" : {
      "anyKey" : "anyValue"
    },
    "environment_id" : "exampleString"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"
  }
} ]

ProjectDefinitionPatch

次の例は、 ProjectDefinitionPatch オブジェクトのフォーマットを示している。


{
  "name" : "acme-microservice",
  "description" : "A microservice to deploy on top of ACME infrastructure.",
  "auto_deploy_mode" : "auto_approval",
  "monitoring_enabled" : true,
  "destroy_on_delete" : true,
  "store" : {
    "type" : "gh",
    "url" : "exampleString",
    "token" : "exampleString",
    "config_directory" : "exampleString"
  },
  "terraform_engine" : {
    "id" : "exampleString",
    "type" : "terraform-enterprise"
  },
  "auto_deploy" : true
}

ProjectDefinitionStore

次の例は、 ProjectDefinitionStore オブジェクトのフォーマットを示している。


{
  "type" : "gh",
  "url" : "exampleString",
  "token" : "exampleString",
  "config_directory" : "exampleString"
}

ProjectPrototypeDefinition

次の例は、 ProjectPrototypeDefinition オブジェクトのフォーマットを示している。


{
  "name" : "acme-microservice",
  "description" : "A microservice to deploy on top of ACME infrastructure.",
  "auto_deploy_mode" : "manual_approval",
  "monitoring_enabled" : false,
  "destroy_on_delete" : true,
  "store" : {
    "type" : "gh",
    "url" : "exampleString",
    "token" : "exampleString",
    "config_directory" : "exampleString"
  },
  "terraform_engine" : {
    "id" : "exampleString",
    "type" : "terraform-enterprise"
  },
  "auto_deploy" : false
}

ProjectTerraformEngineSettings

次の例は、 ProjectTerraformEngineSettings オブジェクトのフォーマットを示している。


{
  "id" : "exampleString",
  "type" : "terraform-enterprise"
}

SchematicsWorkspace

次の例は、 SchematicsWorkspace オブジェクトのフォーマットを示している。


{
  "workspace_crn" : "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"
}

StackDefinitionBlockPrototype

次の例は、 StackDefinitionBlockPrototype オブジェクトのフォーマットを示している。


{
  "inputs" : [ {
    "name" : "region",
    "type" : "string",
    "description" : "The IBM Cloud location where a resource is deployed.",
    "default" : "us-south",
    "required" : true,
    "hidden" : false
  } ],
  "outputs" : [ {
    "name" : "vpc_cluster_id",
    "value" : "cluster_id"
  } ]
}

StackDefinitionExportRequest

次の例は、 StackDefinitionExportRequest オブジェクトのフォーマットを示している。


{
  "catalog_id" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c",
  "target_version" : "exampleString",
  "variation" : "exampleString",
  "label" : "Stack Deployable Architecture",
  "tags" : [ ]
}

StackDefinitionInputVariable

次の例は、 StackDefinitionInputVariable オブジェクトのフォーマットを示している。


{
  "name" : "exampleString",
  "type" : "array",
  "description" : "exampleString",
  "default" : "exampleString",
  "required" : false,
  "hidden" : false
}

StackDefinitionOutputVariable

次の例は、 StackDefinitionOutputVariable オブジェクトのフォーマットを示している。


{
  "name" : "exampleString",
  "value" : "exampleString"
}

StackMember

次の例は、 StackMember オブジェクトのフォーマットを示している。


{
  "name" : "exampleString",
  "config_id" : "exampleString"
}

IBM Cloud プロジェクトのその他の関連コマンド

以下のコマンドはプロジェクト CLI プラグインの一部ではありませんが、プロジェクトにタグを付けるなどのプロジェクト関連タスクを実行するために使用できます。このリストは、プロジェクトで使用できるすべての関連コマンドを網羅しているわけではありません。代わりに、このリストは、プロジェクトで使用できる他のコマンドを探索するための開始点となります。

以下のコマンドの中には、実行する前に特定のプラグインをインストールする必要があるものがあります。

ibmcloud resource tag-attach を実行して、プロジェクトにタグを追加します。

ibmcloud resource tag-attach --tag-names TAG --resource-id PROJECT-CRN

実行 ibmcloud resource search を実行すると、プロジェクトのコンフィギュレーションによって作成されたアカウント内のすべてのリソースを取得できます：

ibmcloud resource search "service_tags:\"schematics::project_id:PROJECT_ID\""

ibmcloud schematics logs を実行して、 Schematics ワークスペースのログ・ファイルを取得します。

ibmcloud schematics logs --id WORKSPACE_ID [--act-id ACTION_ID]