Compartilhar via


az cosmosdb sql role definition

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

Comandos

Nome Description Tipo Status
az cosmosdb sql role definition create

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

Core GA
az cosmosdb sql role definition delete

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

Core GA
az cosmosdb sql role definition exists

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

Core GA
az cosmosdb sql role definition list

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

Core GA
az cosmosdb sql role definition show

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

Core GA
az cosmosdb sql role definition update

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

Core GA
az cosmosdb sql role definition wait

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

Core GA

az cosmosdb sql role definition create

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 Exigidos

--account-name -a

Nome da conta do 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 @rdbody-file.json ou --body "{ "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

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

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.

--no-wait

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

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.

--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 cosmosdb sql role definition delete

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 Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--id -i

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

--resource-group -g

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

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.

--no-wait

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

Propriedade Valor
Valor padrão: False
--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.

--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 cosmosdb sql role definition exists

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 Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--id -i

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

--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 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 cosmosdb sql role definition list

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 Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--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 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 cosmosdb sql role definition show

Mostre 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

Mostre 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 Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--id -i

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

--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 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 cosmosdb sql role definition update

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 Exigidos

--account-name -a

Nome da conta do 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 @rdbody-file.json ou --body "{ "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

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

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.

--no-wait

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

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.

--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 cosmosdb sql role definition wait

Sonde 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

Sondar 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 Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--id -i

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

--resource-group -g

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

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.

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

Intervalo de sondagem em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Valor padrão: 30
--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.

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