Share via


NetApp Resource - Check Name Availability

Check resource name availability
Check if a resource name is available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability?api-version=2025-09-01

URI Parameters

Name In Required Type Description
location
path True

string

minLength: 1

The name of the Azure region.

subscriptionId
path True

string (uuid)

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
name True

string

Resource name to verify.

resourceGroup True

string

Resource group name.

type True

CheckNameResourceTypes

Resource type used for verification.

Responses

Name Type Description
200 OK

CheckAvailabilityResponse

The request has succeeded.

Other Status Codes

ErrorResponse

An unexpected error response.

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

CheckNameAvailability

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/checkNameAvailability?api-version=2025-09-01

{
  "name": "accName",
  "type": "Microsoft.NetApp/netAppAccounts",
  "resourceGroup": "myRG"
}

Sample response

{
  "isAvailable": true
}

Definitions

Name Description
CheckAvailabilityResponse

Information regarding availability of a resource.

CheckNameResourceTypes

Resource type used for verification.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

InAvailabilityReasonType

Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.

ResourceNameAvailabilityRequest

Resource name availability request content.

CheckAvailabilityResponse

Information regarding availability of a resource.

Name Type Description
isAvailable

boolean

true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.

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 resource name is already in use, and direct them to select a different name.

reason

InAvailabilityReasonType

Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.

CheckNameResourceTypes

Resource type used for verification.

Value Description
Microsoft.NetApp/netAppAccounts
Microsoft.NetApp/netAppAccounts/capacityPools
Microsoft.NetApp/netAppAccounts/capacityPools/volumes
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots
Microsoft.NetApp/netAppAccounts/backupVaults/backups

ANF Backup under a volume , deprecated, use Microsoft.NetApp/netAppAccounts/backupVaults/backups instead.

Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups

ANF Backup under a Backup Vault

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.

InAvailabilityReasonType

Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.

Value Description
Invalid
AlreadyExists

ResourceNameAvailabilityRequest

Resource name availability request content.

Name Type Description
name

string

Resource name to verify.

resourceGroup

string

Resource group name.

type

CheckNameResourceTypes

Resource type used for verification.