Microsoft.PowerBIDedicated (stable:2021-01-01)

2025/07/04 • 18 new, 18 deleted methods

Operations_List (new)
Description :  Lists all of the available PowerBIDedicated REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.PowerBIDedicated/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of capacities supported by the Microsoft.PowerBIDedicated resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.PowerBIDedicated. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: capacity, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: create, update, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Localized description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties to expose performance metrics to shoebox. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification for exposing performance metrics to shoebox. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications for exposing performance metrics to shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Metric name ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable metric name ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localizable description of metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit for the metric ,
Required: False ,
}
string ,
aggregationType:
{
Description: Aggregation type for the metric ,
Required: False ,
}
string ,
metricFilterPattern:
{
Description: Pattern used to filter the metric ,
Required: False ,
}
string ,
dimensions:
{
Description: For describing multi dimensional metrics ,
Required: False ,
}
[
{
name:
{
Description: Dimension of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable dimension of the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Log specifications for exposing diagnostic logs to shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration for the log ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_ListBySubscription (new)
Description :  Lists all the auto scale v-cores for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/autoScaleVCores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of auto scale v-core resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_List (new)
Description :  Lists all the Dedicated capacities for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/capacities
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Dedicated capacities resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_CheckNameAvailability (new)
Description :  Check the name availability in the target location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/locations/{location}/checkNameAvailability
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
capacityParameters:
{
Description: The name of the capacity. ,
Required: True ,
}
{
name:
{
Description: Name for checking availability. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of PowerBI dedicated. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicator of availability of the capacity name. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of unavailability. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message of the request unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListSkus (new)
Description :  Lists eligible SKUs for PowerBI Dedicated resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/skus
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_ListByResourceGroup (new)
Description :  Gets all the auto scale v-cores for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of auto scale v-core resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Get (new)
Description :  Gets details about the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Create (new)
Description :  Provisions the specified auto scale v-core based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
vCoreParameters:
{
Description: Contains the information used to provision the auto scale v-core. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Update (new)
Description :  Updates the current state of the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
vCoreUpdateParameters:
{
Description: Request object that contains the updated information for the auto scale v-core. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the update operation request. ,
Required: False ,
}
{
capacityLimit:
{
Description: The maximum capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Delete (new)
Description :  Deletes the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListByResourceGroup (new)
Description :  Gets all the Dedicated capacities for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Dedicated capacities resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_GetDetails (new)
Description :  Gets details about the specified dedicated capacity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Create (new)
Description :  Provisions the specified Dedicated capacity based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
capacityParameters:
{
Description: Contains the information used to provision the Dedicated capacity. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Update (new)
Description :  Updates the current state of the specified Dedicated capacity.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
capacityUpdateParameters:
{
Description: Request object that contains the updated information for the capacity. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Dedicated capacity resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
administration:
{
Description: A collection of Dedicated capacity administrators ,
Required: False ,
}
{
members:
{
Description: An array of administrator user identities. ,
Required: False ,
}
[
string ,
]
,
}
,
mode:
{
Description: Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. [Learn More](https://docs.microsoft.com/power-bi/developer/embedded/power-bi-embedded-generation-2) ,
Enum:
{
Gen1: No description available. ,
Gen2: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant ID for the capacity. Used for creating Pro Plus capacity. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Capacity name ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Delete (new)
Description :  Deletes the specified Dedicated capacity.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Resume (new)
Description :  Resumes operation of the specified Dedicated capacity instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/resume
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListSkusForCapacity (new)
Description :  Lists eligible SKUs for a PowerBI Dedicated resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/skus
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for existing resources ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type ,
Required: False ,
}
string ,
sku:
{
Description: The SKU in SKU details for existing resources. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Suspend (new)
Description :  Suspends operation of the specified dedicated capacity instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/suspend
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Get (removed)
Description :  Gets details about the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Create (removed)
Description :  Provisions the specified auto scale v-core based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
vCoreParameters:
{
Description: Contains the information used to provision the auto scale v-core. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Delete (removed)
Description :  Deletes the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_Update (removed)
Description :  Updates the current state of the specified auto scale v-core.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores/{vcoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vcoreName:
{
Description: The name of the auto scale v-core. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
vCoreUpdateParameters:
{
Description: Request object that contains the updated information for the auto scale v-core. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the update operation request. ,
Required: False ,
}
{
capacityLimit:
{
Description: The maximum capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_ListByResourceGroup (removed)
Description :  Gets all the auto scale v-cores for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/autoScaleVCores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of auto scale v-core resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AutoScaleVCores_ListBySubscription (removed)
Description :  Lists all the auto scale v-cores for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/autoScaleVCores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of auto scale v-core resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the auto scale v-core resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
AutoScale: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of an auto scale v-core resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of an auto scale v-core resource. ,
Required: False ,
}
{
capacityObjectId:
{
Description: The object ID of the capacity resource associated with the auto scale v-core resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_GetDetails (removed)
Description :  Gets details about the specified dedicated capacity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Create (removed)
Description :  Provisions the specified Dedicated capacity based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
capacityParameters:
{
Description: Contains the information used to provision the Dedicated capacity. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Delete (removed)
Description :  Deletes the specified Dedicated capacity.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Update (removed)
Description :  Updates the current state of the specified Dedicated capacity.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
capacityUpdateParameters:
{
Description: Request object that contains the updated information for the capacity. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Dedicated capacity resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
administration:
{
Description: A collection of Dedicated capacity administrators ,
Required: False ,
}
{
members:
{
Description: An array of administrator user identities. ,
Required: False ,
}
[
string ,
]
,
}
,
mode:
{
Description: Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. [Learn More](https://docs.microsoft.com/power-bi/developer/embedded/power-bi-embedded-generation-2) ,
Enum:
{
Gen1: No description available. ,
Gen2: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant ID for the capacity. Used for creating Pro Plus capacity. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Capacity name ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Suspend (removed)
Description :  Suspends operation of the specified dedicated capacity instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/suspend
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_Resume (removed)
Description :  Resumes operation of the specified Dedicated capacity instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/resume
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListByResourceGroup (removed)
Description :  Gets all the Dedicated capacities for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Dedicated capacities resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_List (removed)
Description :  Lists all the Dedicated capacities for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/capacities
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Dedicated capacities resources. ,
Required: True ,
}
[
{
sku:
{
Description: The SKU of the PowerBI Dedicated capacity resource. ,
Required: True ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListSkus (removed)
Description :  Lists eligible SKUs for PowerBI Dedicated resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/skus
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_ListSkusForCapacity (removed)
Description :  Lists eligible SKUs for a PowerBI Dedicated resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}/skus
{
resourceGroupName:
{
Description: 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. ,
Required: True ,
}
string ,
dedicatedCapacityName:
{
Description: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for existing resources ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type ,
Required: False ,
}
string ,
sku:
{
Description: The SKU in SKU details for existing resources. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
PBIE_Azure: No description available. ,
Premium: No description available. ,
AutoPremiumHost: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The capacity of the SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available PowerBIDedicated REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.PowerBIDedicated/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of capacities supported by the Microsoft.PowerBIDedicated resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.PowerBIDedicated. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: capacity, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: create, update, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Localized description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties to expose performance metrics to shoebox. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification for exposing performance metrics to shoebox. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications for exposing performance metrics to shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Metric name ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable metric name ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localizable description of metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit for the metric ,
Required: False ,
}
string ,
aggregationType:
{
Description: Aggregation type for the metric ,
Required: False ,
}
string ,
metricFilterPattern:
{
Description: Pattern used to filter the metric ,
Required: False ,
}
string ,
dimensions:
{
Description: For describing multi dimensional metrics ,
Required: False ,
}
[
{
name:
{
Description: Dimension of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable dimension of the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Log specifications for exposing diagnostic logs to shoebox. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localizable name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration for the log ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Capacities_CheckNameAvailability (removed)
Description :  Check the name availability in the target location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/locations/{location}/checkNameAvailability
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
capacityParameters:
{
Description: The name of the capacity. ,
Required: True ,
}
{
name:
{
Description: Name for checking availability. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of PowerBI dedicated. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicator of availability of the capacity name. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of unavailability. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message of the request unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}