az neon postgres branch

Note

This reference is part of the neon extension for the Azure CLI (version 2.70.0 or higher). 拡張機能は、 az neon postgres branch コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

Neon Postgres データベース内のブランチを管理します。

コマンド

名前	説明	型	状態
az neon postgres branch create	Neon Postgres データベース内に新しいブランチを作成します。	Extension	GA
az neon postgres branch delete	Neon Postgres データベース内の既存のブランチを削除します。	Extension	GA
az neon postgres branch list	Neon Postgres の特定のプロジェクト内のすべてのブランチ リソースを一覧表示します。	Extension	GA
az neon postgres branch show	Neon Postgres データベース内の特定のブランチの詳細を取得します。	Extension	GA
az neon postgres branch update	Neon Postgres データベース内の既存のブランチのプロパティを更新します。	Extension	GA
az neon postgres branch wait	条件が満たされるまで CLI を待機状態にします。	Extension	GA

az neon postgres branch create

Neon Postgres データベース内に新しいブランチを作成します。

az neon postgres branch create --branch-name --name
                               --organization-name
                               --project-name
                               --resource-group
                               [--database-name]
                               [--entity-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--parent-id]
                               [--role-name]

例

ブランチを作成する

az neon postgres branch create --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --branch-name test-branch --entity-name test-branch --role-name test_role --database-name testneondb

必須のパラメーター

--branch-name --name -n

Neon ブランチの名前。

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

--project-name

Neon プロジェクトの名前。

--resource-group -g

Azure リソース グループの名前。

省略可能のパラメーター

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

--database-name

ブランチに関連付けられている Neon Database 名。

プロパティ	値
Parameter group:	Properties Arguments

--entity-name

リソースの名前。

プロパティ	値
Parameter group:	Properties Arguments

--no-wait

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

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

--parent-id

親ブランチの ID。

プロパティ	値
Parameter group:	Properties Arguments

--role-name

ブランチに関連付けられているロール名。

プロパティ	値
Parameter group:	Properties 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 neon postgres branch delete

Neon Postgres データベース内の既存のブランチを削除します。

az neon postgres branch delete [--branch-id]
                               [--ids]
                               [--organization-name]
                               [--project-id]
                               [--resource-group]
                               [--subscription]
                               [--yes]

例

Delete Branch

az neon postgres branch delete --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr

省略可能のパラメーター

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

--branch-id

Neon ブランチの ID。

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

--ids

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

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

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

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

--project-id

Neon プロジェクトの ID。

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

--resource-group -g

Azure リソース グループの名前。

プロパティ	値
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 neon postgres branch list

Neon Postgres の特定のプロジェクト内のすべてのブランチ リソースを一覧表示します。

az neon postgres branch list --organization-name
                             --project-id
                             --resource-group
                             [--max-items]
                             [--next-token]

例

プロジェクトの下のブランチを一覧表示する

az neon postgres branch list --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796

必須のパラメーター

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

--project-id

Neon プロジェクトの ID。

--resource-group -g

Azure リソース グループの名前。

省略可能のパラメーター

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

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ	値
Parameter group:	Pagination Arguments

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ	値
Parameter group:	Pagination 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 neon postgres branch show

Neon Postgres データベース内の特定のブランチの詳細を取得します。

az neon postgres branch show [--branch-id]
                             [--ids]
                             [--organization-name]
                             [--project-id]
                             [--resource-group]
                             [--subscription]

例

ブランチの詳細を表示する

az neon postgres branch show --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr

省略可能のパラメーター

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

--branch-id

Neon ブランチの ID。

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

--ids

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

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

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

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

--project-id

Neon プロジェクトの ID。

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

--resource-group -g

Azure リソース グループの名前。

プロパティ	値
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 neon postgres branch update

Neon Postgres データベース内の既存のブランチのプロパティを更新します。

az neon postgres branch update [--add]
                               [--branch-name --name]
                               [--database-name]
                               [--entity-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--organization-name]
                               [--parent-id]
                               [--project-name]
                               [--remove]
                               [--resource-group]
                               [--role-name]
                               [--set]
                               [--subscription]

例

ブランチを更新する

az neon postgres branch update --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --project-id old-frost-16758796 --branch-name test-branch --entity-name test-branch2 --role-name test_role --database-name testneondb

省略可能のパラメーター

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

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments

--branch-name --name -n

Neon ブランチの名前。

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

--database-name

ブランチに関連付けられている Neon Database 名。

プロパティ	値
Parameter group:	Properties Arguments

--entity-name

リソースの名前。

プロパティ	値
Parameter group:	Properties Arguments

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update 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

--no-wait

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

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

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

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

--parent-id

親ブランチの ID。

プロパティ	値
Parameter group:	Properties Arguments

--project-name

Neon プロジェクトの名前。

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

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments

--resource-group -g

Azure リソース グループの名前。

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

--role-name

ブランチに関連付けられているロール名。

プロパティ	値
Parameter group:	Properties Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update 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 neon postgres branch wait

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

az neon postgres branch wait [--branch-id]
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--organization-name]
                             [--project-id]
                             [--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.

--branch-id

Neon ブランチの ID。

プロパティ	値
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

--organization-name

Neon 組織の名前。 値が空白の場合は、tty から要求されます。

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

--project-id

Neon プロジェクトの ID。

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

--resource-group -g

Azure リソース グループの名前。

プロパティ	値
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