您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Policy Metadata - List

获取策略元数据资源的列表。

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata?api-version=2019-10-01
GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata?api-version=2019-10-01&$top={$top}

URI 参数

Name In Required Type Description
api-version
query True
  • string

客户端 Api 版本。

$top
query
  • integer
int32

要返回的最大记录数。

响应

Name Type Description
200 OK

策略元数据资源集合。

Other Status Codes

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

安全性

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 模拟用户帐户

示例

Get collection of policy metadata resources
Get collection of policy metadata resources using top query parameter

Get collection of policy metadata resources

Sample Request

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata?api-version=2019-10-01

Sample Response

{
  "value": [
    {
      "properties": {
        "metadataId": "NIST SP 800-53 R4 AC-2",
        "category": "Access control",
        "title": "Account Management",
        "owner": "Shared",
        "additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2",
        "metadata": {}
      },
      "id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2",
      "name": "NIST_SP_800-53_R4_AC-2",
      "type": "Microsoft.PolicyInsights/policyMetadata"
    }
  ]
}

Get collection of policy metadata resources using top query parameter

Sample Request

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata?api-version=2019-10-01&$top=1

Sample Response

{
  "value": [
    {
      "properties": {
        "metadataId": "NIST SP 800-53 R4 AC-2",
        "category": "Access control",
        "title": "Account Management",
        "owner": "Shared",
        "additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2",
        "metadata": {}
      },
      "id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2",
      "name": "NIST_SP_800-53_R4_AC-2",
      "type": "Microsoft.PolicyInsights/policyMetadata"
    }
  ]
}

定义

ErrorDefinition

错误定义。

ErrorResponse

错误响应。

PolicyMetadataCollection

策略元数据资源的集合。

SlimPolicyMetadata

策略元数据资源定义的超薄版本,排除包含大型字符串的属性

TypedErrorInfo

特定于方案的错误详细信息。

ErrorDefinition

错误定义。

Name Type Description
additionalInfo

其他特定于方案的错误详细信息。

code
  • string

服务特定的错误代码,用作 HTTP 错误代码的子状态。

details

内部错误详细信息。

message
  • string

错误的说明。

target
  • string

错误的目标。

ErrorResponse

错误响应。

Name Type Description
error

错误详细信息。

PolicyMetadataCollection

策略元数据资源的集合。

Name Type Description
nextLink
  • string

用于获取下一组结果的 URL。

value

策略元数据定义的数组。

SlimPolicyMetadata

策略元数据资源定义的超薄版本,排除包含大型字符串的属性

Name Type Description
id
  • string

策略元数据的 ID。

name
  • string

策略元数据的名称。

properties.additionalContentUrl
  • string

用于获取有关资源元数据的其他内容的 Url。

properties.category
  • string

策略元数据的类别。

properties.metadata
  • object

其他元数据。

properties.metadataId
  • string

策略元数据标识符。

properties.owner
  • string

策略元数据的所有者。

properties.title
  • string

策略元数据的标题。

type
  • string

策略元数据的类型。

TypedErrorInfo

特定于方案的错误详细信息。

Name Type Description
info

特定于方案的错误详细信息。

type
  • string

包含的错误详细信息的类型。