Compartilhar via


az neon postgres branch

Note

Essa referência faz parte da extensão neon para a CLI do Azure (versão 2.70.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando de branch az neon postgres . Saiba mais sobre extensões.

Gerenciar branches em um banco de dados Neon Postgres.

Comandos

Nome Description Tipo Status
az neon postgres branch create

Crie uma nova ramificação em um banco de dados Neon Postgres.

Extension GA
az neon postgres branch delete

Exclua um branch existente em um banco de dados Neon Postgres.

Extension GA
az neon postgres branch list

Liste todos os recursos de branch em um projeto específico no Neon Postgres.

Extension GA
az neon postgres branch show

Recupere detalhes de um branch específico em um banco de dados Neon Postgres.

Extension GA
az neon postgres branch update

Atualize as propriedades de um branch existente em um banco de dados Neon Postgres.

Extension GA
az neon postgres branch wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Extension GA

az neon postgres branch create

Crie uma nova ramificação em um banco de dados 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]

Exemplos

Criar um branch

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 Exigidos

--branch-name --name -n

Nome da ramificação Neon.

--organization-name

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

--project-name

Nome do projeto Neon.

--resource-group -g

Nome do grupo de recursos do Azure.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--database-name

Nome do Banco de Dados Neon associado ao branch.

Propriedade Valor
Parameter group: Properties Arguments
--entity-name

Nome do recurso.

Propriedade Valor
Parameter group: Properties 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
--parent-id

A ID do branch pai.

Propriedade Valor
Parameter group: Properties Arguments
--role-name

Nome da função associado ao branch.

Propriedade Valor
Parameter group: 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 branch delete

Exclua um branch existente em um banco de dados Neon Postgres.

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

Exemplos

Excluir Branch

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 Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch-id

ID da ramificação Neon.

Propriedade Valor
Parameter group: Resource Id 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
Parameter group: Resource Id Arguments
--organization-name

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

Propriedade Valor
Parameter group: Resource Id Arguments
--project-id

ID do projeto Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Parameter group: 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
Parameter group: 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 branch list

Liste todos os recursos de branch em um projeto específico no Neon Postgres.

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

Exemplos

Listar branches em um projeto

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 Exigidos

--organization-name

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

--project-id

ID do projeto Neon.

--resource-group -g

Nome do grupo de recursos do Azure.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group: Pagination Arguments
--next-token

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

Propriedade Valor
Parameter group: 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 branch show

Recupere detalhes de um branch específico em um banco de dados Neon Postgres.

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

Exemplos

Mostrar detalhes do branch

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 Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch-id

ID da ramificação Neon.

Propriedade Valor
Parameter group: Resource Id 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
Parameter group: Resource Id Arguments
--organization-name

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

Propriedade Valor
Parameter group: Resource Id Arguments
--project-id

ID do projeto Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Parameter group: 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
Parameter group: 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 branch update

Atualize as propriedades de um branch existente em um banco de dados 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]

Exemplos

Atualizar um branch

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 Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group: Generic Update Arguments
--branch-name --name -n

Nome da ramificação Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--database-name

Nome do Banco de Dados Neon associado ao branch.

Propriedade Valor
Parameter group: Properties Arguments
--entity-name

Nome do recurso.

Propriedade Valor
Parameter group: Properties Arguments
--force-string

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

Propriedade Valor
Parameter group: 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
Parameter group: 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
Parameter group: Resource Id Arguments
--parent-id

A ID do branch pai.

Propriedade Valor
Parameter group: Properties Arguments
--project-name

Nome do projeto Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--remove

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

Propriedade Valor
Parameter group: Generic Update Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Parameter group: Resource Id Arguments
--role-name

Nome da função associado ao branch.

Propriedade Valor
Parameter group: Properties Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Parameter group: 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
Parameter group: 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 branch wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az neon postgres branch wait [--branch-id]
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--organization-name]
                             [--project-id]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch-id

ID da ramificação Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Parameter group: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: False
--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
Parameter group: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: 30
--organization-name

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

Propriedade Valor
Parameter group: Resource Id Arguments
--project-id

ID do projeto Neon.

Propriedade Valor
Parameter group: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos do Azure.

Propriedade Valor
Parameter group: 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
Parameter group: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
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