az neon postgres branch
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 branch . Obtenga más información sobre las extensiones.
Administrar ramas dentro de una base de datos de Neon Postgres.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az neon postgres branch create |
Cree una nueva rama dentro de una base de datos de Neon Postgres. |
Extension | GA |
| az neon postgres branch delete |
Elimine una rama existente dentro de una base de datos de Neon Postgres. |
Extension | GA |
| az neon postgres branch list |
Enumere todos los recursos de rama dentro de un proyecto específico de Neon Postgres. |
Extension | GA |
| az neon postgres branch show |
Recupere los detalles de una rama específica dentro de una base de datos de Neon Postgres. |
Extension | GA |
| az neon postgres branch update |
Actualice las propiedades de una rama existente dentro de una base de datos de Neon Postgres. |
Extension | GA |
az neon postgres branch create
Cree una nueva rama dentro de una base de datos de Neon Postgres.
az neon postgres branch create --branch-name --name
--organization-name
--project-name
--resource-group
[--database-name]
[--entity-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parent-id]
[--role-name]
Ejemplos
Crear una rama
az neon postgres branch create --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --branch-name test-branch --entity-name test-branch --role-name test_role --database-name testneondb
Parámetros requeridos
Nombre de la rama Neon.
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
Nombre del proyecto Neon.
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.
Nombre de la base de datos neon asociada a la rama.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Nombre del recurso.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties 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 |
Identificador de la rama primaria.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Nombre de rol asociado a la rama.
| 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 branch delete
Elimine una rama existente dentro de una base de datos de Neon Postgres.
az neon postgres branch delete [--branch-id]
[--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
[--yes]
Ejemplos
Eliminar rama
az neon postgres branch delete --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr
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 la rama Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id 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 |
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 branch list
Enumere todos los recursos de rama dentro de un proyecto específico de Neon Postgres.
az neon postgres branch list --organization-name
--project-id
--resource-group
[--max-items]
[--next-token]
Ejemplos
Enumerar ramas en un proyecto
az neon postgres branch list --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796
Parámetros requeridos
Nombre de la organización neon. Si el valor está en blanco, se le pregunta desde tty.
Id. del proyecto neon.
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 branch show
Recupere los detalles de una rama específica dentro de una base de datos de Neon Postgres.
az neon postgres branch show [--branch-id]
[--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
Ejemplos
Mostrar detalles de la rama
az neon postgres branch show --subscription 38a546de-5736-48e8-a69a-5cc636794112 --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr
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 la rama Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id 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 |
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 branch update
Actualice las propiedades de una rama existente dentro de una base de datos de Neon Postgres.
az neon postgres branch update [--add]
[--branch-name --name]
[--database-name]
[--entity-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--organization-name]
[--parent-id]
[--project-name]
[--remove]
[--resource-group]
[--role-name]
[--set]
[--subscription]
Ejemplos
Actualizar una rama
az neon postgres branch update --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --project-id old-frost-16758796 --branch-name test-branch --entity-name test-branch2 --role-name test_role --database-name testneondb
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 |
Nombre de la rama Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre de la base de datos neon asociada a la rama.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Nombre del recurso.
| 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 |
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 |
Identificador de la rama primaria.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties Arguments |
Nombre del proyecto Neon.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id 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 |
Nombre de rol asociado a la rama.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Properties 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 |