Workspace Collections - check Name Availability

Service:

Power BI Workspace Collections

API Version:

2016-01-29

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

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	Azure location
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
name	string	Workspace collection name
type	string	Resource type

Responses

Name	Type	Description
200 OK	CheckNameResponse	Request completed successfully
Other Status Codes	Error	Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.

Definitions

Name	Description
CheckNameReason	Reason why the workspace collection name cannot be used.
CheckNameRequest
CheckNameResponse
Error
ErrorDetail

CheckNameReason

Reason why the workspace collection name cannot be used.

Name	Type	Description
Invalid	string
Unavailable	string

CheckNameRequest

Name	Type	Default Value	Description
name	string		Workspace collection name
type	string	Microsoft.PowerBI/workspaceCollections	Resource type

CheckNameResponse

Name	Type	Description
message	string	Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailable	boolean	Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.
reason	CheckNameReason	Reason why the workspace collection name cannot be used.

Error

Name	Type	Description
code	string
details	ErrorDetail[]
message	string
target	string

ErrorDetail

Name	Type	Description
code	string
message	string
target	string