Share via

az neon postgres project

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 project command. Learn more about extensions.

Manage Neon projects, including listing, creating, updating, deleting, and retrieving project information.

Commands

Name Description Type Status
az neon postgres project create

Create a new Neon project resource within Azure.

 Extension GA
az neon postgres project delete

Delete an existing Neon project resource within Azure.

 Extension GA
az neon postgres project get-connection-uri

Retrieve the connection URI for a specific Neon Postgres database.

 Extension GA
az neon postgres project list

List all Neon projects associated with a specific Neon organization.

 Extension GA
az neon postgres project show

Retrieve details of a specific Neon project resource.

 Extension GA
az neon postgres project update

Update the properties of an existing Neon project resource within Azure.

 Extension GA
az neon postgres project wait

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

 Extension GA

az neon postgres project create

Create a new Neon project resource within Azure.

az neon postgres project create --organization-name
                                --resource-group
                                [--branch]
                                [--name --project-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--pg-version]
                                [--region]

Examples

Create Neon Project

az neon postgres project create --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 17 --branch "{branch-name:main, role-name:owner_role,database-name:neondb}"

Required Parameters

--organization-name

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

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

--branch

The Branch properties of the project. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Name of the Neon project.

Property Value
Default value: Default-Project
--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
--pg-version

The PostgreSQL version for the Neon Database, with a default of 17.

Property Value
Parameter group: Properties Arguments
Default value: 17
--region

The region where the project is created.

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

Delete an existing Neon project resource within Azure.

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

Examples

Delete Neon Project

az neon postgres project delete --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796

Optional Parameters

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

--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 project get-connection-uri

Retrieve the connection URI for a specific Neon Postgres database.

az neon postgres project get-connection-uri [--branch-id]
                                            [--database-name]
                                            [--endpoint-id]
                                            [--ids]
                                            [--is-pooled {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--organization-name]
                                            [--project-id]
                                            [--project-name]
                                            [--resource-group]
                                            [--role-name]
                                            [--subscription]

Examples

Get Database Connection URI

az neon postgres project get-connection-uri --resource-group rgneon --organization-name test-org --project-name entity-name --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr --database-name neondb --role-name owner_role --endpoint-id ep-purple-voice-a84wphbw --is-pooled false

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

Branch Id associated with this connection.

Property Value
Parameter group: ConnectionUriParameters Arguments
--database-name

Database name associated with this connection.

Property Value
Parameter group: ConnectionUriParameters Arguments
--endpoint-id

The endpoint Id with this connection.

Property Value
Parameter group: ConnectionUriParameters 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
--is-pooled

Indicates if the connection is pooled.

Property Value
Parameter group: ConnectionUriParameters Arguments
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
--project-id

Project Id associated with this connection.

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

Name 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
--role-name

The role name used for authentication.

Property Value
Parameter group: ConnectionUriParameters 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 project list

List all Neon projects associated with a specific Neon organization.

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

Examples

List Neon Projects within an Organization

az neon postgres project list --resource-group rgneon --organization-name org-cli-test

Required Parameters

--organization-name

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

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

Retrieve details of a specific Neon project resource.

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

Examples

Show Neon Project Deatils

az neon postgres project show --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796

Optional Parameters

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

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

Update the properties of an existing Neon project resource within Azure.

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

Examples

Neon Project Update

az neon postgres project update --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 18

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

The Branch properties of the project. This is optional Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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
--name --project-name -n

Name of the Neon project.

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

Postgres version for the project.

Property Value
Parameter group: Properties Arguments
--region

Region where the project is created.

Property Value
Parameter group: Properties 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
--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 project wait

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

az neon postgres project wait [--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.

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