Partager via

az neon postgres project

Note

Cette référence fait partie de l’extension neon pour Azure CLI (version 2.75.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de projet az neon postgres . Apprenez-en davantage sur les extensions.

Gérez les projets Neon, notamment la liste, la création, la mise à jour, la suppression et la récupération des informations de projet.

Commandes

Nom Description Type État
az neon postgres project create

Créez une ressource de projet Neon dans Azure.

 Extension GA
az neon postgres project delete

Supprimez une ressource de projet Neon existante dans Azure.

 Extension GA
az neon postgres project get-connection-uri

Récupérez l’URI de connexion pour une base de données Neon Postgres spécifique.

 Extension GA
az neon postgres project list

Répertoriez tous les projets Neon associés à une organisation Neon spécifique.

 Extension GA
az neon postgres project show

Récupérez les détails d’une ressource de projet Neon spécifique.

 Extension GA
az neon postgres project update

Mettez à jour les propriétés d’une ressource de projet Neon existante dans Azure.

 Extension GA

az neon postgres project create

Créez une ressource de projet Neon dans 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]

Exemples

Créer un projet neon

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

Paramètres obligatoires

--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

--resource-group -g

Nom du groupe de ressources Azure.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--branch

Propriétés branch du projet. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--name --project-name -n

Nom du projet Neon.

Propriété Valeur
Valeur par défaut: Default-Project
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--pg-version

Version PostgreSQL pour la base de données Neon, avec une valeur par défaut de 17.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeur par défaut: 17
--region

Région où le projet est créé.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az neon postgres project delete

Supprimez une ressource de projet Neon existante dans Azure.

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

Exemples

Supprimer le projet Neon

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--project-id

ID du projet Neon.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az neon postgres project get-connection-uri

Récupérez l’URI de connexion pour une base de données Neon Postgres spécifique.

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]

Exemples

Obtenir l’URI de connexion de base de données

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--branch-id

ID de branche associé à cette connexion.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
--database-name

Nom de la base de données associé à cette connexion.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
--endpoint-id

ID de point de terminaison avec cette connexion.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--is-pooled

Indique si la connexion est mise en pool.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--project-id

ID de projet associé à cette connexion.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
--project-name

Nom du projet Neon.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--role-name

Nom du rôle utilisé pour l’authentification.

Propriété Valeur
Groupe de paramètres: ConnectionUriParameters Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az neon postgres project list

Répertoriez tous les projets Neon associés à une organisation Neon spécifique.

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

Exemples

Répertorier les projets neon au sein d’une organisation

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

Paramètres obligatoires

--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

--resource-group -g

Nom du groupe de ressources Azure.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token argument d’une commande suivante.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az neon postgres project show

Récupérez les détails d’une ressource de projet Neon spécifique.

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

Exemples

Afficher le projet Neon Deatils

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--project-id

ID du projet Neon.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az neon postgres project update

Mettez à jour les propriétés d’une ressource de projet Neon existante dans 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]

Exemples

Mise à jour du projet neon

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--branch

Propriétés branch du projet. Il s’agit de la prise en charge facultative de la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--name --project-name -n

Nom du projet Neon.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Nom de l’organisation Neon. Si la valeur est vide, elle est demandée à partir de la tty.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--pg-version

Version de Postgres pour le projet.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--region

Région où le projet est créé.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--resource-group -g

Nom du groupe de ressources Azure.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False