Freigeben über

az neon postgres project

Note

This reference is part of the neon extension for the Azure CLI (version 2.70.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie einen az neon postgres-Projektbefehl zum ersten Mal ausführen. Learn more about extensions.

Verwalten Sie Neon-Projekte, einschließlich Auflisten, Erstellen, Aktualisieren, Löschen und Abrufen von Projektinformationen.

Befehle

Name Beschreibung Typ Status
az neon postgres project create

Erstellen Sie eine neue Neon-Projektressource in Azure.

 Extension GA
az neon postgres project delete

Löschen Sie eine vorhandene Neon-Projektressource in Azure.

 Extension GA
az neon postgres project get-connection-uri

Rufen Sie den Verbindungs-URI für eine bestimmte Neon Postgres-Datenbank ab.

 Extension GA
az neon postgres project list

Listet alle Neon-Projekte auf, die einer bestimmten Neon-Organisation zugeordnet sind.

 Extension GA
az neon postgres project show

Rufen Sie Details einer bestimmten Neon-Projektressource ab.

 Extension GA
az neon postgres project update

Aktualisieren Sie die Eigenschaften einer vorhandenen Neon-Projektressource in Azure.

 Extension GA
az neon postgres project wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

 Extension GA

az neon postgres project create

Erstellen Sie eine neue Neon-Projektressource in 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]

Beispiele

Neon-Projekt erstellen

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

Erforderliche Parameter

--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

--resource-group -g

Name der Azure-Ressourcengruppe.

Optionale Parameter

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

--branch

Die Branch-Eigenschaften des Projekts. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parameter group: Properties Arguments
--name --project-name -n

Name des Neon-Projekts.

Eigenschaft Wert
Standardwert: Default-Project
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--pg-version

Die PostgreSQL-Version für die Neon-Datenbank mit einem Standardwert von 17.

Eigenschaft Wert
Parameter group: Properties Arguments
Standardwert: 17
--region

Die Region, in der das Projekt erstellt wird.

Eigenschaft Wert
Parameter group: Properties Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project delete

Löschen Sie eine vorhandene Neon-Projektressource in Azure.

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

Beispiele

Neon-Projekt löschen

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

Optionale Parameter

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

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--project-id

Id des Neon-Projekts.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

Name der Azure-Ressourcengruppe.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project get-connection-uri

Rufen Sie den Verbindungs-URI für eine bestimmte Neon Postgres-Datenbank ab.

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]

Beispiele

Datenbankverbindungs-URI abrufen

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

Optionale Parameter

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

--branch-id

Dieser Verbindung zugeordnete Verzweigungs-ID.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
--database-name

Datenbankname, der dieser Verbindung zugeordnet ist.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
--endpoint-id

Die Endpunkt-ID mit dieser Verbindung.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--is-pooled

Gibt an, ob die Verbindung in einem Pool zusammengefasst ist.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--project-id

Dieser Verbindung zugeordnete Projekt-ID.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
--project-name

Name des Neon-Projekts.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

Name der Azure-Ressourcengruppe.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--role-name

Der für die Authentifizierung verwendete Rollenname.

Eigenschaft Wert
Parameter group: ConnectionUriParameters Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project list

Listet alle Neon-Projekte auf, die einer bestimmten Neon-Organisation zugeordnet sind.

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

Beispiele

Auflisten von Neonprojekten innerhalb einer Organisation

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

Erforderliche Parameter

--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

--resource-group -g

Name der Azure-Ressourcengruppe.

Optionale Parameter

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

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft Wert
Parameter group: Pagination Arguments
--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

Eigenschaft Wert
Parameter group: Pagination Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project show

Rufen Sie Details einer bestimmten Neon-Projektressource ab.

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

Beispiele

Neonprojekt-Entatils anzeigen

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

Optionale Parameter

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

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--project-id

Id des Neon-Projekts.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

Name der Azure-Ressourcengruppe.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project update

Aktualisieren Sie die Eigenschaften einer vorhandenen Neon-Projektressource in 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]

Beispiele

Neon Project Update

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

Optionale Parameter

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

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Eigenschaft Wert
Parameter group: Generic Update Arguments
--branch

Die Branch-Eigenschaften des Projekts. Dies ist optional support shorthand-syntax, json-file und yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parameter group: Properties Arguments
--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Eigenschaft Wert
Parameter group: Generic Update Arguments
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--name --project-name -n

Name des Neon-Projekts.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--pg-version

Postgres-Version für das Projekt.

Eigenschaft Wert
Parameter group: Properties Arguments
--region

Region, in der das Projekt erstellt wird.

Eigenschaft Wert
Parameter group: Properties Arguments
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parameter group: Generic Update Arguments
--resource-group -g

Name der Azure-Ressourcengruppe.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft Wert
Parameter group: Generic Update Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az neon postgres project wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

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

Optionale Parameter

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

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschaft Wert
Parameter group: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: 30
--organization-name

Name der Neon-Organisation. Wenn der Wert leer ist, wird er von der tty gefragt.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--project-id

Id des Neon-Projekts.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

Name der Azure-Ressourcengruppe.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False