Capacities - Update

Reference

Service:: Power BI Embedded

API Version:: 2021-01-01

Updates the current state of the specified Dedicated capacity.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
dedicatedCapacityName	path	True	string	The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. Regex pattern: `^[a-z][a-z0-9]*$`
resourceGroupName	path	True	string	The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	The client API version.

Request Body

Name	Type	Description
properties.administration	DedicatedCapacityAdministrators	A collection of Dedicated capacity administrators
properties.mode	Mode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More
sku	CapacitySku	The SKU of the Dedicated capacity resource.
tags	object	Key-value pairs of additional provisioning properties.

Responses

Name	Type	Description
200 OK	DedicatedCapacity	OK
202 Accepted	DedicatedCapacity	Accepted
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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

{
  "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

{
  "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"
  }
}

Definitions

Name	Description
CapacityProvisioningState	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning.
CapacitySku	Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource.
CapacitySkuTier	The name of the Azure pricing tier to which the SKU applies.
DedicatedCapacity	Represents an instance of a Dedicated Capacity resource.
DedicatedCapacityAdministrators	An array of administrator user identities
DedicatedCapacityUpdateParameters	Provision request specification
Error	The error object
ErrorResponse	Describes the format of Error response.
IdentityType	The type of identity that created/modified the resource.
Mode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More
State	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.
SystemData	Metadata pertaining to creation and last modification of the resource.

CapacityProvisioningState

The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning.

Name	Type	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

Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource.

Name	Type	Description
capacity	integer	The capacity of the SKU.
name	string	Name of the SKU level.
tier	CapacitySkuTier	The name of the Azure pricing tier to which the SKU applies.

CapacitySkuTier

The name of the Azure pricing tier to which the SKU applies.

Name	Type	Description
AutoPremiumHost	string
PBIE_Azure	string
Premium	string

DedicatedCapacity

Represents an instance of a Dedicated Capacity resource.

Name	Type	Description
id	string	An identifier that represents the PowerBI Dedicated resource.
location	string	Location of the PowerBI Dedicated resource.
name	string	The name of the PowerBI Dedicated resource.
properties.administration	DedicatedCapacityAdministrators	A collection of Dedicated capacity administrators
properties.friendlyName	string	Capacity name
properties.mode	Mode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More
properties.provisioningState	CapacityProvisioningState	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning.
properties.state	State	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.
properties.tenantId	string	Tenant ID for the capacity. Used for creating Pro Plus capacity.
sku	CapacitySku	The SKU of the PowerBI Dedicated capacity resource.
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
type	string	The type of the PowerBI Dedicated resource.

DedicatedCapacityAdministrators

An array of administrator user identities

Name	Type	Description
members	string[]	An array of administrator user identities.

DedicatedCapacityUpdateParameters

Provision request specification

Name	Type	Description
properties.administration	DedicatedCapacityAdministrators	A collection of Dedicated capacity administrators
properties.friendlyName	string	Capacity name
properties.mode	Mode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More
properties.tenantId	string	Tenant ID for the capacity. Used for creating Pro Plus capacity.
sku	CapacitySku	The SKU of the Dedicated capacity resource.
tags	object	Key-value pairs of additional provisioning properties.

Error

The error object

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

ErrorResponse

Describes the format of Error response.

Name	Type	Description
error	Error	The error object

IdentityType

The type of identity that created/modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Mode

Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More

Name	Type	Description
Gen1	string
Gen2	string

State

The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.

Name	Type	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

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource

Κοινή χρήση μέσω

Capacities - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Update capacity parameters

Sample request

Sample response

Update capacity to Generation 2

Sample request

Sample response

Definitions

CapacityProvisioningState

CapacitySku

CapacitySkuTier

DedicatedCapacity

DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

Error

ErrorResponse

IdentityType

Mode

State

SystemData

Πρόσθετοι πόροι