az postgres server-arc

Note

このリファレンスは、Azure CLI (バージョン 2.3.1 以降) の arcdata 拡張機能の一部です。 拡張機能は、az postgres server-arc コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーを管理します。

コマンド

名前	説明	型	Status
az postgres server-arc create	Azure Arc 対応 PostgreSQL サーバーを作成します。	拡張	プレビュー
az postgres server-arc delete	Azure Arc 対応 PostgreSQL サーバーを削除します。	拡張	プレビュー
az postgres server-arc endpoint	Azure Arc 対応 PostgreSQL サーバー エンドポイントを管理します。	拡張	プレビュー
az postgres server-arc endpoint list	Azure Arc 対応 PostgreSQL サーバー エンドポイントを一覧表示します。	拡張	プレビュー
az postgres server-arc list	Azure Arc 対応 PostgreSQL サーバーを一覧表示します。	拡張	プレビュー
az postgres server-arc restore	Azure Arc 対応 PostgreSQL サーバーを別のサーバーからのバックアップから復元します。	拡張	プレビュー
az postgres server-arc show	Azure Arc 対応 PostgreSQL サーバーの詳細を表示します。	拡張	プレビュー
az postgres server-arc update	Azure Arc 対応 PostgreSQL サーバーの構成を更新します。	拡張	プレビュー

az postgres server-arc create

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーを作成します。

サーバーのパスワードを設定するには、環境変数をAZDATA_PASSWORD設定してください。

az postgres server-arc create --name
                              [--ad-account-name]
                              [--ad-connector-name]
                              [--admin-login-secret]
                              [--cert-private-key-file]
                              [--cert-public-key-file]
                              [--cores-limit]
                              [--cores-request]
                              [--dev]
                              [--dns-name]
                              [--extensions]
                              [--k8s-namespace]
                              [--keytab-secret]
                              [--log-level]
                              [--memory-limit]
                              [--memory-request]
                              [--no-external-endpoint]
                              [--no-wait]
                              [--path]
                              [--port]
                              [--retention-days]
                              [--service-annotations]
                              [--service-cert-secret]
                              [--service-labels]
                              [--service-type]
                              [--storage-class-backups]
                              [--storage-class-data]
                              [--storage-class-logs]
                              [--use-k8s]
                              [--volume-size-backups]
                              [--volume-size-data]
                              [--volume-size-logs]

例

Azure Arc 対応 PostgreSQL サーバーを作成します。

az postgres server-arc create -n pg1 --k8s-namespace namespace --use-k8s

必須のパラメーター

--name -n

Azure Arc 対応 PostgreSQL サーバーの名前。

省略可能のパラメーター

--ad-account-name

この Azure Arc 対応 PostgreSQL サーバーの Active Directory アカウント名。 このアカウントは、このインスタンスをデプロイする前に作成する必要があります。

--ad-connector-name

Active Directory コネクタの名前。 このパラメーターは、AD サポートを使用してデプロイする意図を示します。

--admin-login-secret

生成され、管理者ユーザーのログイン アカウントの資格情報をホストする (予定の) Kubernetes シークレットの名前。

--cert-private-key-file

クライアント SSL 接続に使用する PEM 形式の証明書秘密キーを含むファイルへのパス。

--cert-public-key-file

クライアント SSL 接続に使用する PEM 形式の証明書公開キーを含むファイルへのパス。

--cores-limit

Azure Arc 対応 PostgreSQL サーバーに使用できる CPU コアの最大数。

--cores-request

サービスをスケジュールするためにノードごとに使用できる必要がある CPU コアの最小数。

--dev

これを指定した場合、それは dev インスタンスと見なされ、課金されません。

--dns-name

この Azure Arc 対応 PostgreSQL サーバーに接続するためにエンド ユーザーに公開されるサービス DNS 名 (例: pginstancename.contoso.com)。

--extensions

有効にする拡張機能のコンマ区切りの一覧。 有効にすると、'CREATE EXTENSION' コマンドを使用して拡張機能をインストールできます。

--k8s-namespace -k

Azure Arc 対応 PostgreSQL サーバーがデプロイされている Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--keytab-secret

この Azure Arc 対応 PostgreSQL サーバーの keytab ファイルを含む Kubernetes シークレットの名前。

--log-level

PostgreSQL エンジンのlog_min_messages設定を設定します。 有効な値は、DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING、ERROR、LOG、FATAL、PANIC です。

--memory-limit

Azure Arc 対応 PostgreSQL サーバーのメモリ制限。その後に Ki (キロバイト)、Mi (メガバイト)、Gi (ギガバイト) が続きます。

--memory-request

Azure Arc 対応 PostgreSQL サーバーのメモリ要求。その後に Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト) が続きます。

--no-external-endpoint

指定した場合、外部サービスは作成されません。 それ以外の場合は、--service-type 引数で指定された型またはデータ コントローラーと同じサービス型を使用して、外部サービスが作成されます。

--no-wait

戻る前に、デプロイの準備が整うのを待つ必要はありません。

既定値: False

--path

Azure Arc 対応 PostgreSQL サーバーのソース json ファイルへのパス。 これは省略可能です。

--port

プライマリ サービスがエンド ユーザーに公開されるポート番号。

--retention-days

バックアップの保有期間 (日数で指定)。 使用できる値は 0 ~ 35 です。 既定値は 7 です。 リテンション期間を 0 に設定すると、Azure Arc 対応 PostgreSql の自動バックアップがオフになります。

--service-annotations

すべての外部サービスに適用する注釈のコンマ区切りリスト。

--service-cert-secret

SSL 証明書をホストする生成する Kubernetes シークレットの名前。

--service-labels

すべての外部サービスに適用するラベルのコンマ区切りリスト。

--service-type

プライマリ サービスの種類。

--storage-class-backups

バックアップ永続ボリュームに使用するストレージ クラス。

--storage-class-data

データ永続ボリュームに使用するストレージ クラス。

--storage-class-logs

ログ永続ボリュームに使用するストレージ クラス。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

--volume-size-backups

バックアップに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

--volume-size-data

データに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

--volume-size-logs

ログに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az postgres server-arc delete

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーを削除します。

az postgres server-arc delete --name
                              [--force]
                              [--k8s-namespace]
                              [--use-k8s]

例

Azure Arc 対応 PostgreSQL サーバーを削除します。

az postgres server-arc delete -n pg1 --k8s-namespace namespace --use-k8s

必須のパラメーター

--name -n

Azure Arc 対応 PostgreSQL サーバーの名前。

省略可能のパラメーター

--force -f

確認なしで Azure Arc 対応 PostgreSQL サーバーを削除します。

既定値: False

--k8s-namespace -k

Azure Arc 対応 PostgreSQL サーバーがデプロイされている Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az postgres server-arc list

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーを一覧表示します。

az postgres server-arc list [--k8s-namespace]
                            [--use-k8s]

例

Azure Arc 対応 PostgreSQL サーバーを一覧表示します。

az postgres server-arc list --k8s-namespace namespace --use-k8s

省略可能のパラメーター

--k8s-namespace -k

Azure Arc 対応 PostgreSQL サーバーがデプロイされている Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az postgres server-arc restore

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーを別のサーバーからのバックアップから復元します。

サーバーのパスワードを設定するには、環境変数をAZDATA_PASSWORD設定してください。

az postgres server-arc restore --k8s-namespace
                               --name
                               --source-server
                               [--dry-run]
                               [--no-wait]
                               [--storage-class-backups]
                               [--storage-class-data]
                               [--storage-class-logs]
                               [--time]
                               [--use-k8s]
                               [--volume-size-backups]
                               [--volume-size-data]
                               [--volume-size-logs]

例

Azure Arc 対応 PostgreSQL サーバーを復元します。

az postgres server-arc restore -n <to-pg> --source-server <from-pg> --k8s-namespace namespace --use-k8s

必須のパラメーター

--k8s-namespace -k

Azure Arc 対応 PostgreSql を含む Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--name -n

作成する Azure Arc 対応 PostgreSQL サーバーの名前。

--source-server

復元元の Azure Arc 対応 PostgreSQL サーバーの名前。

省略可能のパラメーター

--dry-run

設定されている場合は、復元を実行せずに、ソースとターゲットのリソースと時刻を検証します。 復元タスクの状態では、復元可能な最も早い時刻と最新の復元時間が返されます。

既定値: False

--no-wait

戻る前に、デプロイの準備が整うのを待つ必要はありません。

既定値: False

--storage-class-backups

バックアップ永続ボリュームに使用するストレージ クラス。

--storage-class-data

データ永続ボリュームに使用するストレージ クラス。

--storage-class-logs

ログ永続ボリュームに使用するストレージ クラス。

--time -t

新しい Azure Arc 対応 PostgreSQL サーバーを作成するために復元されるソース サーバーの時点。 ソース データベースの最も古い復元日時の値以上である必要があります。 時刻は、"YYYY-MM-DDTHH:MM:SSZ" の形式にする必要があります。 時刻が指定されていない場合は、最新のバックアップが復元されます。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

--volume-size-backups

バックアップに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

--volume-size-data

データに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

--volume-size-logs

ログに使用するストレージ ボリュームのサイズを示す正の数値と、その後の Ki (キロバイト)、Mi (メガバイト)、または Gi (ギガバイト)。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az postgres server-arc show

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーの詳細を表示します。

az postgres server-arc show --name
                            [--k8s-namespace]
                            [--path]
                            [--use-k8s]

例

Azure Arc 対応 PostgreSQL サーバーの詳細を表示します。

az postgres server-arc show -n pg1 --k8s-namespace namespace --use-k8s

必須のパラメーター

--name -n

Azure Arc 対応 PostgreSQL サーバーの名前。

省略可能のパラメーター

--k8s-namespace -k

Azure Arc 対応 PostgreSQL サーバーがデプロイされている Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--path

Azure Arc 対応 PostgreSQL サーバーの完全な仕様を記述する必要があるパス。 省略した場合、仕様は標準出力に書き込まれます。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az postgres server-arc update

プレビュー

コマンド グループ 'postgres server-arc' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Arc 対応 PostgreSQL サーバーの構成を更新します。

az postgres server-arc update --name
                              [--cert-private-key-file]
                              [--cert-public-key-file]
                              [--cores-limit]
                              [--cores-request]
                              [--dev]
                              [--extensions]
                              [--k8s-namespace]
                              [--keytab-secret]
                              [--log-level]
                              [--memory-limit]
                              [--memory-request]
                              [--no-external-endpoint]
                              [--no-wait]
                              [--path]
                              [--port]
                              [--retention-days]
                              [--service-annotations]
                              [--service-cert-secret]
                              [--service-labels]
                              [--service-type]
                              [--use-k8s]

例

Azure Arc 対応 PostgreSQL サーバーの構成を更新します。

az postgres server-arc update --path ./spec.json -n pg1 --k8s-namespace namespace --use-k8s

既存の Azure Arc 対応 PostgreSQL サーバーの拡張機能を有効にします。

az postgres server-arc update -n pg1 --extensions 'pgaudit,pg_partman' --k8s-namespace namespace --use-k8s

Azure Arc 対応 PostgreSQL サーバーから拡張機能を削除します。

az postgres server-arc update -n pg1 --extensions "''" --k8s-namespace namespace --use-k8s

必須のパラメーター

--name -n

更新中の Azure Arc 対応 PostgreSQL サーバーの名前。 インスタンスを配置するときに使用した名前を変更することはできません。

省略可能のパラメーター

--cert-private-key-file

クライアント SSL 接続に使用する PEM 形式の証明書秘密キーを含むファイルへのパス。

--cert-public-key-file

クライアント SSL 接続に使用する PEM 形式の証明書公開キーを含むファイルへのパス。

--cores-limit

ノードごとに使用できる Azure Arc 対応 PostgreSQL サーバーの CPU コアの最大数。 cores_limit を削除するには、その値を空の文字列として指定します。

--cores-request

サービスをスケジュールするためにノードごとに使用できる必要がある CPU コアの最小数。 cores_request を削除するには、その値を空の文字列として指定します。

--dev

これを指定した場合、それは dev インスタンスと見なされ、課金されません。

--extensions

有効にする拡張機能のコンマ区切りの一覧。 新しい拡張機能を追加または削除するには、既存の拡張機能の一覧を更新します。 有効にすると、'CREATE EXTENSION' コマンドを使用して拡張機能をインストールできます。

--k8s-namespace -k

Azure Arc 対応 PostgreSQL サーバーがデプロイされている Kubernetes 名前空間。 名前空間が指定されていない場合は、kubeconfig で定義されている名前空間が使用されます。

--keytab-secret

この Azure Arc 対応 PostgreSQL サーバーの keytab ファイルを含む Kubernetes シークレットの名前。

--log-level

PostgreSQL エンジンのlog_min_messages設定を設定します。 有効な値は、DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING、ERROR、LOG、FATAL、PANIC です。

--memory-limit

Azure Arc 対応 PostgreSQL サーバーのメモリ制限 。その後に Ki (キロバイト)、Mi (メガバイト)、Gi (ギガバイト) が続きます。 memory_limit を削除するには、その値を空の文字列として指定します。

--memory-request

Azure Arc 対応 PostgreSQL サーバーのメモリ要求。その後に Ki (キロバイト)、Mi (メガバイト)、Gi (ギガバイト) が続きます。 memory_request を削除するには、その値を空の文字列として指定します。

--no-external-endpoint

指定した場合、外部サービスは作成されません。 それ以外の場合は、--service-type 引数で指定された型またはデータ コントローラーと同じサービス型を使用して、外部サービスが作成されます。

--no-wait

戻る前に、デプロイの準備が整うのを待つ必要はありません。

既定値: False

--path

Azure Arc 対応 PostgreSQL サーバーのソース json ファイルへのパス。 これは省略可能です。

--port

プライマリ サービスがエンド ユーザーに公開されるポート番号。

--retention-days

バックアップの保有期間 (日数で指定)。 使用できる値は 0 ~ 35 です。 既定値は 7 です。 リテンション期間を 0 に設定すると、Azure Arc 対応 PostgreSql の自動バックアップがオフになります。

--service-annotations

すべての外部サービスに適用する注釈のコンマ区切りリスト。

--service-cert-secret

SSL 証明書をホストする生成する Kubernetes シークレットの名前。

--service-labels

すべての外部サービスに適用するラベルのコンマ区切りリスト。

--service-type

プライマリ サービスの種類。

--use-k8s

このアクションを実行するには、ローカルの Kubernetes API を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。