Share via

az neon postgres branch

Note

This reference is part of the neon extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az neon postgres branch command. Learn more about extensions.

Manage branches within a Neon Postgres database.

Commands

Name Description Type Status
az neon postgres branch create

Create a new branch within a Neon Postgres database.

 Extension GA
az neon postgres branch delete

Delete an existing branch within a Neon Postgres database.

 Extension GA
az neon postgres branch list

List all branch resources within a specific project in Neon Postgres.

 Extension GA
az neon postgres branch show

Retrieve details of a specific branch within a Neon Postgres database.

 Extension GA
az neon postgres branch update

Update the properties of an existing branch within a Neon Postgres database.

 Extension GA
az neon postgres branch wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az neon postgres branch create

Create a new branch within a Neon Postgres database.

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]

Examples

Create a Branch

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

Required Parameters

--branch-name --name -n

Name of the Neon branch.

--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

--project-name

Name of the Neon project.

--resource-group -g

Name of the Azure resource group.

Optional Parameters

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 name associated with the branch.

Property Value
Parameter group: Properties Arguments
--entity-name

Name of the resource.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--parent-id

The ID of the parent branch.

Property Value
Parameter group: Properties Arguments
--role-name

Role name associated with the branch.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az neon postgres branch delete

Delete an existing branch within a Neon Postgres database.

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

Examples

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

Optional Parameters

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

--branch-id

Id of the Neon branch.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

Property Value
Parameter group: Resource Id Arguments
--project-id

Id of the Neon project.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of the Azure resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az neon postgres branch list

List all branch resources within a specific project in Neon Postgres.

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

Examples

List Branches under a Project

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

Required Parameters

--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

--project-id

Id of the Neon project.

--resource-group -g

Name of the Azure resource group.

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az neon postgres branch show

Retrieve details of a specific branch within a Neon Postgres database.

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

Examples

Show Branch Details

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

Optional Parameters

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

--branch-id

Id of the Neon branch.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

Property Value
Parameter group: Resource Id Arguments
--project-id

Id of the Neon project.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of the Azure resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az neon postgres branch update

Update the properties of an existing branch within a Neon Postgres database.

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]

Examples

Update a Branch

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

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--branch-name --name -n

Name of the Neon branch.

Property Value
Parameter group: Resource Id Arguments
--database-name

Neon Database name associated with the branch.

Property Value
Parameter group: Properties Arguments
--entity-name

Name of the resource.

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

Property Value
Parameter group: Resource Id Arguments
--parent-id

The ID of the parent branch.

Property Value
Parameter group: Properties Arguments
--project-name

Name of the Neon project.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of the Azure resource group.

Property Value
Parameter group: Resource Id Arguments
--role-name

Role name associated with the branch.

Property Value
Parameter group: Properties Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az neon postgres branch wait

Place the CLI in a waiting state until a condition is met.

az neon postgres branch wait [--branch-id]
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--organization-name]
                             [--project-id]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Optional Parameters

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

--branch-id

Id of the Neon branch.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

Property Value
Parameter group: Resource Id Arguments
--project-id

Id of the Neon project.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of the Azure resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False