az neon postgres project

Reference

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.

The projects command allows you to list, create, update, delete, and retrieve information about Neon projects.

Commands

Name	Description	Type	Status
az neon postgres project create	Creates a Neon Project resource.	Extension	Preview
az neon postgres project delete	Deletes a Neon Project resource.	Extension	Experimental
az neon postgres project get-connection-uri	Action to retrieve the connection URI for the Neon Database.	Extension	GA
az neon postgres project list	List Neon Projects associated with Neon Organization resource.	Extension	Preview
az neon postgres project show	Get details of a Neon Project resource.	Extension	Preview
az neon postgres project update	Updates a Neon Project resource.	Extension	Preview
az neon postgres project wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az neon postgres project create

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates a Neon Project resource.

az neon postgres project create --organization-name
                                --resource-group
                                [--branch]
                                [--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

The name of the Neon Organization resource. If value is blank it's asked from the tty.

--resource-group -g

The name of the Azure resource group.

Optional Parameters

--branch

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

--name --project-name -n

The name of the Neon Project resource.

Default value: Default-Project

--no-wait

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

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.

Default value: 17

--region

The region where the project is created.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az neon postgres project delete

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a Neon Project resource.

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

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

--organization-name

The Name of Neon Organization resource.

--project-id

The id of the Neon Project resource.

--resource-group -g

The name of the Azure resource group.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az neon postgres project get-connection-uri

Action to retrieve the connection URI for the Neon 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

--branch-id

Branch Id associated with this connection.

--database-name

Database name associated with this connection.

--endpoint-id

The endpoint Id with this connection.

--ids

--is-pooled

Indicates if the connection is pooled.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--organization-name

Name of the Neon Organizations resource.

--project-id

Project Id associated with this connection.

--project-name

The name of the Project.

--resource-group -g

The name of the Azure resource group.

--role-name

The role name used for authentication.

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az neon postgres project list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Neon Projects associated with Neon Organization resource.

List Neon Project associated with your Neon Organization resource, including those shared with you.

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

The name of the Neon Organization resource.

--resource-group -g

The name of the Azure resource group.

Optional Parameters

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

--next-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az neon postgres project show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details of a 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

--ids

--organization-name

The name of the Neon Organization resource.

--project-id

The id of the Neon Project resource.

--resource-group -g

The name of the Azure resource group.

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az neon postgres project update

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates a Neon Project resource.

az neon postgres project update [--add]
                                [--branch]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--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

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

--branch

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--name --project-name -n

The name of the Project.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--organization-name

Name of the Neon Organizations resource.

--pg-version

Postgres version for the project.

--region

Region where the project is created.

--remove

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

--resource-group -g

The name of the Azure resource group.

--set

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

--organization-name

The name of the Neon Organization resource.

--project-id

The id of the Neon Project resource.

--resource-group -g

The name of the Azure resource group.

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az neon postgres project

Commands

az neon postgres project create

Examples

Required Parameters

Optional Parameters

az neon postgres project delete

Examples

Optional Parameters

az neon postgres project get-connection-uri

Examples

Optional Parameters

az neon postgres project list

Examples

Required Parameters

Optional Parameters

az neon postgres project show

Examples

Optional Parameters

az neon postgres project update

Examples

Optional Parameters

az neon postgres project wait

Optional Parameters