リソースおよびリソース・グループの処理 (ibmcloud resource)

コマンド・オプション

--default

現行アカウントのデフォルト・グループを取得します。

例

現在のターゲット・アカウントのすべてのリソース・グループをリストします

ibmcloud resource groups

対象アカウントのデフォルトグループを表示します：

ibmcloud resource groups --default

コマンド・オプション

NAME (必須)

リソース・グループの名前

--id

ID のみを表示します

例

リソース・グループ example-group を表示します

ibmcloud resource group example-group

リソース・グループ example-group の ID のみを表示します

ibmcloud resource group example-group --id

コマンド・オプション

NAME (必須)

リソース・グループの名前

例

リソース・グループ example-group を作成します

ibmcloud resource group-create example-group

コマンド・オプション

NAME (必須)

ターゲット・リソース・グループの名前

-n, --name

リソース・グループの新しい名前

-f, --force

確認を求めずに更新を強制します

例

リソース・グループ example-group を trial-group に名前変更します

ibmcloud resource group-update example-group -n trial-group

コマンド・オプション

NAME (必須)

ターゲット・リソース・グループの名前

-f, --force

確認なしで削除を強制します

例

リソース・グループ example-group を削除します。

ibmcloud resource group-delete example-group -f

例

すべての割り当て量定義をリストします

ibmcloud resource quotas

コマンド・オプション

NAME (必須)

割り当て量の名前

例

割り当て量 free の詳細を表示します

ibmcloud resource quota free

コマンド・オプション

--service-name SERVICE_NAME

所属サービス名

--location LOCATION

ロケーション別のフィルター

--type INSTANCE_TYPE

インスタンスのタイプ。 service_instance タイプは、指定されていない場合に使用されます。 すべてのタイプのインスタンスをリストするには、all を使用します。

-g RESOURCE_GROUP

リソース・グループ名

--all-resource-groups

すべてのリソース・グループの照会

--long

出力により多くのフィールドを表示する

- --limit LIMIT

返却するリソースの数

- --offset OFFSET

開始リソース位置番号

--output FORMAT

出力フォーマットを指定します。 現在、JSON のみがサポートされています。

-q, --quiet

詳細出力を抑制します。

例

サービス test-service のサービス・インスタンスをリストします。

ibmcloud resource service-instances --service-name test-service

ページ・サイズが 10 のサービス・インスタンスの次のページをリストします

ibmcloud resource service-instances --offset 1 --limit 10

コマンド・オプション

NAME (必須)。ID と同時に指定することはできません。

サービス・インスタンスの名前

ID (必須)。NAME と同時に指定することはできません。

サービス・インスタンスの ID

--location

ロケーション別のフィルター

--id

サービスインスタンスのIDを表示する

例

サービス・インスタンス my-service-instance の詳細を表示します

ibmcloud resource service-instance my-service-instance

コマンド・オプション

NAME (必須)

サービス・インスタンスの名前

SERVICE_NAME または SERVICE_ID (必須)

サービスの名前または ID。 サービス・オファリングをリストするには、ibmcloud catalog service-marketplaceコマンドを使用します。

SERVICE_PLAN_NAME または SERVICE_PLAN_ID (必須)

サービス・プランの名前または ID

LOCATION (必須)

サービス・インスタンスを作成するターゲットの場所または環境

-d, --deployment DEPLOYMENT_NAME

デプロイメントの名前

-p, --parameters @JSONFILE または JSON_STRING

サービス・インスタンスを作成するパラメーターの JSON ファイルまたは JSON 文字列

-g RESOURCE_GROUP

リソース・グループ名

--service-endpoints SERVICE_ENDPOINTS_TYPE

サービス・エンドポイントのタイプ。 指定可能な値は「public」、「private」、「public-and-private」です。 サービス・エンドポイントのデフォルト値は、IBM Cloud®でサービスが設定したタイプです。

--allow-cleanup

リージョン・インスタンス削除の呼び出しの処理中にサービス・インスタンスを削除 (クリーンアップ) する必要があるかどうか

--lock

ロック状態のサービス・インスタンスを作成するかどうか

--subscription

このサービスとプランに関連するサブスクリプションID

例

ロケーション eu-gb 上のサービス test-service のサービスプラン test-service-plan を使用する、 my-service-instance という名前のサービスインスタンスを作成する：

ibmcloud resource service-instance-create my-service-instance test-service test-service-plan eu-gb

コマンド・オプション

名前 (必須)

サービス・インスタンスの名前。ID と同時に指定することはできません。

ID (必須)

サービス・インスタンスの ID。NAME と同時に指定することはできません。

-n, --name NEW_NAME

新規サービス・インスタンス名

--service-plan-id SERVICE_PLAN_ID

新規サービス・プラン ID

-p, --parameters @JSON_FILE | JSON_STRING

サービス・インスタンスを作成するパラメーターの JSON ファイルまたは JSON 文字列

-g RESOURCE_GROUP

リソース・グループ名

--service-endpoints SERVICE_ENDPOINTS_TYPE

サービス・エンドポイントのタイプ。 指定可能な値は「public」、「private」、「public-and-private」です。

-f, --force

確認を求めずに更新を強制します

例

サービス・インスタンス my-service-instance を更新し、その名前を new-service-instance に変更します

ibmcloud resource service-instance-update my-service-instance -n new-service-instance

コマンド・オプション

名前 (必須)

サービス・インスタンスの名前。ID と同時に指定することはできません。

ID (必須)

サービス・インスタンスの ID。NAME と同時に指定することはできません。

-f, --force

確認なしで削除を強制します

--recursive

従属リソースをすべて削除します

例

リソース・サービス・インスタンス my-service-instance を削除します

ibmcloud resource service-instance-delete my-service-instance

コマンド・オプション

名前 (必須)

サービス・インスタンスの名前。ID と同時に指定することはできません。

ID (必須)

サービス・インスタンスの ID。NAME と同時に指定することはできません。

-g RESOURCE_GROUP

リソース・グループ名

-f, --force

確認を求めずにロックを強制します

例

リソース・サービス・インスタンス my-service-instance をロックします

ibmcloud resource service-instance-lock my-service-instance

コマンド・オプション

名前 (必須)

サービス・インスタンスの名前。ID と同時に指定することはできません。

ID (必須)

サービス・インスタンスの ID。NAME と同時に指定することはできません。

-g RESOURCE_GROUP

リソース・グループ名

-f, --force

確認を求めずにロックを強制します

例

リソース・サービス・インスタンス my-service-instance をロック解除します

ibmcloud resource service-instance-unlock my-service-instance

コマンド・オプション

--instance-id

サービス・インスタンス ID

--instance-name

サービス・インスタンス名

例

サービス・インスタンス my-service-instance のサービス・キーをリストします

ibmcloud resource service-keys --instance-name my-service-instance

コマンド・オプション

名前

キーの名前

ID

キーの ID

-g

リソース・グループ名

--id

サービスキーのIDを表示する。 このオプションは、「--output」と同時に指定することはできません。

-g RESOURCE_GROUP

リソース・グループ名

例

サービス・キー my-service-key の詳細を表示します

ibmcloud resource service-key my-service-key

ID crn:v1:bluemix:public:cloudantnosqldb:us-south:a/537860630a5ba7115be954e8d5aa5689:cc2a6d6c-8f5e-4038-b975-b09b51d1d8dc:resource-key:9057f12e-fbf5-421d-8865-764422217a79 のサービス・キーの詳細を表示します。

ibmcloud resource service-key crn:v1:bluemix:public:cloudantnosqldb:us-south:a/537860630a5ba7115be954e8d5aa5689:cc2a6d6c-8f5e-4038-b975-b09b51d1d8dc:resource-key:9057f12e-fbf5-421d-8865-764422217a79

コマンド・オプション

NAME (必須)

キーの名前。

ROLE_NAME (オプション)

IAM サービス役割の名前。 指定された役割をデフォルトのプラットフォーム役割の 1 つにすることはできません。 ibmcloud iam roles --service <your-service> 実行し、ロールのCRNに serviceRole が表示されていることを確認することで、このオプションを使用するロールの適格性を確認できます。

--instance-id SERVICE_INSTANCE_ID

サービス・インスタンス ID。

--instance-name SERVICE_INSTANCE_NAME

サービス・インスタンス名。

--service-id SERVICE_ID

役割が属しているサービス ID の名前または UUID。 ROLE_NAME 省略されているか、None に設定されている場合のみ設定可能。

-p, --parameters @JSON_FILE | JSON_TEXT

パラメーター JSON ファイルまたは JSON 文字列。

-g RESOURCE_GROUP

リソース・グループ名。

--service-endpoint SERVICE_ENDPOINT_TYPE

サービス・エンドポイントのタイプ。 可能な値は「public」または「private」です。

--output FORMAT (オプション)

出力フォーマットを指定します。 JSON のみがサポートされます。

-f, --force

確認を求めずに作成を強制します

-q, --quite

詳細出力を抑制します。

例

役割 my-service-key を使用して、サービス・インスタンス Administrator に対して my-service-instance という名前のサービス・キーを作成します。

ibmcloud resource service-key-create my-service-key Administrator --instance-name my-service-instance

non-iam-enabled サービス・インスタンス my-service-key の役割を使用せずに、my-service-instance という名前のサービス・キーを作成します。

ibmcloud resource service-key-create my-service-key --instance-name my-service-instance

コマンド・オプション

NAME | ID

キーの名前または ID

-n, --name NEW_NAME

キーの新しい名前

-g RESOURCE_GROUP

キーが属するリソース・グループの ID

-f, --force

確認を求めずに更新を強制します

例

my-service-key という名前のサービス・キーを更新し、新しい名前 my-service-key-2 を付けます

ibmcloud resource service-key-update my-service-key -n my-service-key-2

コマンド・オプション

KEY_NAME | KEY_ID

キーの名前または ID

-f, --force

確認なしで削除を強制します

例

サービス・キー my-service-key を削除します

ibmcloud resource service-key-delete my-service-key

コマンド・オプション

-ir, --is-reclaimed

再利用されたアカウント・リソースを検索します。 しかし、デフォルトでは、検索はアクティブなリソースのみを返す。 is-reclaimedをanyに設定することで、再利用されているか否かにかかわらずリソースを検索することができる。 再利用されたリソースにのみ検索条件を適用するには、このオプションを true に設定します。 アクティブ・リソースのみを検索するには、このオプションを false に設定します。 false がデフォルトの動作です。

-o, -offset

開始リソース位置番号

-l, -limit

返すリソース数。最大で 10000。

-s, --sort-by

ソート基準のプロパティー。 受け入れられる値は、name、family、region、type、crn です。

-p, --provider

クラシック・インフラストラクチャー・リソースを表示します。 サポートされる値は classic-infrastructure のみです。

検索可能な属性

検索範囲を広げるために、多くの属性を検索することができます。 以下に例を示します。

名前

リソースのユーザー定義名。

リージョン

リソースがプロビジョンされている地理的位置。 例: us-south、us-east、au-syd、eu-gb、eu-de、jp-tok。

service_name

「ibmcloud catalog service-marketplace」の出力の名前列に表示されるサービスの名前。

creation_date

リソースが作成された日付。

modification_date

リソースの最終変更日。

検索できる属性の完全なリストについては、リソースの検索 を参照してください。

例

指定された場所(つまりus-southリージョン)のリソースコントローラーリソースを検索します：

ibmcloud resource search "region:us-south AND family:resource_controller"

デフォルトの名前を持つリソース・グループを検索します。

ibmcloud resource search "name:default AND type:resource-group"

指定したクラウド・リソース名 (CRN) を持つリソースを検索します。

ibmcloud resource search "crn:\"crn:v1:bluemix:public:cloudantnosqldb:us-south:s/4948af7e-cc78-4321-998a-e549dd5e9210:41a031cd-e9e5-4c46-975d-9e4a6391322e:cf-service-instance:\""

指定したタグを持つリソースを検索します。

ibmcloud resource search "tags:\"mykey:myvalue\""

指定した ID を持つクラシック・インフラストラクチャー仮想ゲスト・リソースを検索します (-p classic-infrastructure が指定されている場合のみ)。

ibmcloud resource search "id:12345678 _objectType:SoftLayer_Virtual_Guest"

指定したタグ名を持つクラシック・インフラストラクチャー・ハードウェア・リソースを検索します (-p classic-infrastructure が指定されている場合のみ)。

ibmcloud resource search "tagReferences.tag.name:name _objectType:SoftLayer_Hardware"

コマンド・オプション

SUBSCRIPTION_ID (必須)

サブスクリプションの SUBSCRIPTION_ID フィールド

例

サブスクリプションの詳細を表示 my-subscription-id ：

ibmcloud resource subscription my-subscription-id

コマンド・オプション

--output 値

出力フォーマットを指定します。 現在、JSON のみがサポートされています。

コマンド・オプション

--offset 値, -o 値

開始リソース位置番号 (デフォルト: 0)。

--limit 値, -l 値

返されるリソースの数 (最大 1000) (デフォルト: 100)。

--provider 値, -p 値

クラシックインフラストラクチャリソースを表示する。 タイプが SoftLayer_Hardware、SoftLayer_Network_Application_Delivery_Controller、SoftLayer_Network_Subnet_IpAddress、または SoftLayer_Network_Vlan のリソースにそれを使用します。

--details 値, -d 値

各タグの追加属性を表示します。許可される値は true のみです。

--attached 値, -a 値

リソースに付けられたタグのうち、フィルタリングされたものだけを表示する。

--tag-type 値

タグのタイプ。 許可される値は、user、service、access のいずれかです（デフォルト値：user）。

--account-id 値

リストしようとしているタグを所有するアカウントの ID (tag-type が service に設定されている場合に必要)。

--output 値

出力フォーマットを指定します。 現在、JSON のみがサポートされています。

-q, --quiet

詳細出力を抑制します。

コマンド・オプション

--tag-names 値

タグ名のコンマ区切りリスト。

-q, --quiet

詳細出力を抑制します。

このコマンドは、アクセス管理タグにのみ有効です。 以下に例を示します。

• アクセス管理タグ project:myproject を作成するには、以下のコマンドを実行します。

  ibmcloud resource tag-create —tag-names “project:myproject”
  

コマンド・オプション

--tag-names 値

タグ名のコンマ区切りリスト。

--resource-name 値

タグを付けなければならないリソースの名前。

--resource-id 値

タグをアタッチするリソースの CRN (クラシック・インフラストラクチャー・リソースの場合、リソースの ID)。

--resource-type 値

タグのタイプ。 許可される値は、user、service、または access のみです (デフォルト値: user)。

--tag-type 値

タグのタイプ。 許可される値は、user または service のみです。 デフォルト値はuserです。

--account-id 値

タグ付けされるリソースを所有するアカウントの ID (tag-type が service に設定されている場合に必要)。

--replace

タグ名のリストは、リソースに添付されている現在のタグ名のリストを置き換える。

--update

key:value という形式のタグ名が更新されます。 このオプションは、その形式ではないタグ名には影響しません。

-q, --quiet

詳細出力を抑制します。

例

• ユーザー・タグ MyTag を MyCluster という名前の Kubernetes クラスターにアタッチするには、最初に以下のようにして、タグをアタッチしようとしているクラスターの CRN を検索します。

  ibmcloud resource search 'type:k8\-cluster AND name:MyCluster'
  

  CRN をメモします。CRN は以下の例のようなストリングです。

  crn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

  タグをアタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names MyTag --resource-id rn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• ユーザー・タグ MyTag を MyResource という名前のリソースにアタッチするには、以下のようにします。

  ibmcloud resource tag-attach --tag-name MyTag --resource-name  'MyResource'
  

• ユーザー・タグ MyTag を MyVM という名前のクラシック・インフラストラクチャー仮想ゲストにアタッチするには、最初に以下のようにして、タグをアタッチしようとしている仮想ゲストの ID を検索します。

  ibmcloud resource search 'fullyQualifiedDomainName:MyVM  _objectType:SoftLayer_Virtual_Guest' -p classic-infrastructure
  

  ID をメモします。ID は 48373549 のようなストリングです。

  タグをアタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names MyTag --resource-id 48373549 --resource-type SoftLayer_Virtual_Guest
  

• 以前に作成したアクセス管理タグ project:myproject を Project data という IBM Cloud Object Storage のインスタンスにアタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names "project:myproject" --resource-name Project data -—tag-type access
  

• MyResource という名前のリソースの env ユーザー・タグの値を production に更新するには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names 'env:production' --resource-name 'MyResource' --update
  

• MyResource という名前のリソースで env アクセス管理タグの値を production に更新するには、次のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names 'env:production' --resource-name 'MyResource' --update --tag-type access
  

• MyResource のすべてのユーザー・タグを新しいタグ・セット tag1、 tag2、および tag3 で置き換えるには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names 'tag1,tag2,tag3' --resource-name 'MyResource' --replace
  

• MyResource のすべてのアクセス管理タグをタグ compliance:hipaa で置き換えるには、以下のコマンドを実行します。

  ibmcloud resource tag-attach --tag-names 'compliance:hipaa' --resource-name 'MyResource' --replace --tag-type access
  

コマンド・オプション

--tag-names 値

タグ名のコンマ区切りリスト。

--resource-name 値

タグを付けるリソースの名前。

--resource-id 値

タグをアタッチするリソースの CRN (クラシック・インフラストラクチャー・リソースの場合、リソースの ID)。

--resource-type 値

タグをアタッチするリソース・タイプ (タイプ SoftLayer_Hardware、SoftLayer_Network_Application_Delivery_Controller、SoftLayer_Network_Subnet_IpAddress、または SoftLayer_Network_Vlan のクラシック・インフラストラクチャー・リソースの場合にのみ必要)。

--tag-type 値

タグのタイプ。 許可される値は、user、service、access のいずれかです（デフォルト値：user）。

--account-id 値

デタッチされるリソースを所有するアカウントの ID (tag-type が service に設定されている場合に必要)。

-q, --quiet

詳細出力を抑制します。

例

• ユーザー・タグ MyTag を MyCluster という名前の Kubernetes クラスターからデタッチするには、最初に以下のようにして、タグをデタッチしようとしているクラスターの CRN を検索します。

  ibmcloud resource search 'type:k8\-cluster AND name:MyCluster'
  

  CRN をメモします。CRN は以下の例のようなストリングです。

  crn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• タグをデタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-detach --tag-names MyTag --resource-id rn:v1:bluemix:public:containers-kubernetes:us-south:a/a27a4741a57dcf5c965939adb66fe1c7:a46242e638ca47b09f10e9a3cbe5687a::
  

• ユーザー・タグ MyTag を MyResource という名前のリソースからデタッチするには、以下のようにします。

  ibmcloud resource tag-detach --tag-name MyTag --resource-name 'MyResource'
  

• ユーザー・タグ MyTag を MyVM という名前のクラシック・インフラストラクチャー仮想ゲストからデタッチするには、最初に以下のようにして、タグをデタッチしようとしている仮想ゲストの ID を検索します。

  ibmcloud resource search 'fullyQualifiedDomainName:MyVM  _objectType:SoftLayer_Virtual_Guest' -p classic-infrastructure
  

  ID をメモします。ID は 48373549 のようなストリングです。

• タグをデタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-detach --tag-names MyTag --resource-id 48373549 --resource-type SoftLayer_Virtual_Guest
  

• アクセス管理タグ project:myproject を Project data という IBM Cloud Object Storage のインスタンスからデタッチするには、以下のコマンドを実行します。

  ibmcloud resource tag-detach --tag-names "project:myproject" --resource-name Project data -—tag-type access
  

• MyResource から env:value タグを切り離すには、その値に関係なく、以下のコマンドを実行します。

  ibmcloud resource tag-detach --tag-names 'env:*' —resource-name 'MyResource'
  

• MyResource からすべてのタグを切り離すには、次のコマンドを実行します。

  ibmcloud resource tag-detach --tag-names '*' —resource-name 'MyResource'
  

コマンド・オプション

--tag-name 値

削除するタグ名。

--provider 値, -p 値

指定されたプロバイダーのタグを削除します（サポートされる値はclassic-infrastructureのみです）。 タイプが SoftLayer_Hardware、SoftLayer_Network_Application_Delivery_Controller、SoftLayer_Network_Subnet_IpAddress、または SoftLayer_Network_Vlan のリソースにそれを使用します。

--tag-type 値

タグのタイプ。 許可される値は、user、service、access のいずれかです（デフォルト値：user）。

account-id 値

削除されるタグを所有するアカウントの ID (tag-type が service に設定されている場合に必要)。

--force, -f

確認を求めずにタグを削除します。

--all, -a

リソースにアタッチされていないタグをすべて削除する。

-q, --quiet

詳細出力を抑制します。

タグは、リソースにアタッチされていない場合にのみ削除できます。

例

• ユーザー・タグ MyTag をアカウントから削除するには、以下のようにします。

  ibmcloud resource tag-delete --tag-name "MyTag"
  

• アクセス管理タグ project:myproject をアカウントから削除するには、以下のようにします。

  ibmcloud resource tag-delete --tag-name "project:myproject" --tag-type access
  

• 未使用のユーザー・タグをアカウントからすべて削除するには、以下のようにします。

  ibmcloud resource tag-delete -a
  

• 未使用のアクセス管理タグをアカウントからすべて削除するには、以下のようにします。

  ibmcloud resource tag-delete -a --tag-type access
  

コマンド・オプション

--resource-instance-id

リソース・インスタンスのグローバル一意 ID (GUID)

例

すべてのリソース回収をリストします。

ibmcloud resource reclamations

特定のサービス・インスタンスのリソースの再利用をリストします。

ibmcloud resource reclamations --resource-instance-id abcd1234-ef56-486e-b293-22d6c7eb6699

コマンド・オプション

RECLAMATION_ID

リソース回収 ID

例

リソース回収の詳細を表示します。

ibmcloud resource reclamation daf12d343ef

コマンド・オプション

ID

リソース回収 ID

--comment

アクションについてのコメント

例

ID が d9fendfwlw のリソース回収をリストアします。

ibmcloud resource reclamation-restore "d9fendfwlw"

ID d9fendfwlwを使用してリソースの再利用を復元し、 need to use for another 3 monthsのコメントを残し、JSON 出力を表示します：

ibmcloud resource reclamation-restore "d9fendfwlw" --comment "need to use for another 3 months" --output JSON

コマンド・オプション

ID

リソース回収 ID

--comment

アクションについてのコメント

-f, --force

確認なしで削除を強制します

例

ID が d9fendfwlw のリソース回収を削除します。

ibmcloud resource reclamation-delete "d9fendfwlw"

ID d9fendfwlw のリソース再利用を削除し、確認を求めずに no longer needed のコメントを残します：

ibmcloud resource reclamation-delete "d9fendfwlw" --comment "no longer needed" -f