Redis - Check Name Availability

Checks that the redis cache name is valid and is not already in use.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability?api-version=2023-08-01

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
name True

string

Resource name.

type True

string

Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'.

Responses

Name Type Description
200 OK

Name is available

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

RedisCacheCheckNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/CheckNameAvailability?api-version=2023-08-01

{
  "type": "Microsoft.Cache/Redis",
  "name": "cacheName"
}

Sample Response

Definitions

Name Description
CheckNameAvailabilityParameters

Parameters body to pass for resource name availability check.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

CheckNameAvailabilityParameters

Parameters body to pass for resource name availability check.

Name Type Description
name

string

Resource name.

type

string

Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'.

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.