Capacities - Suspend

Service:

Power BI Embedded

API Version:

2021-01-01

Suspends operation of the specified dedicated capacity instance.

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

URI Parameters

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

Responses

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

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Suspend capacity

Sample request

HTTP

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

Sample response

Status code:

200

Status code:

202

Definitions

Name	Description
Error	The error object
ErrorResponse	Describes the format of Error response.

Error

The error object

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

ErrorResponse

Describes the format of Error response.

Name	Type	Description
error	Error	The error object