Metadata Policy - Get

服务:

Purview

API 版本:

2021-07-01-preview

获取元数据策略

GET {Endpoint}/policyStore/metadataPolicies/{policyId}?api-version=2021-07-01-preview

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	Purview 帐户的终结点。 示例：https://{accountName}.purview.azure.com。
policyId	path	True	string	需要提取的现有策略的 ID。
api-version	query	True	string	要使用的 API 版本。

响应

名称	类型	说明
200 OK	MetadataPolicy	成功
Other Status Codes	ErrorResponseModel	从元数据策略服务收到的错误响应 标头 x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

MetadataPolicy_Get

示例请求

HTTP

GET {Endpoint}/policyStore/metadataPolicies/98ed42ff-b67f-44df-8c8c-7e6b43e77055?api-version=2021-07-01-preview

示例响应

状态代码:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea889

{
  "name": "policy_mycollection",
  "id": "98ed42ff-b67f-44df-8c8c-7e6b43e77055",
  "version": 1,
  "properties": {
    "description": "",
    "decisionRules": [
      {
        "kind": "decisionrule",
        "effect": "Permit",
        "dnfCondition": [
          [
            {
              "attributeName": "resource.purview.collection",
              "attributeValueIncludes": "mycollection"
            },
            {
              "attributeName": "derived.purview.permission",
              "attributeValueIncludes": "permission:mycollection"
            }
          ]
        ]
      }
    ],
    "attributeRules": [
      {
        "kind": "attributerule",
        "id": "purviewmetadatarole_builtin_collection-administrator:mycollection",
        "name": "purviewmetadatarole_builtin_collection-administrator:mycollection",
        "dnfCondition": [
          [
            {
              "attributeName": "principal.microsoft.id",
              "attributeValueIncludedIn": [
                "69e520f2-5f26-4074-9fe1-5187d85ec005"
              ]
            },
            {
              "attributeName": "derived.purview.role",
              "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
            }
          ],
          [
            {
              "attributeName": "derived.purview.permission",
              "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:myparentcollection"
            }
          ]
        ]
      },
      {
        "kind": "attributerule",
        "id": "permission:mycollection",
        "name": "permission:mycollection",
        "dnfCondition": [
          [
            {
              "attributeName": "derived.purview.permission",
              "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:mycollection"
            }
          ],
          [
            {
              "attributeName": "derived.purview.permission",
              "attributeValueIncludes": "permission:myparentcollection"
            }
          ]
        ]
      }
    ],
    "collection": {
      "type": "CollectionReference",
      "referenceName": "mycollection"
    },
    "parentCollectionName": "myparentcollection"
  }
}

定义

名称	说明
AttributeMatcher	规则的属性匹配程序
AttributeRule	策略的属性规则
CollectionReference	策略的集合引用
Decision	规则的效果
DecisionRule	策略的决策规则
ErrorModel	元数据策略的错误模型
ErrorResponseModel	元数据策略的错误响应模型
Kind	规则类型
MetadataPolicy
MetadataPolicyProperties

AttributeMatcher

Object

规则的属性匹配程序

名称	类型	说明
attributeName	string	AttributeName
attributeValueExcludedIn	string[]	为属性排除的值列表
attributeValueExcludes	string	为属性排除的值
attributeValueIncludedIn	string[]	属性的值列表
attributeValueIncludes	string	属性的值

AttributeRule

Object

策略的属性规则

名称	类型	说明
dnfCondition	AttributeMatcher[]	规则的 dnf 条件
id	string	规则的 ID
kind	Kind	规则类型
name	string	规则的名称

CollectionReference

Object

策略的集合引用

名称	类型	默认值	说明
referenceName	string		引用的名称
type	string	CollectionReference	引用的类型

Decision

枚举

规则的效果

值	说明
Deny
Permit

DecisionRule

Object

策略的决策规则

名称	类型	说明
dnfCondition	AttributeMatcher[]	规则的 dnf 条件
effect	Decision	规则的效果
kind	Kind	规则类型

ErrorModel

Object

元数据策略的错误模型

名称	类型	说明
code	string	错误代码
details	ErrorModel[]	错误详细信息
message	string	错误消息
target	string	错误目标

ErrorResponseModel

Object

元数据策略的错误响应模型

名称	类型	说明
error	ErrorModel	元数据策略的错误模型

Kind

枚举

规则类型

值	说明
decisionrule

MetadataPolicy

Object

名称	类型	说明
id	string	策略的 ID
name	string	策略的名称
properties	MetadataPolicyProperties
version	integer (int32)	策略的版本

MetadataPolicyProperties

Object

名称	类型	说明
attributeRules	AttributeRule[]	策略的 AttributeRules
collection	CollectionReference	策略的集合引用
decisionRules	DecisionRule[]	策略的 DecisionRules
description	string	策略的说明
parentCollectionName	string	策略的父集合