Получение списка ролей, доступных пользователям подписки Microsoft Azure Plan

Метод используется для получения одностраничного списка ролей, доступных пользователям подписки Microsoft Azure Plan (см. Получение списка подписок Microsoft Azure Plan) для аккаунта, к которому есть доступ у текущего пользователя. Для вызова метода у аккаунта в платформе должны быть сохранены Tenant Name и Tenant ID. В результате вызова метода модуль MicrosoftCSPProductsPlugin запрашивает информацию на стороне Microsoft (см. Role Definitions).

GET {reseller_domain}/plugin_microsoft_csp_products/internal_api/azure_subscriptions/role_definitions

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	query	integer	Обязательный	ID аккаунта, которому принадлежит подписка Microsoft Azure Plan
azure_subscription_id	query	string	Обязательный	ID подписки Microsoft Azure Plan в Microsoft (см. Получение списка подписок Microsoft Azure Plan)

Модель ответа

Название				Тип данных	Описание	Параметр ответа от Microsoft
data				array of objects	Данные ответа. Список ролей, доступных пользователям подписки Microsoft Azure Plan
	id			string	ID определения роли	id
	type			string	Тип определения роли	type
	name			string	Название определения роли	name
	properties			object	Свойства роли	properties
		assignable_scopes		array	Список скоупов	properties.assignableScopes
		permissions		array of objects	Список разрешений для роли	properties.permissions
			actions	array	Разрешенные действия	properties.permissions.actions
			not_actions	array	Запрещенные действия	properties.permissions.notActions
			data_actions	array	Разрешенные действия над данными	properties.permissions.dataActions
			not_data_actions	array	Запрещенные действия над данными	properties.permissions.notDataActions
		role_name		string	Название роли	properties.roleName
		type		string	Тип роли	properties.type
		description		string	Описание роли	properties.description
		created_on		string	Дата создания роли	properties.createdOn
		updated_on		string	Дата последнего обновления роли	properties.updatedOn
		created_by		string	ID пользователя, создавшего роль	properties.createdBy
		updated_by		string	ID пользователя, обновившего роль	properties.updatedBy

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/azure_subscriptions/role_definitions?account_id=1938&azure_subscription_id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
  "data": [
    {
      "id": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/providers/Microsoft.Authorization/roleDefinitions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "properties": {
        "assignable_scopes": [
          "/"
        ],
        "permissions": [
          {
            "actions": [
              "Microsoft.Workloads/sapvirtualInstances/*/read",
              "Microsoft.Workloads/Locations/*/action",
              "Microsoft.Workloads/Operations/read",
              "Microsoft.Workloads/Locations/OperationStatuses/read",
              "Microsoft.Resources/subscriptions/resourceGroups/read",
              "Microsoft.Insights/alertRules/*",
              "Microsoft.Resources/deployments/*",
              "Microsoft.Authorization/*/read",
              "Microsoft.Resources/subscriptions/read",
              "Microsoft.Resources/subscriptions/resourcegroups/deployments/*",
              "Microsoft.ResourceHealth/availabilityStatuses/read"
            ],
            "not_actions": [],
            "data_actions": [],
            "not_data_actions": []
          }
        ],
        "role_name": "Azure Center for SAP solutions reader",
        "type": "BuiltInRole",
        "description": "This role provides read access to all capabilities of Azure Center for SAP solutions.",
        "created_on": "2022-10-03T15:02:12.784Z",
        "updated_on": "2022-11-11T20:08:43.034Z",
        "created_by": "",
        "updated_by": ""
      }
    },
    {
      "id": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/providers/Microsoft.Authorization/roleDefinitions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "properties": {
        "assignable_scopes": [
          "/"
        ],
        "permissions": [
          {
            "actions": [
              "Microsoft.Resources/subscriptions/resourceGroups/read",
              "Microsoft.Resources/deployments/*",
              "Microsoft.Resources/subscriptions/read",
              "Microsoft.Resources/subscriptions/resourcegroups/deployments/*"
            ],
            "not_actions": [],
            "data_actions": [],
            "not_data_actions": []
          }
        ],
        "role_name": "Azure Center for SAP solutions service role",
        "type": "BuiltInRole",
        "description": "Azure Center for SAP solutions service role - This role is intended to be used for providing the permissions to user assigned managed identity. Azure Center for SAP solutions will use this identity to deploy and manage SAP systems.",
        "created_on": "2022-10-03T15:02:12.784Z",
        "updated_on": "2022-11-11T20:08:43.066Z",
        "created_by": "",
        "updated_by": ""
      }
    }
  ]
}