Capacities - List By Resource Group

Gets all the Dedicated capacities for the given resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities?api-version=2017-10-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

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\._\(\)]+$

api-version
query True
  • string

The client API version.

Responses

Name Type Description
200 OK

OK

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

List capacities in resource group

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
          ]
        },
        "provisioningState": "Provisioning",
        "state": "Provisioning"
      },
      "sku": {
        "name": "A1",
        "tier": "PBIE_Azure"
      },
      "tags": {
        "testKey": "testValue"
      }
    },
    {
      "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
      "location": "West US",
      "name": "azsdktest2",
      "properties": {
        "administration": {
          "members": [
            "azsdktest@microsoft.com"
          ]
        },
        "provisioningState": "Provisioning",
        "state": "Provisioning"
      },
      "sku": {
        "name": "A2",
        "tier": "PBIE_Azure"
      },
      "tags": {
        "testKey": "testValue"
      }
    }
  ]
}

Definitions

DedicatedCapacities

An array of Dedicated capacities resources.

DedicatedCapacity

Represents an instance of a Dedicated Capacity resource.

DedicatedCapacityAdministrators

An array of administrator user identities

ProvisioningState

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

ResourceSku

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

SkuTier

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

State

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

DedicatedCapacities

An array of Dedicated capacities resources.

Name Type Description
value

An array of Dedicated capacities resources.

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

A collection of Dedicated capacity administrators

properties.provisioningState

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

properties.state

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

sku

The SKU of the PowerBI Dedicated 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.

ProvisioningState

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

ResourceSku

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

Name Type Description
name
  • string

Name of the SKU level.

tier

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

SkuTier

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

Name Type Description
PBIE_Azure
  • 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