Share via

Capacities - Check Name Availability

Service:
Power BI Embedded
API Version:
2021-01-01

Check the name availability in the target location.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/locations/{location}/checkNameAvailability?api-version=2021-01-01

URI Parameters

Name In Required Type Description
location
 path True

string

minLength: 1

The name of Azure region.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
name

string

minLength: 3
maxLength: 63
pattern: ^[a-z][a-z0-9]*$

Name for checking availability.
type

string

The resource type of PowerBI dedicated.

Responses

Name Type Description
200 OK

CheckCapacityNameAvailabilityResult

The request has succeeded.
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Check name availability of a capacity

Sample request

POST https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/West US/checkNameAvailability?api-version=2021-01-01

{
  "name": "azsdktest",
  "type": "Microsoft.PowerBIDedicated/capacities"
}

Sample response

Status code:
200 
{
  "nameAvailable": true
}

Definitions

Name Description
CheckCapacityNameAvailabilityParameters

Details of capacity name request body.
CheckCapacityNameAvailabilityResult

The checking result of capacity name availability.
Error

The error object.
ErrorResponse

The error object

CheckCapacityNameAvailabilityParameters

Object

Details of capacity name request body.

Name Type Default value Description
name

string

minLength: 3
maxLength: 63
pattern: ^[a-z][a-z0-9]*$

Name for checking availability.
type

string

Microsoft.PowerBIDedicated/capacities

The resource type of PowerBI dedicated.

CheckCapacityNameAvailabilityResult

Object

The checking result of capacity name availability.

Name Type Description
message

string

The detailed message of the request unavailability.
nameAvailable

boolean

Indicator of availability of the capacity name.
reason

string

The reason of unavailability.

Error

Object

The error object.

Name Type Description
code

string

Error code
message

string

Error message indicating why the operation failed.

ErrorResponse

Object

The error object

Name Type Description
error

Error

The error object.