Locations - Check Name Availability

Service:

Media Services

API Version:

2023-01-01

Check Name Availability
Checks whether the Media Service resource name is available.

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

URI Parameters

Name	In	Required	Type	Description
locationName	path	True	string	Location name.
subscriptionId	path	True	string	The unique identifier for a Microsoft Azure subscription.
api-version	query	True	string	The version of the API to be used with the client request.

Request Body

Name	Type	Description
name	string	The account name.
type	string	The account type. For a Media Services account, this should be 'MediaServices'.

Responses

Name	Type	Description
200 OK	EntityNameAvailabilityCheckOutput	OK
Other Status Codes	ErrorResponse	Detailed error information.

Examples

Check Name Availability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Media/locations/japanwest/checkNameAvailability?api-version=2023-01-01

{
  "name": "contosotv",
  "type": "Microsoft.Media/mediaservices"
}

Java

import com.azure.resourcemanager.mediaservices.models.CheckNameAvailabilityInput;

/** Samples for Locations CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Accounts/stable/2023-01-01/examples/accounts-check-name-availability.json
     */
    /**
     * Sample code: Check Name Availability.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void checkNameAvailability(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .locations()
            .checkNameAvailabilityWithResponse(
                "japanwest",
                new CheckNameAvailabilityInput().withName("contosotv").withType("Microsoft.Media/mediaservices"),
                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.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Accounts/stable/2023-01-01/examples/accounts-check-name-availability.json
// this example is just showing the usage of "Locations_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 = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation locationName = new AzureLocation("japanwest");
MediaServicesNameAvailabilityContent content = new MediaServicesNameAvailabilityContent()
{
    Name = "contosotv",
    ResourceType = "Microsoft.Media/mediaservices",
};
MediaServicesNameAvailabilityResult result = await subscriptionResource.CheckMediaServicesNameAvailabilityAsync(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

Sample Response

Status code:

200

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Definitions

Name	Description
CheckNameAvailabilityInput	The input to the check name availability request.
EntityNameAvailabilityCheckOutput	The response from the check name availability request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

CheckNameAvailabilityInput

The input to the check name availability request.

Name	Type	Description
name	string	The account name.
type	string	The account type. For a Media Services account, this should be 'MediaServices'.

EntityNameAvailabilityCheckOutput

The response from the check name availability request.

Name	Type	Description
message	string	Specifies the detailed reason if the name is not available.
nameAvailable	boolean	Specifies if the name is available.
reason	string	Specifies the reason if the name is not available.

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.