Services - Check Name Availability

Service:

Data Migration

API Version:

2022-03-30-preview

Check name validity and availability
This method checks whether a proposed top-level resource name is valid and available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability?api-version=2022-03-30-preview

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The Azure region of the operation
subscriptionId	path	True	string	Subscription ID that identifies an Azure subscription.
api-version	query	True	string	Version of the API

Request Body

Name	Type	Description
name	string	The proposed resource name
type	string	The resource type chain (e.g. virtualMachines/extensions)

Responses

Name	Type	Description
200 OK	NameAvailabilityResponse	Name checked
Other Status Codes	ApiError	Error

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

Services_CheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/providers/Microsoft.DataMigration/locations/eastus/checkNameAvailability?api-version=2022-03-30-preview

{
  "name": "DmsSdkService",
  "type": "services"
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.datamigration import DataMigrationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datamigration
# USAGE
    python services_check_name_availability.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 = DataMigrationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="fc04246f-04c5-437e-ac5e-206a19e7193f",
    )

    response = client.services.check_name_availability(
        location="eastus",
        parameters={"name": "DmsSdkService", "type": "services"},
    )
    print(response)


# x-ms-original-file: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Services_CheckNameAvailability.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

dotnet

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

// Generated from example definition: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Services_CheckNameAvailability.json
// this example is just showing the usage of "Services_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 = "fc04246f-04c5-437e-ac5e-206a19e7193f";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("eastus");
NameAvailabilityRequest nameAvailabilityRequest = new NameAvailabilityRequest()
{
    Name = "DmsSdkService",
    ResourceType = "services",
};
NameAvailabilityResponse result = await subscriptionResource.CheckNameAvailabilityServiceAsync(location, nameAvailabilityRequest);

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

Definitions

Name	Description
ApiError	Error information.
createdByType
NameAvailabilityRequest	A resource type and proposed name
NameAvailabilityResponse	Indicates whether a proposed resource name is available
NameCheckFailureReason	The reason why the name is not available, if nameAvailable is false
ODataError	Error information in OData format.
SystemData

ApiError

Error information.

Name	Type	Description
error	ODataError	Error information in OData format
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

NameAvailabilityRequest

A resource type and proposed name

Name	Type	Description
name	string	The proposed resource name
type	string	The resource type chain (e.g. virtualMachines/extensions)

NameAvailabilityResponse

Indicates whether a proposed resource name is available

Name	Type	Description
message	string	The localized reason why the name is not available, if nameAvailable is false
nameAvailable	boolean	If true, the name is valid and available. If false, 'reason' describes why not.
reason	NameCheckFailureReason	The reason why the name is not available, if nameAvailable is false

NameCheckFailureReason

The reason why the name is not available, if nameAvailable is false

Name	Type	Description
AlreadyExists	string
Invalid	string

ODataError

Error information in OData format.

Name	Type	Description
code	string	The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError'
details	ODataError[]	Inner errors that caused this error
message	string	The human-readable description of the error

SystemData

Name	Type	Description
createdAt	string
createdBy	string
createdByType	createdByType
lastModifiedAt	string
lastModifiedBy	string
lastModifiedByType	createdByType