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 パラメーター

名前	/	必須	型	説明
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	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.administration	DedicatedCapacityAdministrators	専用容量管理者のコレクション
properties.mode	Mode	Power BI Embedded 容量の生成を指定します。値が指定されていない場合は、既定値 'Gen2' が使用されます。詳細情報
sku	CapacitySku	専用容量リソースの SKU。
tags	object	追加のプロビジョニングプロパティのキーと値のペア。

応答

名前	型	説明
200 OK	DedicatedCapacity	Azure 操作は正常に完了しました。
202 Accepted	DedicatedCapacity	要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

名前

型

説明

200 OK

DedicatedCapacity

Azure 操作は正常に完了しました。

202 Accepted

DedicatedCapacity

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
  }
}

定義

名前	説明
CapacityProvisioningState	PowerBI 専用リソースの現在のデプロイ状態。 provisioningState は、リソースプロビジョニングの状態を示します。
CapacitySku	PowerBI 専用容量リソースの SKU 名と Azure 価格レベルを表します。
CapacitySkuTier	SKU が適用される Azure 価格レベルの名前。
createdByType	リソースを作成した ID の種類。
DedicatedCapacity	専用容量リソースのインスタンスを表します。
DedicatedCapacityAdministrators	管理者ユーザー ID の配列
DedicatedCapacityUpdateParameters	プロビジョニング要求の仕様
Error	エラーオブジェクト。
ErrorResponse	エラーオブジェクト
Mode	Power BI Embedded 容量の生成を指定します。値が指定されていない場合は、既定値 'Gen2' が使用されます。詳細情報
State	PowerBI 専用リソースの現在の状態。状態は、リソースプロビジョニングの外部でより多くの状態を示します。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CapacityProvisioningState

列挙

PowerBI 専用リソースの現在のデプロイ状態。 provisioningState は、リソースプロビジョニングの状態を示します。

値	説明
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

CapacitySku

Object

PowerBI 専用容量リソースの SKU 名と Azure 価格レベルを表します。

名前	型	説明
capacity	integer (int32)	SKU の容量。
name	string	SKU レベルの名前。
tier	CapacitySkuTier	SKU が適用される Azure 価格レベルの名前。

CapacitySkuTier

列挙

SKU が適用される Azure 価格レベルの名前。

値	説明
PBIE_Azure
Premium
AutoPremiumHost

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DedicatedCapacity

Object

専用容量リソースのインスタンスを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /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	容量のテナント ID。 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

管理者ユーザー ID の配列

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

DedicatedCapacityUpdateParameters

Object

プロビジョニング要求の仕様

名前	型	説明
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

Object

エラーオブジェクト。

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

ErrorResponse

Object

エラーオブジェクト

名前	型	説明
error	Error	エラーオブジェクト。

Mode

列挙

Power BI Embedded 容量の生成を指定します。値が指定されていない場合は、既定値 'Gen2' が使用されます。詳細情報

値	説明
Gen1
Gen2

State

列挙

PowerBI 専用リソースの現在の状態。状態は、リソースプロビジョニングの外部でより多くの状態を示します。

値	説明
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

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