Share via

az cosmosdb sql role definition

  • Referência

Gerencie definições de função SQL do Azure Cosmos DB.

Comandos

Name Description Tipo Estado
az cosmosdb sql role definition create

Crie uma definição de função SQL em uma conta do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition delete

Exclua uma definição de função SQL em uma conta do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition exists

Verifique se existe uma definição de função do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition list

Liste todas as definições de função SQL em uma conta do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition show

Mostrar as propriedades de uma definição de função SQL em uma conta do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition update

Atualize uma definição de função SQL em uma conta do Azure Cosmos DB.

 Principal GA
az cosmosdb sql role definition wait

Sondagem em uma definição de função SQL até que uma condição específica seja atendida.

 Principal GA

az cosmosdb sql role definition create

Editar

Crie uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition create --account-name
                                       --body
                                       --resource-group
                                       [--no-wait]

Exemplos

Crie uma definição de função SQL em uma conta do Azure Cosmos DB usando uma cadeia de caracteres JSON.

az cosmosdb sql role definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "be79875a-2cc4-40d5-8958-566017875b39",
  "RoleName": "My Read Only Role",
  "Type": "CustomRole",
  "AssignableScopes": ["/dbs/mydb/colls/mycontainer"],
  "Permissions": [{
    "DataActions": [
      "Microsoft.DocumentDB/databaseAccounts/readMetadata",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readChangeFeed"
    ]
  }]
}'

Crie uma definição de função SQL em uma conta do Azure Cosmos DB usando um arquivo JSON.

az cosmosdb sql role definition create --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--body -b

Corpo da definição de função com Id (Opcional para criação), DataActions ou Permissões, Tipo (Padrão é CustomRole) e AssignableScopes. Você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --body ou --body @rdbody-file.json "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "My Read Write Role", "Type": "CustomRole", "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" ]}".

--resource-group -g

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

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition delete

Editar

Exclua uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition delete --account-name
                                       --id
                                       --resource-group
                                       [--no-wait]
                                       [--yes]

Exemplos

Exclua uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition delete --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--id -i

ID exclusivo para a definição de função.

--resource-group -g

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

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False
--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition exists

Editar

Verifique se existe uma definição de função do Azure Cosmos DB.

az cosmosdb sql role definition exists --account-name
                                       --id
                                       --resource-group

Exemplos

Verifique se existe uma definição de função do Azure Cosmos DB.

az cosmosdb sql role definition exists --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--id -i

ID exclusivo para a definição de função.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition list

Editar

Liste todas as definições de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition list --account-name
                                     --resource-group

Exemplos

Liste todas as definições de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition list --account-name MyAccount --resource-group MyResourceGroup

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition show

Editar

Mostrar as propriedades de uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition show --account-name
                                     --id
                                     --resource-group

Exemplos

Mostrar as propriedades de uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition show --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--id -i

ID exclusivo para a definição de função.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition update

Editar

Atualize uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition update --account-name
                                       --body
                                       --resource-group
                                       [--no-wait]

Exemplos

Atualize uma definição de função SQL em uma conta do Azure Cosmos DB.

az cosmosdb sql role definition update --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--body -b

Corpo da definição de função com Id (Opcional para criação), DataActions ou Permissões, Tipo (Padrão é CustomRole) e AssignableScopes. Você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --body ou --body @rdbody-file.json "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "My Read Write Role", "Type": "CustomRole", "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" ]}".

--resource-group -g

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

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb sql role definition wait

Editar

Sondagem em uma definição de função SQL até que uma condição específica seja atendida.

az cosmosdb sql role definition wait --account-name
                                     --id
                                     --resource-group
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

Exemplos

Sondagem em uma definição de função SQL até que ela seja excluída.

az cosmosdb sql role definition wait --account-name MyAccount --resource-group MyResourceGroup --id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 --deleted

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--id -i

ID exclusivo para a definição de função.

--resource-group -g

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

Parâmetros Opcionais

--created

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

valor predefinido: 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 predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

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

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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