Check Endpoint Name Availability - Check Endpoint Name Availability

Service:

Front Door Service

API Version:

2023-05-01

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/checkEndpointNameAvailability?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2023-05-01.

Request Body

Name	Required	Type	Description
name	True	string	The resource name to validate.
type	True	ResourceType	The type of the resource whose name is to be validated.
autoGeneratedDomainNameLabelScope		AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.

Responses

Name	Type	Description
200 OK	CheckEndpointNameAvailabilityOutput	OK. The request has succeeded.
Other Status Codes	AfdErrorResponse	Azure Front Door error response describing why the operation failed.

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

CheckEndpointNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/myResourceGroup/providers/Microsoft.Cdn/checkEndpointNameAvailability?api-version=2023-05-01

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/AfdEndpoints",
  "autoGeneratedDomainNameLabelScope": "TenantReuse"
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python check_endpoint_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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.check_endpoint_name_availability(
        resource_group_name="myResourceGroup",
        check_endpoint_name_availability_input={
            "autoGeneratedDomainNameLabelScope": "TenantReuse",
            "name": "sampleName",
            "type": "Microsoft.Cdn/Profiles/AfdEndpoints",
        },
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/CheckEndpointNameAvailability.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 armcdn_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/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/CheckEndpointNameAvailability.json
func ExampleManagementClient_CheckEndpointNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagementClient().CheckEndpointNameAvailability(ctx, "myResourceGroup", armcdn.CheckEndpointNameAvailabilityInput{
		Name:                              to.Ptr("sampleName"),
		Type:                              to.Ptr(armcdn.ResourceTypeMicrosoftCdnProfilesAfdEndpoints),
		AutoGeneratedDomainNameLabelScope: to.Ptr(armcdn.AutoGeneratedDomainNameLabelScopeTenantReuse),
	}, 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.CheckEndpointNameAvailabilityOutput = armcdn.CheckEndpointNameAvailabilityOutput{
	// 	AvailableHostname: to.Ptr(""),
	// 	Message: to.Ptr("Name not available"),
	// 	NameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr("Name is already in use"),
	// }
}

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 { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.
 *
 * @summary Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/CheckEndpointNameAvailability.json
 */
async function checkEndpointNameAvailability() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "myResourceGroup";
  const checkEndpointNameAvailabilityInput = {
    name: "sampleName",
    type: "Microsoft.Cdn/Profiles/AfdEndpoints",
    autoGeneratedDomainNameLabelScope: "TenantReuse",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.checkEndpointNameAvailability(
    resourceGroupName,
    checkEndpointNameAvailabilityInput
  );
  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

Sample Response

Status code:

200

{
  "nameAvailable": false,
  "reason": "Name is already in use",
  "message": "Name not available",
  "availableHostname": ""
}

Definitions

Name	Description
AfdErrorResponse	Error response
AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
CheckEndpointNameAvailabilityInput	Input of CheckNameAvailability API.
CheckEndpointNameAvailabilityOutput	Output of check name availability API.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ResourceType	Type of CDN resource used in CheckNameAvailability.

AfdErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

AutoGeneratedDomainNameLabelScope

Indicates the endpoint name reuse scope. The default value is TenantReuse.

Name	Type	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

CheckEndpointNameAvailabilityInput

Input of CheckNameAvailability API.

Name	Type	Description
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
name	string	The resource name to validate.
type	ResourceType	The type of the resource whose name is to be validated.

CheckEndpointNameAvailabilityOutput

Output of check name availability API.

Name	Type	Description
availableHostname	string	Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string
message	string	The detailed error message describing why the name is not available.
nameAvailable	boolean	Indicates whether the name is available.
reason	string	The reason why 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.

ResourceType

Type of CDN resource used in CheckNameAvailability.

Name	Type	Description
Microsoft.Cdn/Profiles/AfdEndpoints	string
Microsoft.Cdn/Profiles/Endpoints	string