Api Management Service - Check Name Availability

Service:

API Management

API Version:

2024-05-01

Checks availability and correctness of a name for an API Management service.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
name	True	string	The name to check for availability.

Responses

Name	Type	Description
200 OK	ApiManagementServiceNameAvailabilityResult	The result of check name availability.
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

ApiManagementServiceCheckNameAvailability

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-01

{
  "name": "apimService1"
}

Sample response

Status code:

200

{
  "nameAvailable": true,
  "reason": "Valid",
  "message": ""
}

Definitions

Name	Description
ApiManagementServiceCheckNameAvailabilityParameters	Parameters supplied to the CheckNameAvailability operation.
ApiManagementServiceNameAvailabilityResult	Response of the CheckNameAvailability operation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NameAvailabilityReason	Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

ApiManagementServiceCheckNameAvailabilityParameters

Parameters supplied to the CheckNameAvailability operation.

Name	Type	Description
name	string	The name to check for availability.

ApiManagementServiceNameAvailabilityResult

Response of the CheckNameAvailability operation.

Name	Type	Description
message	string	If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.
nameAvailable	boolean	True if the name is available and can be used to create a new API Management service; otherwise false.
reason	NameAvailabilityReason	Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NameAvailabilityReason

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

Name	Type	Description
AlreadyExists	string
Invalid	string
Valid	string