你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	给定 PowerBIDedicated 容量所属的 Azure 资源组的名称。此名称的长度必须至少为 1 个字符，且不超过 90 个字符。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。此订阅 ID 是每个服务调用的 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

Azure Active Directory OAuth2 流

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	表示 PowerBI 专用容量资源的 SKU 名称和 Azure 定价层。
CapacitySkuTier	SKU 应用到的 Azure 定价层的名称。
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

表示 PowerBI 专用容量资源的 SKU 名称和 Azure 定价层。

名称	类型	说明
capacity	integer	SKU 的容量。
name	string	SKU 级别的名称。
tier	CapacitySkuTier	SKU 应用到的 Azure 定价层的名称。

CapacitySkuTier

SKU 应用到的 Azure 定价层的名称。

名称	类型	说明
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	容量的租户 ID。用于创建 Pro Plus 容量。
sku	CapacitySku	PowerBI 专用容量资源的 SKU。
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	容量的租户 ID。用于创建 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

其他资源