Capacities - Create

Service:: Power BI Embedded

API Version:: 2021-01-01

Provisions the specified Dedicated capacity based on the configuration specified in the request.

PUT 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 minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	The name of the dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
sku	True	CapacitySku	The SKU of the PowerBI Dedicated capacity resource.
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
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	DedicatedCapacity	Resource 'DedicatedCapacity' update operation succeeded
201 Created	DedicatedCapacity	Resource 'DedicatedCapacity' create operation succeeded Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

DedicatedCapacity

Resource 'DedicatedCapacity' update operation succeeded

201 Created

DedicatedCapacity

Resource 'DedicatedCapacity' create operation succeeded

Headers

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

An unexpected error response.

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

Create capacity

Sample request

HTTP

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

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

Sample response

Status code:: 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"
  }
}

Status code:: 201

{
  "name": "azsdktest",
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/servers/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"
  }
}

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.
createdByType	The type of identity that created the resource.
DedicatedCapacity	Represents an instance of a Dedicated Capacity resource.
DedicatedCapacityAdministrators	An array of administrator user identities
Error	The error object.
ErrorResponse	The error object
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

Enumeration

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

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

CapacitySku

Object

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

Name	Type	Description
capacity	integer (int32)	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

Enumeration

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

Value	Description
PBIE_Azure
Premium
AutoPremiumHost

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DedicatedCapacity

Object

Represents an instance of a Dedicated Capacity resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the 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	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DedicatedCapacityAdministrators

Object

An array of administrator user identities

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

Error

Object

The error object.

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

ErrorResponse

Object

The error object

Name	Type	Description
error	Error	The error object.

Mode

Enumeration

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

Value	Description
Gen1
Gen2

State

Enumeration

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

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

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Capacities - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create capacity

Sample request

Sample response

Definitions

CapacityProvisioningState

CapacitySku

CapacitySkuTier

createdByType

DedicatedCapacity

DedicatedCapacityAdministrators

Error

ErrorResponse

Mode

State

systemData