Location - Check Name Availability

サービス:

Batch Management

API バージョン:

2025-06-01

指定したリージョンで Batch アカウント名を使用できるかどうかを確認します。

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

URI パラメーター

名前	/	必須	型	説明
locationName	path	True	string	名前チェックの目的のリージョン。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
name	True	string	可用性を確認する名前
type	True	ResourceType	リソースの種類。

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	要求は成功しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

LocationCheckNameAvailability_AlreadyExists

LocationCheckNameAvailability_Available

LocationCheckNameAvailability_AlreadyExists

要求のサンプル

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

応答のサンプル

状態コード:

200

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

LocationCheckNameAvailability_Available

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "nameAvailable": true
}

定義

名前	説明
CheckNameAvailabilityParameters	チェック名の可用性要求のパラメーター。
CheckNameAvailabilityResult	CheckNameAvailability 操作の応答。
CloudError	Batch サービスからのエラー応答。
CloudErrorBody	Batch サービスからのエラー応答。
NameAvailabilityReason	Batch アカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。
ResourceType	操作をリストアップするリクエストの結果です。

CheckNameAvailabilityParameters

Object

チェック名の可用性要求のパラメーター。

名前	型	説明
name	string	可用性を確認する名前
type	ResourceType	リソースの種類。

CheckNameAvailabilityResult

Object

CheckNameAvailability 操作の応答。

名前	型	説明
message	string	Reason 値について詳しく説明するエラー メッセージを取得します。
nameAvailable	boolean	名前を使用できるかどうかを示すブール値を取得します。 true の場合、名前を使用できます。 false の場合、名前は既に取得されているか無効であり、使用できません。
reason	NameAvailabilityReason	Batch アカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

CloudError

Object

Batch サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラー応答の本文。

CloudErrorBody

Object

Batch サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

NameAvailabilityReason

列挙

Batch アカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

値	説明
Invalid	要求された名前が無効です。
AlreadyExists	要求された名前は既に使用されています。

ResourceType

列挙

操作をリストアップするリクエストの結果です。

値	説明
Microsoft.Batch/batchAccounts	Microsoft.Batch/batchAccounts のリソースタイプ