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

Metadata - Get Entity

获取元数据实体的列表。

GET https://management.azure.com/providers/Microsoft.ResourceHealth/metadata/{name}?api-version=2024-02-01

URI 参数

名称 必需 类型 说明
name
path True

string

元数据实体的名称。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

MetadataEntity

没问题。 已成功检索到的元数据实体

Other Status Codes

ErrorResponse

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GetMetadata

示例请求

GET https://management.azure.com/providers/Microsoft.ResourceHealth/metadata/status?api-version=2024-02-01

示例响应

{
  "id": "/providers/Microsoft.ResourceHealth/metadata/status",
  "type": "Microsoft.ResourceHealth/metadata",
  "name": "status",
  "properties": {
    "displayName": "Status",
    "applicableScenarios": [
      "Alerts"
    ],
    "supportedValues": [
      {
        "id": "Active",
        "displayName": "Active"
      },
      {
        "id": "Resolved",
        "displayName": "Resolved"
      },
      {
        "id": "In Progress",
        "displayName": "In Progress"
      },
      {
        "id": "Updated",
        "displayName": "Updated"
      }
    ]
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorResponse

错误详细信息。

MetadataEntity

元数据实体协定。

MetadataSupportedValueDetail

元数据支持的值详细信息。

Scenario

适用于此元数据实体的方案列表。

systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorResponse

错误详细信息。

名称 类型 说明
code

string

错误代码。

details

string

错误详细信息。

message

string

错误消息。

MetadataEntity

元数据实体协定。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.applicableScenarios

Scenario[]

适用于此元数据实体的方案列表。

properties.dependsOn

string[]

此实体所依赖的键列表。

properties.displayName

string

显示名称。

properties.supportedValues

MetadataSupportedValueDetail[]

支持值的列表。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

MetadataSupportedValueDetail

元数据支持的值详细信息。

名称 类型 说明
displayName

string

显示名称。

id

string

元数据值的 ID

previousId

string

id 字段的上一个值,在数据已更改的案例中。

resourceTypes

string[]

关联的资源类型的列表。

serviceGuid

string

服务的永久 guid。 当 ID 为服务名称时使用。

Scenario

适用于此元数据实体的方案列表。

名称 类型 说明
Alerts

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。