az cosmosdb gremlin role definition

Note

Essa referência faz parte da extensão cosmosdb-preview para a CLI do Azure (versão 2.17.1 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando de definição de função do az cosmosdb gremlin . Saiba mais sobre extensões.

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

Comandos

Nome	Description	Tipo	Status
az cosmosdb gremlin role definition create	Crie uma definição de função do Gremlin em uma conta do Azure Cosmos DB.	Extension	GA
az cosmosdb gremlin role definition delete	Exclua uma definição de função do Gremlin em uma conta do Azure Cosmos DB.	Extension	GA
az cosmosdb gremlin role definition exists	Verifique se existe uma definição de função do Azure Cosmos DB.	Extension	GA
az cosmosdb gremlin role definition list	Liste todas as definições de função do Gremlin em uma conta do Azure Cosmos DB.	Extension	GA
az cosmosdb gremlin role definition show	Mostrar as propriedades de uma definição de função do Gremlin em uma conta do Azure Cosmos DB.	Extension	GA
az cosmosdb gremlin role definition update	Atualize uma definição de função do Gremlin em uma conta do Azure Cosmos DB.	Extension	GA

az cosmosdb gremlin role definition create

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

az cosmosdb gremlin role definition create --account-name
                                           --body
                                           --resource-group

Exemplos

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

az cosmosdb gremlin 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/gremlin/containers/entities/read",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/readChangeFeed"
    ]
  }]
}'

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

az cosmosdb gremlin 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 criar), Tipo (Padrão é CustomRole), RoleName, Descrição, AssignableScopes, Permissões. Você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --body @gremlin-role_definition-body-file.json ou --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "MyTestRole", "type": "type": "CustomRole", "description": "Função personalizada para ler metadados do Cosmos DB", "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissões": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"]}] }".

--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 gremlin role definition delete

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

az cosmosdb gremlin role definition delete --account-name
                                           --resource-group
                                           --role-definition-id
                                           [--yes]

Exemplos

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

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

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

--role-definition-id -i

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

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.

--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 gremlin role definition exists

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

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

Exemplos

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

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

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

--role-definition-id -i

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

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 gremlin role definition list

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

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

Exemplos

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

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

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

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

Exemplos

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

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

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

--role-definition-id -i

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

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 gremlin role definition update

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

az cosmosdb gremlin role definition update --account-name
                                           --body
                                           --resource-group

Exemplos

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

az cosmosdb gremlin 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

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

Compartilhar via

az cosmosdb gremlin role definition

Comandos

az cosmosdb gremlin role definition create

Exemplos

Parâmetros Exigidos

az cosmosdb gremlin role definition delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az cosmosdb gremlin role definition exists

Exemplos

Parâmetros Exigidos

az cosmosdb gremlin role definition list

Exemplos

Parâmetros Exigidos

az cosmosdb gremlin role definition show

Exemplos

Parâmetros Exigidos

az cosmosdb gremlin role definition update

Exemplos

Parâmetros Exigidos

Comentários