NetApp Resource - Check File Path Availability

Usługa:: Azure NetApp Files

Wersja interfejsu API:: 2026-05-01

Sprawdzanie dostępności ścieżki pliku
Sprawdź, czy ścieżka pliku jest dostępna.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string minLength: 1	Nazwa regionu świadczenia usługi Azure.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Ścieżka pliku do zweryfikowania.
subnetId	True	string	Identyfikator URI zasobu Azure dla delegowanej podsieci. Musi mieć delegowanie Microsoft.NetApp/woluminy
availabilityZone		string	Strefa dostępności logicznej zasobu Azure używana w wyszukiwaniu mapowania strefy dla subskrypcji i regionu. Wyszukiwanie pobierze strefę fizyczną, w której znajduje się wolumin.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckAvailabilityResponse	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	podszywaj się pod konto użytkownika

Przykłady

CheckFilePathAvailability

Przykładowe żądanie

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

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


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

/**
 * Samples for NetAppResource CheckFilePathAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-05-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

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: 2026-05-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

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/v10"
)

// Generated from example definition: 2026-05-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

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: 2026-05-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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "isAvailable": true
}

Definicje

Nazwa	Opis
CheckAvailabilityResponse	Informacje dotyczące dostępności zasobu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FilePathAvailabilityRequest	Zawartość żądania dostępności ścieżki pliku — dostępność jest oparta na nazwie i podsieci.
InAvailabilityReasonType	`Invalid` wskazuje, że podana nazwa nie jest zgodna z wymaganiami nazewnictwa Azure App Service. `AlreadyExists` wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

CheckAvailabilityResponse

Objekt

Informacje dotyczące dostępności zasobu.

Nazwa	Typ	Opis
isAvailable	boolean	`true` wskazuje, że nazwa jest prawidłowa i dostępna. `false` wskazuje, że nazwa jest nieprawidłowa, niedostępna lub obie.
message	string	Jeśli przyczyna == jest nieprawidłowa, podaj użytkownikowi powód, dla którego dana nazwa jest nieprawidłowa, i podaj wymagania dotyczące nazewnictwa zasobów, aby użytkownik mógł wybrać prawidłową nazwę. Jeśli przyczyna == AlreadyExists, wyjaśnij, że nazwa zasobu jest już używana i przekierowuj je, aby wybrać inną nazwę.
reason	InAvailabilityReasonType	`Invalid` wskazuje, że podana nazwa nie jest zgodna z wymaganiami nazewnictwa Azure App Service. `AlreadyExists` wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FilePathAvailabilityRequest

Objekt

Zawartość żądania dostępności ścieżki pliku — dostępność jest oparta na nazwie i podsieci.

Nazwa	Typ	Opis
availabilityZone	string	Strefa dostępności logicznej zasobu Azure używana w wyszukiwaniu mapowania strefy dla subskrypcji i regionu. Wyszukiwanie pobierze strefę fizyczną, w której znajduje się wolumin.
name	string	Ścieżka pliku do zweryfikowania.
subnetId	string	Identyfikator URI zasobu Azure dla delegowanej podsieci. Musi mieć delegowanie Microsoft.NetApp/woluminy

InAvailabilityReasonType

Wyliczenie

Invalid wskazuje, że podana nazwa nie jest zgodna z wymaganiami nazewnictwa Azure App Service. AlreadyExists wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

Wartość	Opis
Invalid
AlreadyExists