Capacities - Update

服務:: Power BI Embedded

API 版本:: 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 minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	專用容量的名稱。它至少必須是 3 個字元，最多 63 個字元。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

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

回應

名稱	類型	Description
200 OK	DedicatedCapacity	Azure 作業已順利完成。
202 Accepted	DedicatedCapacity	要求已接受進行處理，但尚未完成處理。標題 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

名稱

類型

Description

200 OK

DedicatedCapacity

Azure 作業已順利完成。

202 Accepted

DedicatedCapacity

要求已接受進行處理，但尚未完成處理。

標題

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Update capacity parameters

Update capacity to Generation 2

Update capacity parameters

範例要求

HTTP

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

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

範例回覆

狀態碼:: 200

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

狀態碼:: 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

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

Update capacity to Generation 2

範例要求

HTTP

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

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

範例回覆

狀態碼:: 200

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

狀態碼:: 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

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

定義

名稱	Description
CapacityProvisioningState	PowerBI 專用資源的目前部署狀態。 provisioningState是指出資源布建的狀態。
CapacitySku	代表 PowerBI 專用容量資源的 SKU 名稱和 Azure 定價層。
CapacitySkuTier	套用 SKU 的 Azure 定價層名稱。
createdByType	建立資源的身分識別類型。
DedicatedCapacity	表示專用容量資源的實例。
DedicatedCapacityAdministrators	系統管理員使用者身分識別的陣列
DedicatedCapacityUpdateParameters	布建要求規格
Error	error 物件。
ErrorResponse	錯誤物件
Mode	指定產生 Power BI Embedded 容量。如果未指定任何值，則會使用預設值『Gen2』。深入瞭解
State	PowerBI 專用資源的目前狀態。狀態是指出資源布建以外的更多狀態。
systemData	與建立和上次修改資源相關的元數據。

CapacityProvisioningState

列舉型別

PowerBI 專用資源的目前部署狀態。 provisioningState是指出資源布建的狀態。

值	Description
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

CapacitySku

Object

代表 PowerBI 專用容量資源的 SKU 名稱和 Azure 定價層。

名稱	類型	Description
capacity	integer (int32)	SKU 的容量。
name	string	SKU 層級的名稱。
tier	CapacitySkuTier	套用 SKU 的 Azure 定價層名稱。

CapacitySkuTier

列舉型別

套用 SKU 的 Azure 定價層名稱。

值	Description
PBIE_Azure
Premium
AutoPremiumHost

createdByType

列舉型別

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

值	Description
User
Application
ManagedIdentity
Key

DedicatedCapacity

Object

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

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
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	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	資源標籤。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

DedicatedCapacityAdministrators

Object

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

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

DedicatedCapacityUpdateParameters

Object

布建要求規格

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

Object

error 物件。

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

ErrorResponse

Object

錯誤物件

名稱	類型	Description
error	Error	error 物件。

Mode

列舉型別

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

值	Description
Gen1
Gen2

State

列舉型別

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

值	Description
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

systemData

Object

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

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Capacities - Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Update capacity parameters

範例要求

範例回覆

Update capacity to Generation 2

範例要求

範例回覆

定義

CapacityProvisioningState

CapacitySku

CapacitySkuTier

createdByType

DedicatedCapacity

DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

Error

ErrorResponse

Mode

State

systemData