NetApp Resource - Check Name Availability

Dienst:: Azure NetApp Files

API-Version:: 2025-01-01

Überprüfen der Verfügbarkeit von Ressourcennamen
Überprüfen Sie, ob ein Ressourcenname verfügbar ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string minLength: 1	Der Name der Azure-Region.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der zu überprüfende Ressourcenname.
resourceGroup	True	string	Ressourcengruppenname.
type	True	CheckNameResourceTypes	Zur Überprüfung verwendeter Ressourcentyp.

Antworten

Name	Typ	Beschreibung
200 OK	CheckAvailabilityResponse	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CheckNameAvailability

Beispielanforderung

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

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


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:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/27046dbff974e3901970aa53b29cec6d8ec1342a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/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("<subscription-id>", 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.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");
require("dotenv/config");

/**
 * This sample demonstrates how to Check if a resource name is available.
 *
 * @summary Check if a resource name is available.
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/CheckNameAvailability.json
 */
async function checkNameAvailability() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "eastus";
  const name = "accName";
  const typeParam = "Microsoft.NetApp/netAppAccounts";
  const resourceGroup = "myRG";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.netAppResource.checkNameAvailability(
    location,
    name,
    typeParam,
    resourceGroup,
  );
  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

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/stable/2025-01-01/examples/CheckNameAvailability.json
// this example is just showing the usage of "NetAppResource_CheckNameAvailability" 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");
NetAppNameAvailabilityContent content = new NetAppNameAvailabilityContent("accName", NetAppNameAvailabilityResourceType.MicrosoftNetAppNetAppAccounts, "myRG");
NetAppCheckAvailabilityResult result = await subscriptionResource.CheckNetAppNameAvailabilityAsync(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

Beispiel für eine Antwort

Statuscode:: 200

{
  "isAvailable": true
}

Definitionen

Name	Beschreibung
CheckAvailabilityResponse	Informationen zur Verfügbarkeit einer Ressource.
CheckNameResourceTypes	Zur Überprüfung verwendeter Ressourcentyp.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InAvailabilityReasonType	`Invalid` gibt an, dass der angegebene Name nicht den Benennungsanforderungen des Azure App Service entspricht. `AlreadyExists` gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.
ResourceNameAvailabilityRequest	Ressourcennamenverfügbarkeitsanforderungsinhalt.

CheckAvailabilityResponse

Objekt

Informationen zur Verfügbarkeit einer Ressource.

Name	Typ	Beschreibung
isAvailable	boolean	`true` gibt an, dass der Name gültig und verfügbar ist. `false` gibt an, dass der Name ungültig, nicht verfügbar oder beides ist.
message	string	Wenn der Grund == ungültig ist, geben Sie dem Benutzer den Grund an, warum der angegebene Name ungültig ist, und geben Sie die Ressourcenbenennungsanforderungen an, damit der Benutzer einen gültigen Namen auswählen kann. Wenn grund == AlreadyExists, erklären Sie, dass der Ressourcenname bereits verwendet wird, und leiten Sie sie an, einen anderen Namen auszuwählen.
reason	InAvailabilityReasonType	`Invalid` gibt an, dass der angegebene Name nicht den Benennungsanforderungen des Azure App Service entspricht. `AlreadyExists` gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

CheckNameResourceTypes

Enumeration

Zur Überprüfung verwendeter Ressourcentyp.

Wert	Beschreibung
Microsoft.NetApp/netAppAccounts
Microsoft.NetApp/netAppAccounts/capacityPools
Microsoft.NetApp/netAppAccounts/capacityPools/volumes
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InAvailabilityReasonType

Enumeration

Invalid gibt an, dass der angegebene Name nicht den Benennungsanforderungen des Azure App Service entspricht. AlreadyExists gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

Wert	Beschreibung
AlreadyExists
Invalid

ResourceNameAvailabilityRequest

Objekt

Ressourcennamenverfügbarkeitsanforderungsinhalt.

Name	Typ	Beschreibung
name	string	Der zu überprüfende Ressourcenname.
resourceGroup	string	Ressourcengruppenname.
type	CheckNameResourceTypes	Zur Überprüfung verwendeter Ressourcentyp.

Freigeben über

NetApp Resource - Check Name Availability

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CheckNameAvailability

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CheckAvailabilityResponse

CheckNameResourceTypes

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InAvailabilityReasonType

ResourceNameAvailabilityRequest