NetApp Resource - Check Name Availability

服務:

Azure NetApp Files

API 版本:

2026-05-01

檢查資源名稱可用性
檢查資源名稱是否可用。

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

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string minLength: 1	Azure 區域的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
name	True	string	要驗證的資源名稱。
resourceGroup	True	string	資源組名。
type	True	CheckNameResourceTypes	用於驗證的資源類型。

回應

名稱	類型	Description
200 OK	CheckAvailabilityResponse	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	冒用您的使用者帳戶

範例

CheckNameAvailability

範例要求

HTTP

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

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

Java

import com.azure.resourcemanager.netapp.models.CheckNameResourceTypes;
import com.azure.resourcemanager.netapp.models.ResourceNameAvailabilityRequest;

/**
 * Samples for NetAppResource CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-05-01/CheckNameAvailability.json
     */
    /**
     * Sample code: CheckNameAvailability.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void checkNameAvailability(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.netAppResources().checkNameAvailabilityWithResponse("eastus",
            new ResourceNameAvailabilityRequest().withName("accName")
                .withType(CheckNameResourceTypes.MICROSOFT_NET_APP_NET_APP_ACCOUNTS).withResourceGroup("myRG"),
            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_name_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_name_availability(
        location="eastus",
        body={"name": "accName", "resourceGroup": "myRG", "type": "Microsoft.NetApp/netAppAccounts"},
    )
    print(response)


# x-ms-original-file: 2026-05-01/CheckNameAvailability.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/v10"
)

// Generated from example definition: 2026-05-01/CheckNameAvailability.json
func ExampleResourceClient_CheckNameAvailability() {
	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().CheckNameAvailability(ctx, "eastus", armnetapp.ResourceNameAvailabilityRequest{
		Name:          to.Ptr("accName"),
		Type:          to.Ptr(armnetapp.CheckNameResourceTypesMicrosoftNetAppNetAppAccounts),
		ResourceGroup: to.Ptr("myRG"),
	}, 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.ResourceClientCheckNameAvailabilityResponse{
	// 	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 resource name is available.
 *
 * @summary check if a resource name is available.
 * x-ms-original-file: 2026-05-01/CheckNameAvailability.json
 */
async function checkNameAvailability() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.netAppResource.checkNameAvailability("eastus", {
    name: "accName",
    type: "Microsoft.NetApp/netAppAccounts",
    resourceGroup: "myRG",
  });
  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

範例回覆

狀態碼:

200

{
  "isAvailable": true
}

定義

名稱	Description
CheckAvailabilityResponse	資源可用性的相關信息。
CheckNameResourceTypes	用於驗證的資源類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
InAvailabilityReasonType	Invalid 表示提供的名稱不符合 Azure App 服務 命名需求。 AlreadyExists 表示名稱已在使用中，因此無法使用。
ResourceNameAvailabilityRequest	資源名稱可用性要求內容。

CheckAvailabilityResponse

Object

資源可用性的相關信息。

名稱	類型	Description
isAvailable	boolean	true 表示名稱有效且可用。 false 指出名稱無效、無法使用或兩者皆無法使用。
message	string	如果 reason == 無效，請提供使用者指定名稱無效的原因，並提供資源命名需求，讓使用者可以選取有效的名稱。 如果 reason == AlreadyExists，請說明資源名稱已在使用中，並指示它們選取不同的名稱。
reason	InAvailabilityReasonType	Invalid 表示提供的名稱不符合 Azure App 服務 命名需求。 AlreadyExists 表示名稱已在使用中，因此無法使用。

CheckNameResourceTypes

列舉型別

用於驗證的資源類型。

值	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 在磁碟區下，已棄用，請改用 Microsoft.NetApp/netAppAccounts/backupVaults/backups 。
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups	備份保存庫下的 ANF 備份

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

InAvailabilityReasonType

列舉型別

Invalid 表示提供的名稱不符合 Azure App 服務 命名需求。 AlreadyExists 表示名稱已在使用中，因此無法使用。

值	Description
Invalid
AlreadyExists

ResourceNameAvailabilityRequest

Object

資源名稱可用性要求內容。

名稱	類型	Description
name	string	要驗證的資源名稱。
resourceGroup	string	資源組名。
type	CheckNameResourceTypes	用於驗證的資源類型。