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

check Resource Name - check Resource Name

检查资源名称有效性
如果资源名称不是保留字,不包含保留字且不以保留字开头,则资源名称有效

POST https://management.azure.com/providers/Microsoft.Resources/checkResourceName?api-version=2022-12-01

URI 参数

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

string

minLength: 1

用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

资源的名称

type True

string

资源的类型

响应

名称 类型 说明
200 OK

CheckResourceNameResult

确定 - 返回允许或不允许的状态。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CheckValidityForAResourceName

示例请求

POST https://management.azure.com/providers/Microsoft.Resources/checkResourceName?api-version=2022-12-01

示例响应

{
  "name": "isxbox",
  "type": "ResourceProviderTestHost/TestResourceType",
  "status": "Allowed"
}

定义

名称 说明
CheckResourceNameResult

如果资源名称不是保留字,则不包含保留字,并且不以保留字开头

CloudError

资源管理请求的错误响应。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ResourceName

资源的名称和类型

ResourceNameStatus

允许或保留的资源名称

CheckResourceNameResult

如果资源名称不是保留字,则不包含保留字,并且不以保留字开头

名称 类型 说明
name

string

资源名称

status

ResourceNameStatus

允许或保留的资源名称

type

string

资源类型

CloudError

资源管理请求的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。 (这也遵循 OData 错误响应格式)。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ResourceName

资源的名称和类型

名称 类型 说明
name

string

资源的名称

type

string

资源的类型

ResourceNameStatus

允许或保留的资源名称

说明
Allowed
Reserved