Share via


NetApp Resource - Check File Path Availability

Check file path availability
Check if a file path is available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability?api-version=2025-03-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

File path to verify.

subnetId True

string

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes

availabilityZone

string

Logical availability zone
The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed.

Responses

Name Type Description
200 OK

CheckAvailabilityResponse

OK

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

CheckFilePathAvailability

Sample request

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

{
  "name": "my-exact-filepth",
  "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
}

Sample response

{
  "isAvailable": true
}

Definitions

Name Description
CheckAvailabilityResponse

Information regarding availability of a resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

FilePathAvailabilityRequest

File path availability request content - availability is based on the name and the subnetId.

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.

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.

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.

FilePathAvailabilityRequest

File path availability request content - availability is based on the name and the subnetId.

Name Type Description
availabilityZone

string

Logical availability zone
The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed.

name

string

File path to verify.

subnetId

string

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes

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