你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Scheduled Actions - Check Name Availability

检查计划操作的名称的可用性和正确性。

POST https://management.azure.com/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

URI 参数

名称 必需 类型 说明
api-version
query True

string

用于此操作的 API 版本。

请求正文

名称 类型 说明
name

string

需要检查其可用性的资源的名称。

type

string

资源类型。

响应

名称 类型 说明
200 OK

CheckNameAvailabilityResponse

计划操作名称可用性的响应。

Other Status Codes

ErrorResponseWithNestedDetails

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ScheduledActionCheckNameAvailability

示例请求

POST https://management.azure.com/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

{
  "name": "testName",
  "type": "Microsoft.CostManagement/ScheduledActions"
}

示例响应

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name."
}

定义

名称 说明
CheckNameAvailabilityReason

给定名称不可用的原因。

CheckNameAvailabilityRequest

检查可用性请求正文。

CheckNameAvailabilityResponse

检查可用性结果。

ErrorDetailsWithNestedDetails

错误的详细信息。

ErrorResponseWithNestedDetails

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

CheckNameAvailabilityReason

给定名称不可用的原因。

名称 类型 说明
AlreadyExists

string

Invalid

string

CheckNameAvailabilityRequest

检查可用性请求正文。

名称 类型 说明
name

string

需要检查其可用性的资源的名称。

type

string

资源类型。

CheckNameAvailabilityResponse

检查可用性结果。

名称 类型 说明
message

string

给定名称可用的详细原因。

nameAvailable

boolean

指示资源名称是否可用。

reason

CheckNameAvailabilityReason

给定名称不可用的原因。

ErrorDetailsWithNestedDetails

错误的详细信息。

名称 类型 说明
code

string

错误代码。

details

ErrorDetailsWithNestedDetails[]

错误的其他详细信息。

message

string

指示操作失败的原因的错误消息。

ErrorResponseWithNestedDetails

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

名称 类型 说明
error

ErrorDetailsWithNestedDetails

错误的详细信息。