Sql Resources - Create Update Sql Role Definition

Ссылка

Service:: Cosmos DB Resource Provider

API Version:: 2021-04-01-preview

Создает или обновляет определение роли SQL базы данных Azure Cosmos.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}?api-version=2021-04-01-preview

Параметры URI

Name	In	Required	Type	Description
accountName	path	True	string	Cosmos имя учетной записи базы данных базы данных. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
roleDefinitionId	path	True	string	GUID для определения роли.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

Текст запроса

Name	Type	Description
properties.assignableScopes	string[]	Набор полных областей, по которым можно создавать назначения ролей с помощью этого определения роли или ниже. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Должен иметь по крайней мере один элемент. Области выше, чем учетная запись базы данных, не применяются в качестве назначаемых областей. Обратите внимание, что ресурсы, на которые ссылаются назначенные области, не требуются.
properties.permissions	Permission[]	Набор операций, разрешенных с помощью этого определения роли.
properties.roleName	string	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.
properties.type	RoleDefinitionType	Указывает, было ли создано определение роли или пользователь.

Ответы

Name	Type	Description
200 OK	SqlRoleDefinitionGetResults	Операция создания или обновления определения роли успешно завершена.
202 Accepted		Запрос на создание или обновление определения роли был принят и будет выполняться асинхронно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Олицетворение учетной записи пользователя

Примеры

CosmosDBSqlRoleDefinitionCreateUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId?api-version=2021-04-01-preview

{
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create",
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create",
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read"
        ]
      }
    ]
  }
}

Status code:: 202

Определения

CloudError	Ответ об ошибке службы.
ErrorResponse	Ответ на ошибку.
Permission	Набор операций плоскости данных, разрешенных с помощью этого определения роли.
RoleDefinitionType	Указывает, было ли создано определение роли или пользователь.
SqlRoleDefinitionCreateUpdateParameters	Параметры для создания и обновления определения роли SQL Базы данных Azure Cosmos.
SqlRoleDefinitionGetResults	Определение роли SQL базы данных Azure Cosmos.

CloudError

Ответ об ошибке службы.

Name	Type	Description
error	ErrorResponse	Ответ на ошибку.

ErrorResponse

Ответ на ошибку.

Name	Type	Description
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

Permission

Набор операций плоскости данных, разрешенных с помощью этого определения роли.

Name	Type	Description
dataActions	string[]	Массив разрешенных действий с данными.
notDataActions	string[]	Массив действий с данными, которые запрещены.

RoleDefinitionType

Указывает, было ли создано определение роли или пользователь.

Name	Type	Description
BuiltInRole	string
CustomRole	string

SqlRoleDefinitionCreateUpdateParameters

Параметры для создания и обновления определения роли SQL Базы данных Azure Cosmos.

Name	Type	Description
properties.assignableScopes	string[]	Набор полных областей, по которым можно создавать назначения ролей с помощью этого определения роли или ниже. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Должен иметь по крайней мере один элемент. Области выше, чем учетная запись базы данных, не применяются в качестве назначаемых областей. Обратите внимание, что ресурсы, на которые ссылаются назначенные области, не требуются.
properties.permissions	Permission[]	Набор операций, разрешенных с помощью этого определения роли.
properties.roleName	string	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.
properties.type	RoleDefinitionType	Указывает, было ли создано определение роли или пользователь.

SqlRoleDefinitionGetResults

Определение роли SQL базы данных Azure Cosmos.

Name	Type	Description
id	string	Уникальный идентификатор ресурса учетной записи базы данных.
name	string	Имя учетной записи базы данных.
properties.assignableScopes	string[]	Набор полных областей, по которым можно создавать назначения ролей с помощью этого определения роли или ниже. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Должен иметь по крайней мере один элемент. Области выше, чем учетная запись базы данных, не применяются в качестве назначаемых областей. Обратите внимание, что ресурсы, на которые ссылаются назначенные области, не требуются.
properties.permissions	Permission[]	Набор операций, разрешенных с помощью этого определения роли.
properties.roleName	string	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.
properties.type	RoleDefinitionType	Указывает, было ли создано определение роли или пользователь.
type	string	Тип ресурса Azure.