az cosmosdb sql role definition

Управление определениями ролей SQL Azure Cosmos DB.

Команды

Имя Описание Тип Состояние
az cosmosdb sql role definition create

Создайте определение роли SQL в учетной записи Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition delete

Удалите определение роли SQL в учетной записи Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition exists

Проверьте, существует ли определение роли Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition list

Список всех определений ролей SQL в учетной записи Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition show

Отображение свойств определения роли SQL в учетной записи Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition update

Обновите определение роли SQL в учетной записи Azure Cosmos DB.

Основные сведения Общедоступная версия
az cosmosdb sql role definition wait

Опрос определения роли SQL до тех пор, пока не будет выполнено определенное условие.

Основные сведения Общедоступная версия

az cosmosdb sql role definition create

Создайте определение роли SQL в учетной записи Azure Cosmos DB.

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

Примеры

Создайте определение роли SQL в учетной записи Azure Cosmos DB с помощью строки 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"
    ]
  }]
}'

Создайте определение роли SQL в учетной записи Azure Cosmos DB с помощью JSON-файла.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--body -b

Текст определения роли с идентификатором (необязательно для создания), DataActions или Permissions, Type (по умолчанию — CustomRole) и AssignableScopes. Его можно ввести в виде строки или в виде файла, например --body или --body @rdbody-file.json "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", RoleName: "My Read Write Role", "Type": CustomRole, "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container/items/create", "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container/items/read" ]}.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition delete

Удалите определение роли SQL в учетной записи Azure Cosmos DB.

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

Примеры

Удалите определение роли SQL в учетной записи Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--id -i

Уникальный идентификатор определения роли.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
--yes -y

Не запрашивать подтверждение.

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition exists

Проверьте, существует ли определение роли Azure Cosmos DB.

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

Примеры

Проверьте, существует ли определение роли Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--id -i

Уникальный идентификатор определения роли.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition list

Список всех определений ролей SQL в учетной записи Azure Cosmos DB.

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

Примеры

Список всех определений ролей SQL в учетной записи Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition show

Отображение свойств определения роли SQL в учетной записи Azure Cosmos DB.

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

Примеры

Отображение свойств определения роли SQL в учетной записи Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--id -i

Уникальный идентификатор определения роли.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition update

Обновите определение роли SQL в учетной записи Azure Cosmos DB.

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

Примеры

Обновите определение роли SQL в учетной записи Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--body -b

Текст определения роли с идентификатором (необязательно для создания), DataActions или Permissions, Type (по умолчанию — CustomRole) и AssignableScopes. Его можно ввести в виде строки или в виде файла, например --body или --body @rdbody-file.json "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", RoleName: "My Read Write Role", "Type": CustomRole, "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container/items/create", "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container/items/read" ]}.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb sql role definition wait

Опрос определения роли SQL до тех пор, пока не будет выполнено определенное условие.

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

Примеры

Опрос определения роли SQL до его удаления.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--id -i

Уникальный идентификатор определения роли.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

значение по умолчанию: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

значение по умолчанию: False
--exists

Подождите, пока ресурс не существует.

значение по умолчанию: False
--interval

Интервал опроса в секундах.

значение по умолчанию: 30
--timeout

Максимальное ожидание в секундах.

значение по умолчанию: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.