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	OK
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	管理者ユーザー ID の配列
DedicatedCapacityUpdateParameters	プロビジョニング要求の仕様
Error	error オブジェクト
ErrorResponse	エラー応答の形式について説明します。
IdentityType	リソースを作成または変更した ID の種類。
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

管理者ユーザー ID の配列

名前	型	説明
members	string[]	管理者ユーザー ID の配列。

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

error オブジェクト

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponse

エラー応答の形式について説明します。

名前	型	説明
error	Error	error オブジェクト

IdentityType

リソースを作成または変更した ID の種類。

名前	型	説明
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	リソースを作成した ID の識別子
createdByType	IdentityType	リソースを作成した ID の種類
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID の識別子
lastModifiedByType	IdentityType	リソースを最後に変更した ID の種類

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

その他のリソース