az neon postgres

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

Command group 'az neon' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Neon Postgres.

Commands

Name	Description	Type	Status
az neon postgres create	Create a Neon organization.	Extension	Preview
az neon postgres organization	Manage a Neon organization.	Extension	Preview
az neon postgres organization delete	Delete a Neon organization.	Extension	Preview
az neon postgres organization list	List Neon organizations by subscription ID.	Extension	Preview
az neon postgres organization show	Get a Neon organization.	Extension	Preview
az neon postgres organization update	Update a Neon organization.	Extension	Preview
az neon postgres organization wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az neon postgres create

Preview

Command group 'az neon postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Neon organization.

az neon postgres create --name
                        --resource-group
                        [--company-details]
                        [--location]
                        [--marketplace-details]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--partner-org-props --partner-organization-properties]
                        [--tags]
                        [--user-details]

Examples

Organizations_CreateOrUpdate

az neon postgres create --resource-group demoResourceGroup --name demoNeonResource --location eastus --subscription 12345678-1234-1234-1234-123456789abc --marketplace-details "{subscription-id:abcd1234-5678-90ab-cdef-12345678abcd,subscription-status:PendingFulfillmentStart,offer-details:{publisher-id:microsoft,offer-id:neon-postgres,plan-id:serverless-plan,plan-name:'Neon Serverless Postgres - Free (Test_Liftr)',term-unit:P1M,term-id:term1234}}" --user-details "{first-name:John,last-name:Doe,email-address:johndoe@example.com,upn:johndoe,phone-number:+1234567890}" --company-details "{company-name:'DemoCompany',country:USA,business-phone:+9876543210,office-address:'123 Azure Ave, Redmond, WA',domain:democompany.com,number-of-employees:1000}" --partner-organization-properties "{organization-id:org-5678,org-name:'PartnerOrg',single-sign-on-properties:{single-sign-on-state:Enable,enterprise-app-id:app-9876,single-sign-on-url:'https://sso.partnerorg.com',aad-domains:['partnerorg.com']}}"

Required Parameters

--name -n

Name of the Neon organization.

--resource-group -g

Name of the 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.

--company-details

Details of the company. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--marketplace-details

Marketplace details of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--partner-org-props --partner-organization-properties

Organization properties Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--user-details

Details of the user. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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