NetApp Resource - Check File Path Availability

Layanan:

Azure NetApp Files

Versi API:

2025-12-01

Periksa ketersediaan jalur file
Periksa apakah jalur file tersedia.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
location	path	True	string minLength: 1	Nama wilayah Azure.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Jalur file untuk diverifikasi.
subnetId	True	string	URI Sumber Daya Azure untuk subnet yang didelegasikan. Harus memiliki delegasi Microsoft.NetApp/volumes
availabilityZone		string	Zona ketersediaan logis Sumber Daya Azure yang digunakan dalam pencarian pemetaan zona untuk langganan dan wilayah. Pencarian akan mengambil zona fisik tempat volume ditempatkan.

Respons

Nama	Jenis	Deskripsi
200 OK	CheckAvailabilityResponse	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

CheckFilePathAvailability

Permintaan sampel

HTTP

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

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

Java

import com.azure.resourcemanager.netapp.models.FilePathAvailabilityRequest;

/**
 * Samples for NetAppResource CheckFilePathAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-12-01/CheckFilePathAvailability.json
     */
    /**
     * Sample code: CheckFilePathAvailability.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void checkFilePathAvailability(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.netAppResources().checkFilePathAvailabilityWithResponse("eastus",
            new FilePathAvailabilityRequest().withName("my-exact-filepth").withSubnetId(
                "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python check_file_path_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.net_app_resource.check_file_path_availability(
        location="eastus",
        body={
            "name": "my-exact-filepth",
            "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
        },
    )
    print(response)


# x-ms-original-file: 2025-12-01/CheckFilePathAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v9"
)

// Generated from example definition: 2025-12-01/CheckFilePathAvailability.json
func ExampleResourceClient_CheckFilePathAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceClient().CheckFilePathAvailability(ctx, "eastus", armnetapp.FilePathAvailabilityRequest{
		Name:     to.Ptr("my-exact-filepth"),
		SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.ResourceClientCheckFilePathAvailabilityResponse{
	// 	CheckAvailabilityResponse: &armnetapp.CheckAvailabilityResponse{
	// 		IsAvailable: to.Ptr(true),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to check if a file path is available.
 *
 * @summary check if a file path is available.
 * x-ms-original-file: 2025-12-01/CheckFilePathAvailability.json
 */
async function checkFilePathAvailability() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.netAppResource.checkFilePathAvailability("eastus", {
    name: "my-exact-filepth",
    subnetId:
      "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2025-12-01/examples/CheckFilePathAvailability.json
// this example is just showing the usage of "NetAppResource_CheckFilePathAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("eastus");
NetAppFilePathAvailabilityContent content = new NetAppFilePathAvailabilityContent("my-exact-filepth", new ResourceIdentifier("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"));
NetAppCheckAvailabilityResult result = await subscriptionResource.CheckNetAppFilePathAvailabilityAsync(location, content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

200

{
  "isAvailable": true
}

Definisi

Nama	Deskripsi
CheckAvailabilityResponse	Informasi mengenai ketersediaan sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
FilePathAvailabilityRequest	Konten permintaan ketersediaan jalur file - ketersediaan didasarkan pada nama dan subnetId.
InAvailabilityReasonType	Invalid menunjukkan nama yang diberikan tidak cocok dengan persyaratan penamaan Azure App Service. AlreadyExists menunjukkan bahwa nama tersebut sudah digunakan dan oleh karena itu tidak tersedia.

CheckAvailabilityResponse

Objek

Informasi mengenai ketersediaan sumber daya.

Nama	Jenis	Deskripsi
isAvailable	boolean	true menunjukkan nama valid dan tersedia. false menunjukkan nama tidak valid, tidak tersedia, atau keduanya.
message	string	Jika alasan == tidak valid, berikan alasan mengapa nama yang diberikan tidak valid kepada pengguna, dan berikan persyaratan penamaan sumber daya sehingga pengguna dapat memilih nama yang valid. Jika alasan == AlreadyExists, jelaskan bahwa nama sumber daya sudah digunakan, dan arahkan mereka untuk memilih nama yang berbeda.
reason	InAvailabilityReasonType	Invalid menunjukkan nama yang diberikan tidak cocok dengan persyaratan penamaan Azure App Service. AlreadyExists menunjukkan bahwa nama tersebut sudah digunakan dan oleh karena itu tidak tersedia.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

FilePathAvailabilityRequest

Objek

Konten permintaan ketersediaan jalur file - ketersediaan didasarkan pada nama dan subnetId.

Nama	Jenis	Deskripsi
availabilityZone	string	Zona ketersediaan logis Sumber Daya Azure yang digunakan dalam pencarian pemetaan zona untuk langganan dan wilayah. Pencarian akan mengambil zona fisik tempat volume ditempatkan.
name	string	Jalur file untuk diverifikasi.
subnetId	string	URI Sumber Daya Azure untuk subnet yang didelegasikan. Harus memiliki delegasi Microsoft.NetApp/volumes

InAvailabilityReasonType

Enumerasi

Invalid menunjukkan nama yang diberikan tidak cocok dengan persyaratan penamaan Azure App Service. AlreadyExists menunjukkan bahwa nama tersebut sudah digunakan dan oleh karena itu tidak tersedia.

Nilai	Deskripsi
Invalid
AlreadyExists