Partilhar via


az neon postgres branch

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 branch . Saiba mais sobre extensões.

Gerencie filiais dentro de um banco de dados Neon Postgres.

Comandos

Name Description Tipo Status
az neon postgres branch create

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

Extension disponibilidade geral
az neon postgres branch delete

Exclua uma ramificação existente em um banco de dados Neon Postgres.

Extension disponibilidade geral
az neon postgres branch list

Liste todos os recursos da filial dentro de um projeto específico no Neon Postgres.

Extension disponibilidade geral
az neon postgres branch show

Recupere detalhes de uma ramificação específica dentro de um banco de dados Neon Postgres.

Extension disponibilidade geral
az neon postgres branch update

Atualize as propriedades de uma ramificação existente em um banco de dados Neon Postgres.

Extension disponibilidade geral

az neon postgres branch create

Crie uma nova ramificação dentro de 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 uma ramificação

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 Obrigatórios

--branch-name --name -n

Nome do ramo Neon.

--organization-name

Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.

--project-name

Nome do projeto Neon.

--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 tornar-se necessários para que o comando seja executado com êxito.

--database-name

Nome do banco de dados Neon associado à ramificação.

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

Nome do recurso.

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

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
--parent-id

A ID da ramificação principal.

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

Nome da função associado à ramificação.

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az neon postgres branch delete

Exclua uma ramificação 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 ramificação

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

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.

--branch-id

Id do ramo Neon.

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

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
--organization-name

Nome da organização Neon. Se o valor estiver em branco, é solicitado ao 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 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
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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

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

Propriedade Valor
Default value: False

az neon postgres branch list

Liste todos os recursos da filial dentro de um projeto específico no Neon Postgres.

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

Exemplos

Listar ramificações 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 Obrigatórios

--organization-name

Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.

--project-id

Id do projeto Neon.

--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 tornar-se necessários para que o comando seja executado com êxito.

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az neon postgres branch show

Recupere detalhes de uma ramificação específica dentro de um banco de dados Neon Postgres.

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

Exemplos

Mostrar detalhes da filial

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

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.

--branch-id

Id do ramo Neon.

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

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
--organization-name

Nome da organização Neon. Se o valor estiver em branco, é solicitado ao 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 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
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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

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

Propriedade Valor
Default value: False

az neon postgres branch update

Atualize as propriedades de uma ramificação 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 uma filial

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

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.

--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-name --name -n

Nome do ramo Neon.

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

Nome do banco de dados Neon associado à ramificação.

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

Nome do recurso.

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

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

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
--no-wait

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
--organization-name

Nome da organização Neon. Se o valor estiver em branco, é solicitado ao tty.

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

A ID da ramificação principal.

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

Nome do projeto Neon.

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

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
--resource-group -g

Nome do grupo de recursos do Azure.

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

Nome da função associado à ramificação.

Propriedade Valor
Grupo de parâmetros: Properties 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 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
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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

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

Propriedade Valor
Default value: False