az postgres

リファレンス

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。拡張機能の詳細をご覧ください。

Azure Database for PostgreSQL サーバーを管理します。

コマンド

名前	説明	型	状態
az postgres db	サーバー上の PostgreSQL データベースを管理します。	コア	GA
az postgres db create	PostgreSQL データベースを作成する。	コア	GA
az postgres db delete	データベースを削除します。	コア	GA
az postgres db list	サーバーのデータベースを一覧表示します。	コア	GA
az postgres db show	データベースの詳細を表示します。	コア	GA
az postgres down	PostgreSQL サーバーとそのキャッシュされた情報を削除します。	拡張子	GA
az postgres flexible-server	Azure Database for PostgreSQL フレキシブルサーバーを管理します。	コアと拡張機能	GA
az postgres flexible-server ad-admin	サーバーの Active Directory 管理者を管理します。	コア	GA
az postgres flexible-server ad-admin create	Active Directory 管理者を作成します。	コア	GA
az postgres flexible-server ad-admin delete	Active Directory 管理者を削除します。	コア	GA
az postgres flexible-server ad-admin list	すべての Active Directory 管理者を一覧表示します。	コア	GA
az postgres flexible-server ad-admin show	Active Directory 管理者を取得します。	コア	GA
az postgres flexible-server ad-admin wait	Active Directory 管理者が特定の条件を満たすのを待ちます。	コア	GA
az postgres flexible-server advanced-threat-protection-setting	PostgreSQL フレキシブルサーバーの高度な脅威保護設定を管理します。	コア	GA
az postgres flexible-server advanced-threat-protection-setting show	PostgreSL フレキシブルサーバーの高度な脅威保護設定を取得します。	コア	GA
az postgres flexible-server advanced-threat-protection-setting update	フレキシブルサーバーの Advanced Threat Protection 設定の状態を更新します。	コア	GA
az postgres flexible-server backup	柔軟なサーバーバックアップを管理します。	コア	GA
az postgres flexible-server backup list	特定のサーバーのすべてのバックアップを一覧表示します。	コア	GA
az postgres flexible-server backup show	特定のサーバーの特定のバックアップの詳細を表示します。	コア	GA
az postgres flexible-server connect	フレキシブルサーバーに接続します。	拡張子	GA
az postgres flexible-server create	PostgreSQL フレキシブルサーバーを作成します。	コア	GA
az postgres flexible-server db	フレキシブルサーバーで PostgreSQL データベースを管理します。	コア	GA
az postgres flexible-server db create	フレキシブルサーバー上に PostgreSQL データベースを作成します。	コア	GA
az postgres flexible-server db delete	フレキシブルサーバー上のデータベースを削除します。	コア	GA
az postgres flexible-server db list	フレキシブルサーバーのデータベースを一覧表示します。	コア	GA
az postgres flexible-server db show	データベースの詳細を表示します。	コア	GA
az postgres flexible-server delete	フレキシブルサーバーを削除します。	コア	GA
az postgres flexible-server deploy	PostgreSQL サーバーの GitHub Actions ワークフローを有効にして実行します。	コア	GA
az postgres flexible-server deploy run	GitHub リポジトリで既存のワークフローを実行します。	コア	GA
az postgres flexible-server deploy setup	PostgreSQL サーバー用の GitHub Actions ワークフローファイルを作成します。	コア	GA
az postgres flexible-server execute	フレキシブルサーバーに接続します。	拡張子	GA
az postgres flexible-server firewall-rule	サーバーのファイアウォール規則を管理します。	コア	GA
az postgres flexible-server firewall-rule create	フレキシブルサーバー用の新しいファイアウォール規則を作成します。	コア	GA
az postgres flexible-server firewall-rule delete	ファイアウォール規則を削除します。	コア	GA
az postgres flexible-server firewall-rule list	フレキシブルサーバーのすべてのファイアウォール規則を一覧表示します。	コア	GA
az postgres flexible-server firewall-rule show	ファイアウォール規則の詳細を取得します。	コア	GA
az postgres flexible-server firewall-rule update	ファイアウォール規則を更新します。	コア	GA
az postgres flexible-server geo-restore	フレキシブルサーバーをバックアップから geo リストアします。	コア	GA
az postgres flexible-server identity	サーバーユーザー割り当て ID を管理します。	コア	GA
az postgres flexible-server identity assign	ユーザー割り当てマネージド ID をサーバーに追加します。	コア	GA
az postgres flexible-server identity list	サーバーからユーザー割り当てマネージド ID をすべて一覧表示します。	コア	GA
az postgres flexible-server identity remove	サーバーからユーザーの署名付きマネージド ID を削除します。	コア	GA
az postgres flexible-server identity show	サーバーからユーザー割り当てマネージド ID を取得します。	コア	GA
az postgres flexible-server list	使用可能なフレキシブルサーバーを一覧表示します。	コア	GA
az postgres flexible-server list-skus	特定のリージョンで使用可能な SKU を一覧表示します。	コア	GA
az postgres flexible-server migration	PostgreSQL フレキシブルサーバーの移行ワークフローを管理します。	コア	GA
az postgres flexible-server migration check-name-availability	指定された移行名を使用できるかどうかを確認します。	コア	GA
az postgres flexible-server migration create	フレキシブルサーバー用の新しい移行ワークフローを作成します。	コア	GA
az postgres flexible-server migration list	フレキシブルサーバーの移行を一覧表示します。	コア	GA
az postgres flexible-server migration show	特定の移行の詳細を取得します。	コア	GA
az postgres flexible-server migration update	特定の移行を更新します。	コア	GA
az postgres flexible-server parameter	フレキシブルサーバーのサーバーパラメーター値を管理するためのコマンド。	コア	GA
az postgres flexible-server parameter list	フレキシブルサーバーのパラメーター値を一覧表示します。	コア	GA
az postgres flexible-server parameter set	フレキシブルサーバーのパラメーターを更新します。	コア	GA
az postgres flexible-server parameter show	フレキシブルサーバーのパラメーターを取得します。"。	コア	GA
az postgres flexible-server private-endpoint-connection	PostgreSQL フレキシブルサーバーのプライベートエンドポイント接続を管理します。	コア	GA
az postgres flexible-server private-endpoint-connection approve	PostgreSQL フレキシブルサーバーに関連付けられている指定されたプライベートエンドポイント接続を承認します。	コア	GA
az postgres flexible-server private-endpoint-connection delete	PostgreSQL フレキシブルサーバーに関連付けられている指定されたプライベートエンドポイント接続を削除します。	コア	GA
az postgres flexible-server private-endpoint-connection list	PostgreSQL フレキシブルサーバーに関連付けられているすべてのプライベートエンドポイント接続を一覧表示します。	コア	GA
az postgres flexible-server private-endpoint-connection reject	PostgreSQL フレキシブルサーバーに関連付けられている指定されたプライベートエンドポイント接続を拒否します。	コア	GA
az postgres flexible-server private-endpoint-connection show	PostgreSQL フレキシブルサーバーに関連付けられているプライベートエンドポイント接続の詳細を表示します。	コア	GA
az postgres flexible-server private-link-resource	PostgreSQL フレキシブルサーバーのプライベートリンクリソースを取得します。	コア	GA
az postgres flexible-server private-link-resource list	PostgreSQL フレキシブルサーバーに関連付けられているプライベートリンクリソースを一覧表示します。	コア	GA
az postgres flexible-server private-link-resource show	PostgreSQL フレキシブルサーバーのプライベートリンクリソースを取得します。	コア	GA
az postgres flexible-server replica	読み取りレプリカを管理します。	コア	GA
az postgres flexible-server replica create	サーバーの読み取りレプリカを作成します。	コア	GA
az postgres flexible-server replica list	特定のサーバーのすべての読み取りレプリカを一覧表示します。	コア	GA
az postgres flexible-server replica promote	読み取りレプリカのレプリケーションを停止し、独立したサーバーまたはプライマリサーバーに昇格させます。	コア	GA
az postgres flexible-server replica stop-replication	読み取りレプリカへのレプリケーションを停止し、読み取り/書き込みサーバーにします。	コア	"非推奨"
az postgres flexible-server restart	フレキシブルサーバーを再起動します。	コア	GA
az postgres flexible-server restore	バックアップからフレキシブルサーバーを復元します。	コア	GA
az postgres flexible-server revive-dropped	バックアップからドロップされたフレキシブルサーバーを復活させます。	コア	GA
az postgres flexible-server server-logs	PostgreSQL フレキシブルサーバーのサーバーログ (ログファイル) を管理します。	コア	GA
az postgres flexible-server server-logs download	PostgreSQL フレキシブルサーバーのログファイルをダウンロードします。	コア	GA
az postgres flexible-server server-logs list	PostgreSQL フレキシブルサーバーのログファイルを一覧表示します。	コア	GA
az postgres flexible-server show	フレキシブルサーバーの詳細を取得します。	コア	GA
az postgres flexible-server show-connection-string	PostgreSQL フレキシブルサーバーデータベースの接続文字列を表示します。	コア	GA
az postgres flexible-server start	フレキシブルサーバーを起動します。	コア	GA
az postgres flexible-server stop	フレキシブルサーバーを停止します。	コア	GA
az postgres flexible-server update	フレキシブルサーバーを更新します。	コア	GA
az postgres flexible-server upgrade	フレキシブルサーバーのメジャーバージョンのアップグレード。	コア	GA
az postgres flexible-server virtual-endpoint	PostgreSQL フレキシブルサーバーの仮想エンドポイントを管理します。	コア	GA
az postgres flexible-server virtual-endpoint create	フレキシブルサーバー用の新しい仮想エンドポイントを作成します。	コア	GA
az postgres flexible-server virtual-endpoint delete	仮想エンドポイントを削除します。	コア	GA
az postgres flexible-server virtual-endpoint list	フレキシブルサーバーのすべての仮想エンドポイントを一覧表示します。	コア	GA
az postgres flexible-server virtual-endpoint show	仮想エンドポイントの詳細を取得します。	コア	GA
az postgres flexible-server virtual-endpoint update	仮想エンドポイントを更新します。	コア	GA
az postgres flexible-server wait	フレキシブルサーバーが特定の条件を満たすのを待ちます。	コア	GA
az postgres server	PostgreSQL サーバーを管理します。	コア	GA
az postgres server-arc	Azure Arc 対応 PostgreSQL サーバーを管理します。	拡張子	プレビュー
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-logs	サーバーログを管理します。	コア	GA
az postgres server-logs download	ログファイルをダウンロードします。	コア	GA
az postgres server-logs list	サーバーのログファイルを一覧表示します。	コア	GA
az postgres server ad-admin	postgres サーバーの Active Directory 管理者を管理します。	コア	GA
az postgres server ad-admin create	PostgreSQL サーバー用の Active Directory 管理者を作成します。	コア	GA
az postgres server ad-admin delete	PostgreSQL サーバーの Active Directory 管理者を削除します。	コア	GA
az postgres server ad-admin list	PostgreSQL サーバーのすべての Active Directory 管理者を一覧表示します。	コア	GA
az postgres server ad-admin show	PostgreSQL サーバーの Active Directory 管理者情報を取得します。	コア	GA
az postgres server ad-admin wait	PostgreSQL サーバーの Active Directory 管理者の条件が満たされるまで、CLI を待機状態にします。	コア	GA
az postgres server configuration	サーバーの構成値を管理します。	コア	GA
az postgres server configuration list	サーバーの構成値を一覧表示します。	コア	GA
az postgres server configuration set	サーバーの構成を更新します。	コア	GA
az postgres server configuration show	サーバーの構成を取得します。"。	コア	GA
az postgres server create	サーバーの作成。	コア	GA
az postgres server delete	サーバーを削除する。	コア	GA
az postgres server firewall-rule	サーバーのファイアウォール規則を管理します。	コア	GA
az postgres server firewall-rule create	サーバーの新しいファイアウォール規則を作成します。	コア	GA
az postgres server firewall-rule delete	ファイアウォール規則を削除します。	コア	GA
az postgres server firewall-rule list	サーバーのすべてのファイアウォール規則を一覧表示します。	コア	GA
az postgres server firewall-rule show	ファイアウォール規則の詳細を取得します。	コア	GA
az postgres server firewall-rule update	ファイアウォール規則を更新します。	コア	GA
az postgres server georestore	バックアップからサーバーを geo リストアします。	コア	GA
az postgres server key	PostgreSQL サーバーキーを管理します。	コア	GA
az postgres server key create	サーバーキーを作成します。	コア	GA
az postgres server key delete	サーバーキーを削除します。	コア	GA
az postgres server key list	サーバーキーの一覧を取得します。	コア	GA
az postgres server key show	サーバーキーを表示します。	コア	GA
az postgres server list	使用可能なサーバーを一覧表示します。	コア	GA
az postgres server list-skus	特定のリージョンで使用可能な SKU を一覧表示します。	コア	GA
az postgres server private-endpoint-connection	PostgreSQL サーバーのプライベートエンドポイント接続を管理します。	コア	GA
az postgres server private-endpoint-connection approve	PostgreSQL サーバーに関連付けられている指定されたプライベートエンドポイント接続を承認します。	コア	GA
az postgres server private-endpoint-connection delete	PostgreSQL サーバーに関連付けられている指定されたプライベートエンドポイント接続を削除します。	コア	GA
az postgres server private-endpoint-connection reject	PostgreSQL サーバーに関連付けられている指定されたプライベートエンドポイント接続を拒否します。	コア	GA
az postgres server private-endpoint-connection show	PostgreSQL サーバーに関連付けられているプライベートエンドポイント接続の詳細を表示します。	コア	GA
az postgres server private-link-resource	PostgreSQL サーバーのプライベートリンクリソースを管理します。	コア	GA
az postgres server private-link-resource list	PostgreSQL サーバーでサポートされているプライベートリンクリソースを一覧表示します。	コア	GA
az postgres server replica	読み取りレプリカを管理します。	コア	GA
az postgres server replica create	サーバーの読み取りレプリカを作成します。	コア	GA
az postgres server replica list	特定のサーバーのすべての読み取りレプリカを一覧表示します。	コア	GA
az postgres server replica stop	読み取りレプリカへのレプリケーションを停止し、読み取り/書き込みサーバーにします。	コア	GA
az postgres server restart	サーバーを再起動します。	コア	GA
az postgres server restore	バックアップからサーバーを復元します。	コア	GA
az postgres server show	サーバーの詳細を取得します。	コア	GA
az postgres server show-connection-string	PostgreSQL サーバーデータベースの接続文字列を表示します。	コア	GA
az postgres server update	サーバーを更新します。	コア	GA
az postgres server vnet-rule	サーバーの仮想ネットワーク規則を管理します。	コア	GA
az postgres server vnet-rule create	PostgreSQL サーバーへのアクセスを許可する仮想ネットワーク規則を作成します。	コア	GA
az postgres server vnet-rule delete	指定された名前の仮想ネットワーク規則を削除します。	コア	GA
az postgres server vnet-rule list	サーバー内の仮想ネットワーク規則の一覧を取得します。	コア	GA
az postgres server vnet-rule show	仮想ネットワーク規則を取得します。	コア	GA
az postgres server vnet-rule update	仮想ネットワーク規則を更新します。	コア	GA
az postgres server wait	サーバーが特定の条件を満たすのを待ちます。	コア	GA
az postgres show-connection-string	PostgreSQL サーバーデータベースの接続文字列を表示します。	拡張子	GA
az postgres up	Azure Database for PostgreSQL サーバーと構成を設定します。	拡張子	GA

az postgres down

PostgreSQL サーバーとそのキャッシュされた情報を削除します。

az postgres down [--delete-group]
                 [--ids]
                 [--no-wait]
                 [--resource-group]
                 [--server-name]
                 [--subscription]
                 [--yes]

例

リソースグループとは別に、サーバーとキャッシュされたデータを削除します。

az postgres down

リソースグループと完全キャッシュを削除します。

az postgres down --delete-group

省略可能のパラメーター

--delete-group

リソースグループを削除します。

--ids

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

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--server-name -s

サーバーの名前。

--subscription

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

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--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 show-connection-string

PostgreSQL サーバーデータベースの接続文字列を表示します。

az postgres show-connection-string [--admin-password]
                                   [--admin-user]
                                   [--database-name]
                                   [--ids]
                                   [--server-name]
                                   [--subscription]

省略可能のパラメーター

--admin-password -p

管理者のログインパスワード。

規定値: {password}

--admin-user -u

管理者のログインユーザー名。

規定値: {login}

--database-name -d

データベースの名前。

規定値: {database}

--ids

--server-name -s

サーバーの名前。

規定値: {server}

--subscription

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

グローバルパラメーター

--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 up

Azure Database for PostgreSQL サーバーと構成を設定します。

az postgres up [--admin-password]
               [--admin-user]
               [--backup-retention]
               [--database-name]
               [--generate-password]
               [--geo-redundant-backup {Disabled, Enabled}]
               [--ids]
               [--location]
               [--resource-group]
               [--server-name]
               [--sku-name]
               [--ssl-enforcement {Disabled, Enabled}]
               [--storage-size]
               [--subscription]
               [--tags]
               [--version]

例

Azure Database for PostgreSQL サーバーが稼働していて、すぐに使用できるように構成されていることを確認します。

az postgres up

既定の名前をオーバーライドするには、必要な値/既存のリソースを示すパラメーターを指定します。

az postgres up -g MyResourceGroup -s MyServer -d MyDatabase -u MyUsername -p MyPassword

省略可能のパラメーター

--admin-password -p

管理者のログインパスワード。 8 文字以上、最大 128 文字。パスワードには、英大文字、英小文字、数字、英数字以外の 3 つのカテゴリの文字を含める必要があります。パスワードにログイン名の全部または一部を含めることはできません。ログイン名の部分は、3 つ以上の連続する英数字として定義されます。

--admin-user -u

管理者のログインユーザー名。

--backup-retention

バックアップが保持される日数。

--database-name -d

初期化するデータベースの名前。

--generate-password

パスワードを生成します。

--geo-redundant-backup

Geo 冗長を有効にするか、サーバーバックアップ用に有効にしないか。

指定可能な値: Disabled, Enabled

規定値: Disabled

--ids

--location -l

Location。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--resource-group -g

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

--server-name -s

サーバーの名前。

--sku-name

sku の名前。通常は、階層 + ファミリ + コア (B_Gen4_1、GP_Gen5_8など)。

規定値: GP_Gen5_2

--ssl-enforcement

サーバーに接続するときに SSL 強制を有効にするか、有効にしないか。

指定可能な値: Disabled, Enabled

規定値: Enabled

--storage-size

サーバーの最大ストレージサイズ。単位はメガバイトです。

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--version

サーバーのバージョン。

規定値: 10

グローバルパラメーター

--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

コマンド

az postgres down

例

省略可能のパラメーター

az postgres show-connection-string

省略可能のパラメーター

az postgres up

例

省略可能のパラメーター

その他のリソース