Compartilhar via

az confluent organization

  • Referência

Observação

Essa referência faz parte da extensão confluente para a CLI do Azure (versão 2.56.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az confluent organization . Saiba mais sobre extensões.

Comandos para executar ações em uma organização confluente.

Comandos

Nome Description Tipo Status
az confluent organization api-key

Gerenciar chave de api de cluster.

 Extensão GA
az confluent organization api-key delete

Exclua a chave de API de um cluster de registro kafka ou esquema.

 Extensão GA
az confluent organization create

Criar recurso da organização.

 Extensão GA
az confluent organization create-role-binding

Vinculações de função da organização.

 Extensão GA
az confluent organization create-user

Convidar usuário para a organização.

 Extensão GA
az confluent organization delete

Excluir recurso da organização.

 Extensão GA
az confluent organization environment

Comandos para obter os ambientes confluentes na organização.

 Extensão GA
az confluent organization environment cluster

Comando para obter os detalhes do cluster confluente em um ambiente.

 Extensão GA
az confluent organization environment cluster create-api-key

Cria uma chave de API para uma ID de Cluster de Registro de Esquema ou ID de Cluster Kafka em um ambiente.

 Extensão GA
az confluent organization environment cluster list

Lista de todos os clusters em um ambiente.

 Extensão GA
az confluent organization environment cluster show

Obter cluster por Id.

 Extensão GA
az confluent organization environment list

Lista de todos os ambientes em uma organização.

 Extensão GA
az confluent organization environment schema-registry-cluster

Comandos para obter os detalhes do cluster de registro de esquema em um ambiente.

 Extensão GA
az confluent organization environment schema-registry-cluster list

Listar clusters de registro de esquema.

 Extensão GA
az confluent organization environment schema-registry-cluster show

Obtenha o cluster de registro de esquema por Id.

 Extensão GA
az confluent organization list

Liste todas as Organizações no grupo de recursos especificado. E Liste todas as organizações sob a assinatura especificada.

 Extensão GA
az confluent organization list-role-binding

Vinculações de função da organização.

 Extensão GA
az confluent organization list-service-accounts

Detalhes das contas de serviço da organização.

 Extensão GA
az confluent organization list-users

Detalhes dos usuários da organização.

 Extensão GA
az confluent organization role-binding

Gerenciar vinculação de função.

 Extensão GA
az confluent organization role-binding delete

Excluir associações de função.

 Extensão GA
az confluent organization show

Obtenha as propriedades de um recurso específico da organização.

 Extensão GA
az confluent organization update

Atualizar recurso da organização.

 Extensão GA
az confluent organization wait

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

 Extensão GA

az confluent organization create

Criar recurso da organização.

az confluent organization create --name
                                 --plan-id
                                 --plan-name
                                 --resource-group
                                 --term-unit
                                 [--location]
                                 [--no-wait]
                                 [--offer-id]
                                 [--publisher-id]
                                 [--tags]

Exemplos

Criar organização

az confluent organization create --location "West US" --tags Environment="Dev" --name "myOrganization" --resource-group "myResourceGroup" --offer-id "confluent-cloud-azure-prod" --plan-id "confluent-cloud-azure-payg-prod" --plan-name "Confluent Cloud - Pay as you Go" --publisher-id "confluentinc" --term-unit "P1M"

Parâmetros Exigidos

--name --organization-name -n

Nome do recurso da organização.

--plan-id

Id do plano de oferta.

--plan-name

Nome do plano de oferta.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--term-unit

Unidade de Prazo do Plano de Oferta.

Parâmetros Opcionais

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--no-wait

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

Valor padrão: False
--offer-id

Id da oferta.

Valor padrão: confluent-cloud-azure-prod
--publisher-id

ID do editor.

Valor padrão: confluentinc
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization create-role-binding

Vinculações de função da organização.

az confluent organization create-role-binding [--crn-pattern]
                                              [--ids]
                                              [--organization-name]
                                              [--principal]
                                              [--resource-group]
                                              [--role-name]
                                              [--subscription]

Parâmetros Opcionais

--crn-pattern

Uma CRN que especifica o escopo e os padrões de recursos necessários para a função vincular.

--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 do recurso".

--organization-name

Nome do recurso da organização.

--principal

O usuário ou grupo principal ao qual vincular a função.

--resource-group

Nome do grupo de recursos.

--role-name

O nome da função a ser vinculada à entidade de segurança.

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization create-user

Convidar usuário para a organização.

az confluent organization create-user [--auth-type]
                                      [--email]
                                      [--ids]
                                      [--invited-email]
                                      [--organization-id]
                                      [--organization-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--upn]

Parâmetros Opcionais

--auth-type

Tipo de autenticação do usuário.

--email

E-mail do usuário conectado.

--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 do recurso".

--invited-email

UPN/Email do usuário que está sendo convidado.

--organization-id

Id da organização.

--organization-name

Nome do recurso da organização.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

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

--upn

Upn do usuário conectado.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization delete

Excluir recurso da organização.

az confluent organization delete [--ids]
                                 [--name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Exemplos

Excluir organização

az confluent organization delete --name "myOrganization" --resource-group "myResourceGroup"

Excluir organização usando IDs

az confluent organization delete --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

Parâmetros Opcionais

--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 do recurso".

--name --organization-name -n

Nome do recurso da organização.

--no-wait

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

Valor padrão: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

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

--yes -y

Não solicite confirmação.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization list

Liste todas as Organizações no grupo de recursos especificado. E Liste todas as organizações sob a assinatura especificada.

az confluent organization list [--resource-group]

Exemplos

Organization_ListByResourceGroup

az confluent organization list --resource-group "myResourceGroup"

Organization_ListBySubscription

az confluent organization list

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization list-role-binding

Vinculações de função da organização.

az confluent organization list-role-binding [--ids]
                                            [--organization-name]
                                            [--resource-group]
                                            [--search-filters]
                                            [--subscription]

Parâmetros Opcionais

--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 do recurso".

--organization-name

Nome do recurso da organização.

--resource-group

Nome do grupo de recursos.

--search-filters

Filtros de pesquisa para a solicitação Suporte a sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization list-service-accounts

Detalhes das contas de serviço da organização.

az confluent organization list-service-accounts [--ids]
                                                [--organization-name]
                                                [--resource-group]
                                                [--search-filters]
                                                [--subscription]

Parâmetros Opcionais

--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 do recurso".

--organization-name

Nome do recurso da organização.

--resource-group

Nome do grupo de recursos.

--search-filters

Filtros de pesquisa para a solicitação Suporte a sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization list-users

Detalhes dos usuários da organização.

az confluent organization list-users [--ids]
                                     [--organization-name]
                                     [--resource-group]
                                     [--search-filters]
                                     [--subscription]

Parâmetros Opcionais

--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 do recurso".

--organization-name

Nome do recurso da organização.

--resource-group

Nome do grupo de recursos.

--search-filters

Filtros de pesquisa para a solicitação Suporte a sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization show

Obtenha as propriedades de um recurso específico da organização.

az confluent organization show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Exemplos

Organização do espetáculo

az confluent organization show --name "myOrganization" --resource-group "myResourceGroup"

Mostrar organização usando IDs

az confluent organization show --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

Parâmetros Opcionais

--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 do recurso".

--name --organization-name -n

Nome do recurso da organização.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization update

Atualizar recurso da organização.

az confluent organization update [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

Exemplos

Confluent_Update

az confluent organization update --tags client="dev-client" env="dev" --name "myOrganization" --resource-group "myResourceGroup"

Parâmetros Opcionais

--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 do recurso".

--name --organization-name -n

Nome do recurso da organização.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

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

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az confluent organization wait

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

az confluent organization wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

Exemplos

Pause a execução da próxima linha do script da CLI até que a organização confluente seja criada com êxito.

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --created

Pause a execução da próxima linha do script da CLI até que a organização confluente seja excluída com êxito.

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --deleted

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

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

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

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 do recurso".

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name --organization-name -n

Nome do recurso da organização.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

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

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

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

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

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.