次の方法で共有

az cosmosdb postgres cluster

Azure Cosmos DB for PostgreSQL クラスターを管理します。

コマンド

名前 説明 型 状態
az cosmosdb postgres cluster create

ノードを含む新しいクラスターを作成します。

 Core GA
az cosmosdb postgres cluster delete

クラスターをその中のノードと共に削除します。

 Core GA
az cosmosdb postgres cluster list

サブスクリプションまたはリソース グループ内のすべてのクラスターを一覧表示します。

 Core GA
az cosmosdb postgres cluster promote

読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格させます。

 Core GA
az cosmosdb postgres cluster restart

クラスター内のすべてのノードを再起動します。

 Core GA
az cosmosdb postgres cluster server

Azure Cosmos DB for PostgreSQL クラスター サーバーを管理します。

 Core GA
az cosmosdb postgres cluster server list

クラスターのノードを一覧表示します。

 Core GA
az cosmosdb postgres cluster server show

クラスター内のノードに関する情報を取得します。

 Core GA
az cosmosdb postgres cluster show

コンピューティングとストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。

 Core GA
az cosmosdb postgres cluster start

すべてのクラスター ノードで停止コンピューティングを開始します。

 Core GA
az cosmosdb postgres cluster stop

すべてのクラスター ノードでコンピューティングを停止します。

 Core GA
az cosmosdb postgres cluster update

既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。

 Core GA
az cosmosdb postgres cluster wait

条件が満たされるまで CLI を待機状態にします。

 Core GA

az cosmosdb postgres cluster create

編集

ノードを含む新しいクラスターを作成します。

次のリファレンスを使用して、Azure Cosmos DB for PostgreSQL クラスターおよびノード CLI コマンドでサポートされているさまざまなパラメーターの値を確認します: https://learn.microsoft.com/rest/api/postgresqlhsc/#values。

az cosmosdb postgres cluster create --cluster-name --name
                                    --resource-group
                                    [--administrator-login-password --login-password]
                                    [--citus-version]
                                    [--coord-public-ip-access --coordinator-enable-public-ip-access {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--coord-server-edition --coordinator-server-edition]
                                    [--coordinator-storage --coordinator-storage-quota-in-mb]
                                    [--coordinator-v-cores]
                                    [--enable-ha {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--enable-shards-on-coord --enable-shards-on-coordinator {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--location]
                                    [--maintenance-window]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--node-count]
                                    [--node-enable-public-ip-access --node-public-ip-access {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--node-server-edition]
                                    [--node-storage --node-storage-quota-in-mb]
                                    [--node-v-cores]
                                    [--point-in-time-utc]
                                    [--postgresql-version]
                                    [--preferred-primary-zone]
                                    [--source-location]
                                    [--source-resource-id]
                                    [--tags]

例

新しい単一ノード クラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password"

特定の時点の復元として新しいクラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --point-in-time-utc "2017-12-14T00:00:37.467Z" --source-location "eastus" --source-resource-id "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster"

読み取りレプリカとして新しいクラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --source-location "eastus" --source-resource-id "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster"

新しいマルチノード クラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord false --node-count 3 --node-server-edition "MemoryOptimized" --node-v-cores 8 --node-storage 131072 --postgresql-version "15" --preferred-primary-zone "1" --administrator-login-password "password"

新しい単一ノードバースト可能な 1 仮想コア クラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 1 --coordinator-server-edition "BurstableMemoryOptimized" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password"

新しい単一ノードバースト可能な 2 仮想コア クラスターを作成する

az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 2 --coordinator-server-edition "BurstableGeneralPurpose" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password"

必須のパラメーター

--cluster-name --name -n

クラスターの名前です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--administrator-login-password --login-password

管理者ログインのパスワード。 作成に必要です。 値が空白の場合は、tty から要求されます。

プロパティ 値
Parameter group: Properties Arguments
--citus-version

すべてのクラスター サーバー上の Citus 拡張機能バージョン。

プロパティ 値
Parameter group: Properties Arguments
--coord-public-ip-access --coordinator-enable-public-ip-access

コーディネーターでパブリック アクセスが有効になっている場合。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--coord-server-edition --coordinator-server-edition

コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。

プロパティ 値
Parameter group: Properties Arguments
--coordinator-storage --coordinator-storage-quota-in-mb

サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--coordinator-v-cores

サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--enable-ha

高可用性 (HA) がクラスターに対して有効になっているかどうか。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enable-shards-on-coord --enable-shards-on-coordinator

コーディネーターのシャードがクラスターに対して有効になっているかどうか。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

プロパティ 値
Parameter group: Parameters Arguments
--maintenance-window

クラスターのメンテナンス期間。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
Parameter group: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--node-count

クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。

プロパティ 値
Parameter group: Properties Arguments
--node-enable-public-ip-access --node-public-ip-access

ワーカー ノードでパブリック アクセスが有効になっている場合。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--node-server-edition

ノード サーバーのエディション (既定値: MemoryOptimized)。

プロパティ 値
Parameter group: Properties Arguments
--node-storage --node-storage-quota-in-mb

各ワーカー ノードのストレージ (MB 単位)。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--node-v-cores

各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--point-in-time-utc

クラスターの復元の UTC (ISO8601形式) の日付と時刻。

プロパティ 値
Parameter group: Properties Arguments
--postgresql-version

すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。

プロパティ 値
Parameter group: Properties Arguments
--preferred-primary-zone

すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。

プロパティ 値
Parameter group: Properties Arguments
--source-location

読み取りレプリカ クラスターのソース クラスターの Azure リージョン。

プロパティ 値
Parameter group: Properties Arguments
--source-resource-id

読み取りレプリカ クラスターのソース クラスターのリソース ID。

プロパティ 値
Parameter group: Properties Arguments
--tags

Resource tags. 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
Parameter group: Parameters Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster delete

編集

クラスターをその中のノードと共に削除します。

az cosmosdb postgres cluster delete [--cluster-name --name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

例

クラスターを削除する

az cosmosdb postgres cluster delete -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster list

編集

サブスクリプションまたはリソース グループ内のすべてのクラスターを一覧表示します。

az cosmosdb postgres cluster list [--resource-group]

例

リソース グループ内のクラスターを一覧表示する

az cosmosdb postgres cluster list -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

サブスクリプション内のクラスターを一覧表示する

az cosmosdb postgres cluster list --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster promote

編集

読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格させます。

az cosmosdb postgres cluster promote [--cluster-name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

例

読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格させる

az cosmosdb postgres cluster promote -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster restart

編集

クラスター内のすべてのノードを再起動します。

az cosmosdb postgres cluster restart [--cluster-name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

例

クラスター内のすべてのサーバーを再起動する

az cosmosdb postgres cluster restart -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster show

編集

コンピューティングとストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。

az cosmosdb postgres cluster show [--cluster-name --name]
                                  [--ids]
                                  [--resource-group]
                                  [--subscription]

例

クラスターの詳細を表示する

az cosmosdb postgres cluster show -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster start

編集

すべてのクラスター ノードで停止コンピューティングを開始します。

az cosmosdb postgres cluster start [--cluster-name]
                                   [--ids]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]

例

クラスター内のすべてのサーバーを起動する

az cosmosdb postgres cluster start -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster stop

編集

すべてのクラスター ノードでコンピューティングを停止します。

az cosmosdb postgres cluster stop [--cluster-name]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]

例

クラスター内のすべてのサーバーを停止する

az cosmosdb postgres cluster stop -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster update

編集

既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。

次のリファレンスを使用して、Azure Cosmos DB for PostgreSQL クラスターおよびノード CLI コマンドでサポートされているさまざまなパラメーターの値を確認します: https://learn.microsoft.com/rest/api/postgresqlhsc/#values。

az cosmosdb postgres cluster update [--administrator-login-password --login-password]
                                    [--citus-version]
                                    [--cluster-name --name]
                                    [--coord-public-ip-access --coordinator-enable-public-ip-access {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--coord-server-edition --coordinator-server-edition]
                                    [--coordinator-storage --coordinator-storage-quota-in-mb]
                                    [--coordinator-v-cores]
                                    [--enable-ha {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--enable-shards-on-coord --enable-shards-on-coordinator {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--maintenance-window]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--node-count]
                                    [--node-server-edition]
                                    [--node-storage --node-storage-quota-in-mb]
                                    [--node-v-cores]
                                    [--postgresql-version]
                                    [--preferred-primary-zone]
                                    [--resource-group]
                                    [--subscription]
                                    [--tags]

例

ワーカー ノードのコンピューティングのスケールアップまたはスケールダウン

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-v-cores 16

スケールアウト: 新しいワーカー ノードを追加する

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-count 2

ワーカー ノード ストレージをスケールアップする

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-storage 2097152

クラスターの複数の構成設定を更新する

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-v-cores 16 --node-count 4 coordinator-v-cores 16 --administrator-login-password "newPassword"

メンテナンス期間を更新または定義する

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --maintenance-window day-of-week=1 start-hour=2 --start-minute=0 custom-window="Enabled"

PostgreSQL メジャー バージョンのアップグレード

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --postgresql-version "15"

コーディネーター ストレージをスケールアップする

az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --coordinator-storage 2097152

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--administrator-login-password --login-password

管理者ログインのパスワード。 作成に必要です。 値が空白の場合は、tty から要求されます。

プロパティ 値
Parameter group: Properties Arguments
--citus-version

すべてのクラスター サーバー上の Citus 拡張機能バージョン。

プロパティ 値
Parameter group: Properties Arguments
--cluster-name --name -n

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--coord-public-ip-access --coordinator-enable-public-ip-access

コーディネーターでパブリック アクセスが有効になっている場合。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--coord-server-edition --coordinator-server-edition

コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。

プロパティ 値
Parameter group: Properties Arguments
--coordinator-storage --coordinator-storage-quota-in-mb

サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--coordinator-v-cores

サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--enable-ha

高可用性 (HA) がクラスターに対して有効になっているかどうか。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enable-shards-on-coord --enable-shards-on-coordinator

コーディネーターのシャードがクラスターに対して有効になっているかどうか。

プロパティ 値
Parameter group: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--maintenance-window

クラスターのメンテナンス期間。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
Parameter group: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--node-count

クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。

プロパティ 値
Parameter group: Properties Arguments
--node-server-edition

ノード サーバーのエディション (既定値: MemoryOptimized)。

プロパティ 値
Parameter group: Properties Arguments
--node-storage --node-storage-quota-in-mb

各ワーカー ノードのストレージ (MB 単位)。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--node-v-cores

各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、https://learn.microsoft.com/rest/api/postgresqlhsc/#values を参照してください。

プロパティ 値
Parameter group: Properties Arguments
--postgresql-version

すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。

プロパティ 値
Parameter group: Properties Arguments
--preferred-primary-zone

すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。

プロパティ 値
Parameter group: Properties Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--tags

キーと値のペアの形式のアプリケーション固有のメタデータ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
Parameter group: Parameters Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb postgres cluster wait

編集

条件が満たされるまで CLI を待機状態にします。

az cosmosdb postgres cluster wait [--cluster-name --name]
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

クラスターの名前です。

プロパティ 値
Parameter group: Resource Id Arguments
--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ 値
Parameter group: Wait Condition Arguments
--deleted

削除されるまで待ちます。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: False
--exists

リソースが存在するまで待ちます。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: False
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
Parameter group: Resource Id Arguments
--interval

ポーリング間隔 (秒単位)。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: 30
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
Parameter group: Resource Id Arguments
--timeout

最大待機時間 (秒単位)。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ 値
Parameter group: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False