Capacities - Update

Ссылка

Service:: Power BI Embedded

API Version:: 2021-01-01

Обновления текущее состояние указанной выделенной емкости.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}?api-version=2021-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
dedicatedCapacityName	path	True	string	Имя выделенной емкости. Длина должна быть не менее 3 символов и не более 63 символов. Regex pattern: `^[a-z][a-z0-9]*$`
resourceGroupName	path	True	string	Имя группы ресурсов Azure, частью которой является данная емкость PowerBIDedicated. Это имя должно содержать не менее 1 символа и не более 90 символов. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

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

Имя	Тип	Описание
properties.administration	DedicatedCapacityAdministrators	Коллекция администраторов выделенной емкости
properties.mode	Mode	Указывает создание емкости Power BI Embedded. Если значение не указано, используется значение по умолчанию "Gen2". Подробнее
sku	CapacitySku	Номер SKU ресурса выделенной емкости.
tags	object	Пары "ключ-значение" дополнительных свойств подготовки.

Ответы

Имя	Тип	Описание
200 OK	DedicatedCapacity	ОК
202 Accepted	DedicatedCapacity	Принято
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

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

Примеры

Update capacity parameters

Update capacity to Generation 2

Update capacity parameters

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

Response Body

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Update capacity to Generation 2

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "properties": {
    "mode": "Gen2"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

Response Body

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Определения

Имя	Описание
CapacityProvisioningState	Текущее состояние развертывания выделенного ресурса PowerBI. ProvisioningState указывает состояния для подготовки ресурсов.
CapacitySku	Представляет имя SKU и ценовую категорию Azure для ресурса выделенной емкости PowerBI.
CapacitySkuTier	Имя ценовой категории Azure, к которой применяется номер SKU.
DedicatedCapacity	Представляет экземпляр ресурса выделенной емкости.
DedicatedCapacityAdministrators	Массив удостоверений пользователей администратора
DedicatedCapacityUpdateParameters	Спецификация запроса подготовки
Error	Объект ошибки
ErrorResponse	Описывает формат ответа об ошибке.
IdentityType	Тип удостоверения, создавшего или изменившего ресурс.
Mode	Указывает создание емкости Power BI Embedded. Если значение не указано, используется значение по умолчанию "Gen2". Подробнее
State	Текущее состояние выделенного ресурса PowerBI. Состояние заключается в том, чтобы указать больше состояний вне подготовки ресурсов.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

CapacityProvisioningState

Текущее состояние развертывания выделенного ресурса PowerBI. ProvisioningState указывает состояния для подготовки ресурсов.

Имя	Тип	Описание
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

CapacitySku

Представляет имя SKU и ценовую категорию Azure для ресурса выделенной емкости PowerBI.

Имя	Тип	Описание
capacity	integer	Емкость номера SKU.
name	string	Имя уровня SKU.
tier	CapacitySkuTier	Имя ценовой категории Azure, к которой применяется номер SKU.

CapacitySkuTier

Имя ценовой категории Azure, к которой применяется номер SKU.

Имя	Тип	Описание
AutoPremiumHost	string
PBIE_Azure	string
Premium	string

DedicatedCapacity

Представляет экземпляр ресурса выделенной емкости.

Имя	Тип	Описание
id	string	Идентификатор, представляющий выделенный ресурс PowerBI.
location	string	Расположение выделенного ресурса PowerBI.
name	string	Имя выделенного ресурса PowerBI.
properties.administration	DedicatedCapacityAdministrators	Коллекция администраторов выделенной емкости
properties.friendlyName	string	Имя емкости
properties.mode	Mode	Указывает создание емкости Power BI Embedded. Если значение не указано, используется значение по умолчанию "Gen2". Подробнее
properties.provisioningState	CapacityProvisioningState	Текущее состояние развертывания выделенного ресурса PowerBI. ProvisioningState указывает состояния для подготовки ресурсов.
properties.state	State	Текущее состояние выделенного ресурса PowerBI. Состояние заключается в том, чтобы указать больше состояний вне подготовки ресурсов.
properties.tenantId	string	Идентификатор клиента для емкости. Используется для создания емкости Pro Plus.
sku	CapacitySku	Номер SKU ресурса выделенной емкости PowerBI.
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
tags	object	Пары "ключ-значение" дополнительных свойств подготовки ресурсов.
type	string	Тип выделенного ресурса PowerBI.

DedicatedCapacityAdministrators

Массив удостоверений пользователей администратора

Имя	Тип	Описание
members	string[]	Массив удостоверений пользователей администратора.

DedicatedCapacityUpdateParameters

Спецификация запроса подготовки

Имя	Тип	Описание
properties.administration	DedicatedCapacityAdministrators	Коллекция администраторов выделенной емкости
properties.friendlyName	string	Имя емкости
properties.mode	Mode	Указывает создание емкости Power BI Embedded. Если значение не указано, используется значение по умолчанию "Gen2". Подробнее
properties.tenantId	string	Идентификатор клиента для емкости. Используется для создания емкости Pro Plus.
sku	CapacitySku	Номер SKU ресурса выделенной емкости.
tags	object	Пары "ключ-значение" дополнительных свойств подготовки.

Error

Объект ошибки

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

ErrorResponse

Описывает формат ответа об ошибке.

Имя	Тип	Описание
error	Error	Объект ошибки

IdentityType

Тип удостоверения, создавшего или изменившего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

Mode

Указывает создание емкости Power BI Embedded. Если значение не указано, используется значение по умолчанию "Gen2". Подробнее

Имя	Тип	Описание
Gen1	string
Gen2	string

State

Текущее состояние выделенного ресурса PowerBI. Состояние заключается в том, чтобы указать больше состояний вне подготовки ресурсов.

Имя	Тип	Описание
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

SystemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC)
createdBy	string	Идентификатор удостоверения, создавшего ресурс.
createdByType	IdentityType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор удостоверения, который последний раз изменял ресурс.
lastModifiedByType	IdentityType	Тип удостоверения, который последний раз изменял ресурс.

Capacities - Update

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

Update capacity parameters

Sample Request

Sample Response

Update capacity to Generation 2

Sample Request

Sample Response

Определения

CapacityProvisioningState

CapacitySku

CapacitySkuTier

DedicatedCapacity

DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

Error

ErrorResponse

IdentityType

Mode

State

SystemData

Дополнительные ресурсы