Compartilhar via

az neon postgres project

Note

Essa referência faz parte da extensão neon da CLI do Azure (versão 2.75.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando de projeto az neon postgres . 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

Nome Description Tipo Status
az neon postgres project create

Crie um novo recurso de projeto Neon no Azure.

 Extension GA
az neon postgres project delete

Exclua um recurso de projeto Neon existente no Azure.

 Extension GA
az neon postgres project get-connection-uri

Recupere o URI de conexão para um banco de dados Específico do Neon Postgres.

 Extension GA
az neon postgres project list

Liste todos os projetos Neon associados a uma organização específica do Neon.

 Extension GA
az neon postgres project show

Recupere detalhes de um recurso específico do projeto Neon.

 Extension GA
az neon postgres project update

Atualize as propriedades de um recurso de projeto Neon existente no Azure.

 Extension GA

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 Exigidos

--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

--resource-group -g

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--branch

As propriedades do Branch do projeto. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--name --project-name -n

Nome do projeto Neon.

Propriedade Valor
Valor padrão: Default-Project
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--pg-version

A versão do PostgreSQL para o Banco de Dados Neon, com um padrão de 17.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valor padrão: 17
--region

A região em que o projeto é criado.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--project-id

ID do projeto Neon.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az neon postgres project get-connection-uri

Recupere o URI de conexão para um banco de dados Específico do Neon Postgres.

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--branch-id

ID de branch associada a essa conexão.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
--database-name

Nome do banco de dados associado a essa conexão.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
--endpoint-id

A ID do ponto de extremidade com essa conexão.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--is-pooled

Indica se a conexão está em pool.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--project-id

ID do projeto associada a essa conexão.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
--project-name

Nome do projeto Neon.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--role-name

O nome da função usado para autenticação.

Propriedade Valor
Grupo de parâmetros: ConnectionUriParameters Arguments
--subscription

Nome ou ID da assinatura. 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 Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az neon postgres project list

Liste todos os projetos Neon associados a uma organização específica do Neon.

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

Exemplos

Listar projetos neon em uma organização

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

Parâmetros Exigidos

--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

--resource-group -g

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--max-items

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
--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: 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 Deatils do Projeto Neon

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--project-id

ID do projeto Neon.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. 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 Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--add

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
--branch

As propriedades do Branch do projeto. Essa é uma sintaxe de suporte opcional, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --project-name -n

Nome do projeto Neon.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Nome da organização Neon. Se o valor estiver em branco, ele será solicitado no tty.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--pg-version

Versão do Postgres para o projeto.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--region

Região em que o projeto é criado.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

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
--subscription

Nome ou ID da assinatura. 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 Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False