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 參數

名稱	位於	必要	類型	Description
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 訂用帳戶的唯一標識符。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
properties.administration	DedicatedCapacityAdministrators	專用容量管理員的集合
properties.mode	Mode	指定產生 Power BI Embedded容量。如果未指定任何值，則會使用預設值『Gen2』。深入了解
sku	CapacitySku	專用容量資源的 SKU。
tags	object	其他布建屬性的索引鍵/值組。

回應

名稱	類型	Description
200 OK	DedicatedCapacity	確定
202 Accepted	DedicatedCapacity	已接受
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
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"
  }
}

定義

名稱	Description
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 是要指出資源布建的狀態。

名稱	類型	Description
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 定價層。

名稱	類型	Description
capacity	integer	SKU 的容量。
name	string	SKU 層級的名稱。
tier	CapacitySkuTier	適用於 SKU 的 Azure 定價層名稱。

CapacitySkuTier

適用於 SKU 的 Azure 定價層名稱。

名稱	類型	Description
AutoPremiumHost	string
PBIE_Azure	string
Premium	string

DedicatedCapacity

表示專用容量資源的實例。

名稱	類型	Description
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	PowerBI 專用容量資源的 SKU。
systemData	SystemData	與建立和上次修改資源相關的元數據。
tags	object	其他資源布建屬性的索引鍵/值組。
type	string	PowerBI 專用資源的類型。

DedicatedCapacityAdministrators

系統管理員使用者身分識別的陣列

名稱	類型	Description
members	string[]	系統管理員使用者身分識別的陣列。

DedicatedCapacityUpdateParameters

布建要求規格

名稱	類型	Description
properties.administration	DedicatedCapacityAdministrators	專用容量管理員的集合
properties.friendlyName	string	容量名稱
properties.mode	Mode	指定產生 Power BI Embedded容量。如果未指定任何值，則會使用預設值『Gen2』。深入了解
properties.tenantId	string	容量的租用戶標識碼。用於建立 Pro Plus 容量。
sku	CapacitySku	專用容量資源的 SKU。
tags	object	其他布建屬性的索引鍵/值組。

Error

錯誤物件

名稱	類型	Description
code	string	錯誤碼
message	string	指出作業失敗原因的錯誤訊息。

ErrorResponse

描述錯誤回應的格式。

名稱	類型	Description
error	Error	錯誤物件

IdentityType

建立/修改資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Mode

指定產生 Power BI Embedded容量。如果未指定任何值，則會使用預設值『Gen2』。深入了解

名稱	類型	Description
Gen1	string
Gen2	string

State

PowerBI 專用資源的目前狀態。狀態是指出資源布建以外的更多狀態。

名稱	類型	Description
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

與建立和上次修改資源相關的元數據。

名稱	類型	Description
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

其他資源