Capacities - Check Name Availability

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

The region name which the operation will lookup into.

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.

Request Body

Name Type Description
name

string

Name for checking availability.

type

string

The resource type of PowerBI dedicated.

Responses

Name Type Description
200 OK

CheckCapacityNameAvailabilityResult

OK. The request has succeeded.

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

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

{
  "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

Describes the format of Error response.

CheckCapacityNameAvailabilityParameters

Details of capacity name request body.

Name Type Default value Description
name

string

Name for checking availability.

type

string

Microsoft.PowerBIDedicated/capacities

The resource type of PowerBI dedicated.

CheckCapacityNameAvailabilityResult

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

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