Check Name Availability - Check Name Availability

服务:

CDN

API 版本:

2025-04-15

检查资源名称的可用性。 对于名称全局唯一（例如 CDN 终结点）的资源，这是必需的。

POST https://management.azure.com/providers/Microsoft.Cdn/checkNameAvailability?api-version=2025-04-15

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
name	True	string	要验证的资源名称。
type	True	ResourceType	要验证其名称的资源的类型。

响应

名称	类型	说明
200 OK	CheckNameAvailabilityOutput	还行。 请求已成功。
Other Status Codes	ErrorResponse	描述作失败的原因的 CDN 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

CheckNameAvailability

示例请求

HTTP

POST https://management.azure.com/providers/Microsoft.Cdn/checkNameAvailability?api-version=2025-04-15

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/Endpoints"
}

dotnet

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

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/CheckNameAvailability.json
// this example is just showing the usage of "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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
CdnNameAvailabilityContent content = new CdnNameAvailabilityContent("sampleName", CdnResourceType.Endpoints);
CdnNameAvailabilityResult result = await tenantResource.CheckCdnNameAvailabilityAsync(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

示例响应

状态代码:

200

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

定义

名称	说明
CheckNameAvailabilityInput	CheckNameAvailability API 的输入。
CheckNameAvailabilityOutput	检查名称可用性 API 的输出。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ResourceType	CheckNameAvailability 中使用的 CDN 资源类型。

CheckNameAvailabilityInput

Object

CheckNameAvailability API 的输入。

名称	类型	说明
name	string	要验证的资源名称。
type	ResourceType	要验证其名称的资源的类型。

CheckNameAvailabilityOutput

Object

检查名称可用性 API 的输出。

名称	类型	说明
message	string	描述名称不可用的原因的详细错误消息。
nameAvailable	boolean	指示名称是否可用。
reason	string	名称不可用的原因。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ResourceType

枚举

CheckNameAvailability 中使用的 CDN 资源类型。

值	说明
Microsoft.Cdn/Profiles/AfdEndpoints
Microsoft.Cdn/Profiles/Endpoints