az neon postgres project
Note
Essa referência faz parte da extensão neon para a CLI do Azure (versão 2.75.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az neon postgres project . Saiba mais sobre extensões.
Gerencie projetos Neon, incluindo listagem, criação, atualização, exclusão e recuperação de informações do projeto.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az neon postgres project create |
Crie um novo recurso de projeto Neon no Azure. |
Extension | disponibilidade geral |
| az neon postgres project delete |
Exclua um recurso de projeto Neon existente no Azure. |
Extension | disponibilidade geral |
| az neon postgres project get-connection-uri |
Recupere o URI de conexão para um banco de dados Neon Postgres específico. |
Extension | disponibilidade geral |
| az neon postgres project list |
Liste todos os projetos Neon associados a uma organização Neon específica. |
Extension | disponibilidade geral |
| az neon postgres project show |
Recupere detalhes de um recurso específico do projeto Neon. |
Extension | disponibilidade geral |
| az neon postgres project update |
Atualize as propriedades de um recurso de projeto Neon existente no Azure. |
Extension | disponibilidade geral |
az neon postgres project create
Crie um novo recurso de projeto Neon no 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]
Exemplos
Criar Projeto 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 Obrigatórios
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
Nome do grupo de recursos do Azure.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
As propriedades Branch do projeto. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Nome do projeto Neon.
| Propriedade | Valor |
|---|---|
| Default value: | Default-Project |
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
A versão PostgreSQL para o Banco de Dados Neon, com um padrão de 17.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
| Default value: | 17 |
A região onde o projeto é criado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az neon postgres project delete
Exclua um recurso de projeto Neon existente no Azure.
az neon postgres project delete [--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Excluir projeto Neon
az neon postgres project delete --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Id do projeto Neon.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos do Azure.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az neon postgres project get-connection-uri
Recupere o URI de conexão para um banco de dados Neon Postgres específico.
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]
Exemplos
Obter URI de conexão de banco de dados
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 Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
ID da ramificação associada a esta ligação.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
Nome do banco de dados associado a essa conexão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
O ID do ponto de extremidade com essa conexão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Indica se a conexão está agrupada.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
ID do projeto associado a esta conexão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
Nome do projeto Neon.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos do Azure.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da função usado para autenticação.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | ConnectionUriParameters Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az neon postgres project list
Liste todos os projetos Neon associados a uma organização Neon específica.
az neon postgres project list --organization-name
--resource-group
[--max-items]
[--next-token]
Exemplos
Listar projetos Neon dentro de uma organização
az neon postgres project list --resource-group rgneon --organization-name org-cli-test
Parâmetros Obrigatórios
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
Nome do grupo de recursos do Azure.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Pagination Arguments |
Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Pagination Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az neon postgres project show
Recupere detalhes de um recurso específico do projeto Neon.
az neon postgres project show [--ids]
[--organization-name]
[--project-id]
[--resource-group]
[--subscription]
Exemplos
Mostrar Projeto Neon Deatils
az neon postgres project show --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Id do projeto Neon.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos do Azure.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az neon postgres project update
Atualize as propriedades de um recurso de projeto Neon existente no 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]
Exemplos
Atualização do Projeto Neon
az neon postgres project update --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 18
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
As propriedades Branch do projeto. Este é opcional Suporte taquigrafia-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do projeto Neon.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Valores aceites: | 0, 1, f, false, n, no, t, true, y, yes |
Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Versão Postgres para o projeto.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Região onde o projeto é criado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Nome do grupo de recursos do Azure.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |