/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability

POST

WorkspaceCollections

Verify the specified Power BI Workspace Collection name is valid and not already in use.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://management.azure.com/subscriptions//providers/Microsoft.PowerBI/locations//checkNameAvailability?api-version=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "type": "Microsoft.PowerBI/workspaceCollections"
}'

Response Example

200 - Example 1

{
    "message": "string",
    "nameAvailable": true,
    "reason": "Unavailable"
}

Request

Path Params

subscriptionId

string

required

Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

location

string

required

Azure location

Query Params

api-version

string

required

Client Api Version.

Body Params application/json

name

string

optional

Workspace collection name

type

string

optional

Resource type

Default:

Microsoft.PowerBI/workspaceCollections

Examples

Responses

🟢200Request completed successfully

application/json

Body

message

string

optional

Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.

nameAvailable

boolean

optional

Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.

reason

enum<string>

optional

Reason why the workspace collection name cannot be used.

Allowed values:

UnavailableInvalid

🔴500Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.

Modified at 2023-08-16 03:09:54

/providers/Microsoft.PowerBI/operations

/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections