az neon postgres project
Note
Esta referencia forma parte de la extensión neon para la CLI de Azure (versión 2.75.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az neon postgres project . Obtenga más información sobre las extensiones.
Administre proyectos neon, incluidos la enumeración, la creación, actualización, eliminación y recuperación de información del proyecto.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az neon postgres project create |
Cree un nuevo recurso de proyecto neon en Azure. |
Extension | GA |
| az neon postgres project delete |
Elimine un recurso de proyecto neon existente en Azure. |
Extension | GA |
| az neon postgres project get-connection-uri |
Recupere el URI de conexión de una base de datos de Neon Postgres específica. |
Extension | GA |
| az neon postgres project list |
Enumere todos los proyectos neon asociados a una organización de Neon específica. |
Extension | GA |
| az neon postgres project show |
Recupere los detalles de un recurso de proyecto neon específico. |
Extension | GA |
| az neon postgres project update |
Actualice las propiedades de un recurso de proyecto neon existente en Azure. |
Extension | GA |
az neon postgres project create
Cree un nuevo recurso de proyecto neon en 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]
Ejemplos
Creación de un proyecto 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}"
Parámetros requeridos
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
Nombre del grupo de recursos de Azure.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Las propiedades Branch del proyecto. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Nombre del proyecto Neon.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | Default-Project |
No espere a que finalice la operación de ejecución prolongada.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | 0, 1, f, false, n, no, t, true, y, yes |
La versión de PostgreSQL para Neon Database, con un valor predeterminado de 17.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
| Valor predeterminado: | 17 |
Región donde se crea el proyecto.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az neon postgres project delete
Elimine un recurso de proyecto neon existente en Azure.
az neon postgres project delete [--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
[--yes]
Ejemplos
Eliminar proyecto neon
az neon postgres project delete --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Id. del proyecto neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del grupo de recursos de Azure.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
No solicita confirmación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az neon postgres project get-connection-uri
Recupere el URI de conexión de una base de datos de Neon Postgres específica.
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]
Ejemplos
Obtención del URI de conexión de base de datos
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
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Id. de rama asociado a esta conexión.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
Nombre de la base de datos asociado a esta conexión.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
Identificador de punto de conexión con esta conexión.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Indica si la conexión está agrupada.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
| Valores aceptados: | 0, 1, f, false, n, no, t, true, y, yes |
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Identificador de proyecto asociado a esta conexión.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
Nombre del proyecto Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del grupo de recursos de Azure.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre de rol usado para la autenticación.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | ConnectionUriParameters Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az neon postgres project list
Enumere todos los proyectos neon asociados a una organización de Neon específica.
az neon postgres project list --organization-name
--resource-group
[--max-items]
[--next-token]
Ejemplos
Enumerar proyectos de Neon dentro de una organización
az neon postgres project list --resource-group rgneon --organization-name org-cli-test
Parámetros requeridos
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
Nombre del grupo de recursos de Azure.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Pagination Arguments |
Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Pagination Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az neon postgres project show
Recupere los detalles de un recurso de proyecto neon específico.
az neon postgres project show [--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
Ejemplos
Show Neon Project Deatils
az neon postgres project show --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Id. del proyecto neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del grupo de recursos de Azure.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az neon postgres project update
Actualice las propiedades de un recurso de proyecto neon existente en 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]
Ejemplos
Actualización del proyecto Neon
az neon postgres project update --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 18
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
Las propiedades Branch del proyecto. Se trata de una sintaxis abreviada opcional, json-file y yaml-file. Intenta "??" para mostrar más.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
| Valores aceptados: | 0, 1, f, false, n, no, t, true, y, yes |
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del proyecto Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
No espere a que finalice la operación de ejecución prolongada.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | 0, 1, f, false, n, no, t, true, y, yes |
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Versión de Postgres para el proyecto.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Región donde se crea el proyecto.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
Nombre del grupo de recursos de Azure.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |