Location - Check Name Availability

Dienst:

Batch Management

API-Version:

2025-06-01

Überprüft, ob der Name des Batchkontos in der angegebenen Region verfügbar ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
locationName	path	True	string	Der gewünschte Bereich für die Namensüberprüfung.
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 Name, der auf Verfügbarkeit überprüft werden soll
type	True	ResourceType	Der Ressourcentyp.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResult	Die Anforderung ist erfolgreich.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

LocationCheckNameAvailability_AlreadyExists

LocationCheckNameAvailability_Available

LocationCheckNameAvailability_AlreadyExists

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/providers/Microsoft.Batch/locations/japaneast/checkNameAvailability?api-version=2025-06-01

{
  "name": "existingaccountname",
  "type": "Microsoft.Batch/batchAccounts"
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python location_check_name_availability_already_exists.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.location.check_name_availability(
        location_name="japaneast",
        parameters={"name": "existingaccountname", "type": "Microsoft.Batch/batchAccounts"},
    )
    print(response)


# x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_AlreadyExists.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 armbatch_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/batch/armbatch/v4"
)

// Generated from example definition: 2025-06-01/LocationCheckNameAvailability_AlreadyExists.json
func ExampleLocationClient_CheckNameAvailability_locationCheckNameAvailabilityAlreadyExists() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLocationClient().CheckNameAvailability(ctx, "japaneast", armbatch.CheckNameAvailabilityParameters{
		Name: to.Ptr("existingaccountname"),
		Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	}, 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 = armbatch.LocationClientCheckNameAvailabilityResponse{
	// 	CheckNameAvailabilityResult: &armbatch.CheckNameAvailabilityResult{
	// 		Message: to.Ptr("An account named 'existingaccountname' is already in use."),
	// 		NameAvailable: to.Ptr(false),
	// 		Reason: to.Ptr(armbatch.NameAvailabilityReasonAlreadyExists),
	// 	},
	// }
}

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 { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to checks whether the Batch account name is available in the specified region.
 *
 * @summary checks whether the Batch account name is available in the specified region.
 * x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_AlreadyExists.json
 */
async function locationCheckNameAvailabilityAlreadyExists() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.location.checkNameAvailability("japaneast", {
    name: "existingaccountname",
    type: "Microsoft.Batch/batchAccounts",
  });
  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.Batch.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json
// this example is just showing the usage of "Location_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 = "12345678-1234-1234-1234-123456789012";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation locationName = new AzureLocation("japaneast");
BatchNameAvailabilityContent content = new BatchNameAvailabilityContent("existingaccountname");
BatchNameAvailabilityResult result = await subscriptionResource.CheckBatchNameAvailabilityAsync(locationName, 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

{
  "message": "An account named 'existingaccountname' is already in use.",
  "nameAvailable": false,
  "reason": "AlreadyExists"
}

LocationCheckNameAvailability_Available

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/providers/Microsoft.Batch/locations/japaneast/checkNameAvailability?api-version=2025-06-01

{
  "name": "newaccountname",
  "type": "Microsoft.Batch/batchAccounts"
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python location_check_name_availability_available.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.location.check_name_availability(
        location_name="japaneast",
        parameters={"name": "newaccountname", "type": "Microsoft.Batch/batchAccounts"},
    )
    print(response)


# x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_Available.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 armbatch_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/batch/armbatch/v4"
)

// Generated from example definition: 2025-06-01/LocationCheckNameAvailability_Available.json
func ExampleLocationClient_CheckNameAvailability_locationCheckNameAvailabilityAvailable() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLocationClient().CheckNameAvailability(ctx, "japaneast", armbatch.CheckNameAvailabilityParameters{
		Name: to.Ptr("newaccountname"),
		Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	}, 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 = armbatch.LocationClientCheckNameAvailabilityResponse{
	// 	CheckNameAvailabilityResult: &armbatch.CheckNameAvailabilityResult{
	// 		NameAvailable: 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 { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to checks whether the Batch account name is available in the specified region.
 *
 * @summary checks whether the Batch account name is available in the specified region.
 * x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_Available.json
 */
async function locationCheckNameAvailabilityAvailable() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.location.checkNameAvailability("japaneast", {
    name: "newaccountname",
    type: "Microsoft.Batch/batchAccounts",
  });
  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.Batch.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_Available.json
// this example is just showing the usage of "Location_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 = "12345678-1234-1234-1234-123456789012";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation locationName = new AzureLocation("japaneast");
BatchNameAvailabilityContent content = new BatchNameAvailabilityContent("newaccountname");
BatchNameAvailabilityResult result = await subscriptionResource.CheckBatchNameAvailabilityAsync(locationName, 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

{
  "nameAvailable": true
}

Definitionen

Name	Beschreibung
CheckNameAvailabilityParameters	Parameter für eine Überprüfungsnamenverfügbarkeitsanforderung.
CheckNameAvailabilityResult	Die Antwort des CheckNameAvailability-Vorgangs.
CloudError	Eine Fehlerantwort des Batchdiensts.
CloudErrorBody	Eine Fehlerantwort des Batchdiensts.
NameAvailabilityReason	Ruft den Grund ab, warum ein Batchkontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable falsch ist.
ResourceType	Das Ergebnis der Anfrage zur Auflistung der Operationen.

CheckNameAvailabilityParameters

Objekt

Parameter für eine Überprüfungsnamenverfügbarkeitsanforderung.

Name	Typ	Beschreibung
name	string	Der Name, der auf Verfügbarkeit überprüft werden soll
type	ResourceType	Der Ressourcentyp.

CheckNameAvailabilityResult

Objekt

Die Antwort des CheckNameAvailability-Vorgangs.

Name	Typ	Beschreibung
message	string	Ruft eine Fehlermeldung ab, in der der Wert "Reason" ausführlicher erläutert wird.
nameAvailable	boolean	Ruft einen booleschen Wert, der angibt, ob der Name für Sie verfügbar ist. Wenn true, ist der Name verfügbar. Wenn false, wurde der Name bereits genommen oder ungültig und kann nicht verwendet werden.
reason	NameAvailabilityReason	Ruft den Grund ab, warum ein Batchkontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable falsch ist.

CloudError

Objekt

Eine Fehlerantwort des Batchdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Der Textkörper der Fehlerantwort.

CloudErrorBody

Objekt

Eine Fehlerantwort des Batchdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

NameAvailabilityReason

Enumeration

Ruft den Grund ab, warum ein Batchkontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable falsch ist.

Wert	Beschreibung
Invalid	Der angeforderte Name ist ungültig.
AlreadyExists	Der angeforderte Name wird bereits verwendet.

ResourceType

Enumeration

Das Ergebnis der Anfrage zur Auflistung der Operationen.

Wert	Beschreibung
Microsoft.Batch/batchAccounts	Der Ressourcentyp für Microsoft.Batch/batchAccounts