Location - Check Name Availability

Szolgáltatás:

Batch Management

API-verzió:

2025-06-01

Ellenőrzi, hogy a Batch-fiók neve elérhető-e a megadott régióban.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
locationName	path	True	string	A névellenőrzés kívánt régiója.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	A rendelkezésre állás ellenőrzéséhez használt név
type	True	ResourceType	Az erőforrás típusa.

Válaszok

Name	Típus	Description
200 OK	CheckNameAvailabilityResult	A kérés sikeres volt.
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

LocationCheckNameAvailability_AlreadyExists

LocationCheckNameAvailability_Available

LocationCheckNameAvailability_AlreadyExists

Mintakérelem

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"
}

Java

import com.azure.resourcemanager.batch.models.CheckNameAvailabilityParameters;
import com.azure.resourcemanager.batch.models.ResourceType;

/**
 * Samples for Location CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_AlreadyExists.json
     */
    /**
     * Sample code: LocationCheckNameAvailability_AlreadyExists.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void
        locationCheckNameAvailabilityAlreadyExists(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.locations()
            .checkNameAvailabilityWithResponse("japaneast", new CheckNameAvailabilityParameters()
                .withName("existingaccountname").withType(ResourceType.MICROSOFT_BATCH_BATCH_ACCOUNTS),
                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.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

Mintaválasz

Állapotkód:

200

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

LocationCheckNameAvailability_Available

Mintakérelem

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"
}

Java

import com.azure.resourcemanager.batch.models.CheckNameAvailabilityParameters;
import com.azure.resourcemanager.batch.models.ResourceType;

/**
 * Samples for Location CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-06-01/LocationCheckNameAvailability_Available.json
     */
    /**
     * Sample code: LocationCheckNameAvailability_Available.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void locationCheckNameAvailabilityAvailable(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.locations()
            .checkNameAvailabilityWithResponse("japaneast", new CheckNameAvailabilityParameters()
                .withName("newaccountname").withType(ResourceType.MICROSOFT_BATCH_BATCH_ACCOUNTS),
                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.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

Mintaválasz

Állapotkód:

200

{
  "nameAvailable": true
}

Definíciók

Name	Description
CheckNameAvailabilityParameters	Az ellenőrzőnév rendelkezésre állási kérésének paraméterei.
CheckNameAvailabilityResult	A CheckNameAvailability művelet válasza.
CloudError	Hibaválasz a Batch szolgáltatástól.
CloudErrorBody	Hibaválasz a Batch szolgáltatástól.
NameAvailabilityReason	Lekérdezi, hogy miért nem használható Batch-fióknév. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.
ResourceType	A műveletek listázására vonatkozó kérelem eredménye.

CheckNameAvailabilityParameters

Tárgy

Az ellenőrzőnév rendelkezésre állási kérésének paraméterei.

Name	Típus	Description
name	string	A rendelkezésre állás ellenőrzéséhez használt név
type	ResourceType	Az erőforrás típusa.

CheckNameAvailabilityResult

Tárgy

A CheckNameAvailability művelet válasza.

Name	Típus	Description
message	string	Hibaüzenet jelenik meg, amely részletesebben ismerteti az Ok értéket.
nameAvailable	boolean	Logikai értéket kap, amely jelzi, hogy a név használható-e. Ha igaz, a név elérhető. Ha hamis, a név már foglalt vagy érvénytelen, és nem használható.
reason	NameAvailabilityReason	Lekérdezi, hogy miért nem használható Batch-fióknév. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.

CloudError

Tárgy

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	A hibaválasz törzse.

CloudErrorBody

Tárgy

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

NameAvailabilityReason

Felsorolás

Lekérdezi, hogy miért nem használható Batch-fióknév. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.

Érték	Description
Invalid	A kért név érvénytelen.
AlreadyExists	A kért név már használatban van.

ResourceType

Felsorolás

A műveletek listázására vonatkozó kérelem eredménye.

Érték	Description
Microsoft.Batch/batchAccounts	A Microsoft.Batch/batchAccounts erőforrás típusa