Accounts - Check Name Availability

Service:

Data Lake Analytics

API Version:

2016-11-01

Checks whether the specified account name is available or taken.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The resource location without whitespace.
subscriptionId	path	True	string	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
name	True	string	The Data Lake Analytics name to check availability for.
type	True	enum: Microsoft.DataLakeAnalytics/accounts	The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeAnalytics/accounts

Responses

Name	Type	Description
200 OK	NameAvailabilityInformation	Successfully retrieved the Data Lake Analytics account name availability information.
Other Status Codes	ErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Checks whether the specified account name is available or taken

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DataLakeAnalytics/locations/EastUS2/checkNameAvailability?api-version=2016-11-01

{
  "name": "contosoadla",
  "type": "Microsoft.DataLakeAnalytics/accounts"
}

Java

import com.azure.resourcemanager.datalakeanalytics.models.CheckNameAvailabilityParameters;

/** Samples for Accounts CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_CheckNameAvailability.json
     */
    /**
     * Sample code: Checks whether the specified account name is available or taken.
     *
     * @param manager Entry point to DataLakeAnalyticsManager.
     */
    public static void checksWhetherTheSpecifiedAccountNameIsAvailableOrTaken(
        com.azure.resourcemanager.datalakeanalytics.DataLakeAnalyticsManager manager) {
        manager
            .accounts()
            .checkNameAvailabilityWithResponse(
                "EastUS2",
                new CheckNameAvailabilityParameters().withName("contosoadla"),
                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

dotnet

using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataLakeAnalytics;
using Azure.ResourceManager.DataLakeAnalytics.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_CheckNameAvailability.json
// this example is just showing the usage of "Accounts_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 = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("EastUS2");
DataLakeAnalyticsAccountNameAvailabilityContent content = new DataLakeAnalyticsAccountNameAvailabilityContent("contosoadla", DataLakeAnalyticsResourceType.MicrosoftDataLakeAnalyticsAccounts);
DataLakeAnalyticsAccountNameAvailabilityResult result = await subscriptionResource.CheckDataLakeAnalyticsAccountNameAvailabilityAsync(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

Sample Response

Status code:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "An account named 'abc' already exists."
}

Definitions

Name	Description
CheckNameAvailabilityParameters	Data Lake Analytics account name availability check parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NameAvailabilityInformation	Data Lake Analytics account name availability result information.

CheckNameAvailabilityParameters

Data Lake Analytics account name availability check parameters.

Name	Type	Description
name	string	The Data Lake Analytics name to check availability for.
type	enum: Microsoft.DataLakeAnalytics/accounts	The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeAnalytics/accounts

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NameAvailabilityInformation

Data Lake Analytics account name availability result information.

Name	Type	Description
message	string	The message describing why the Data Lake Analytics account name is not available, if nameAvailable is false.
nameAvailable	boolean	The Boolean value of true or false to indicate whether the Data Lake Analytics account name is available or not.
reason	string	The reason why the Data Lake Analytics account name is not available, if nameAvailable is false.