Metadata Policy - List All

Servicio:

Purview

Versión de la API:

2021-07-01-preview

Enumerar u obtener directivas de metadatos

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com.
api-version	query	True	string	La versión de api que se va a usar.
collectionName	query		string	Nombre de una colección existente para la que se debe capturar una directiva.

Respuestas

Nombre	Tipo	Description
200 OK	MetadataPolicyList	Correcto
Other Status Codes	ErrorResponseModel	Una respuesta de error recibida del servicio de directivas de metadatos Encabezados x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

MetadataPolicy_ListAll

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba

{
  "values": [
    {
      "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"
      }
    },
    {
      "name": "policy_myparentcollection",
      "id": "b69bb29e-91dc-41f5-af94-3eb86f9c45e8",
      "version": 6,
      "properties": {
        "description": "",
        "decisionRules": [
          {
            "kind": "decisionrule",
            "effect": "Permit",
            "dnfCondition": [
              [
                {
                  "attributeName": "resource.purview.collection",
                  "attributeValueIncludes": "myparentcollection"
                },
                {
                  "attributeName": "derived.purview.permission",
                  "attributeValueIncludes": "permission:myparentcollection"
                }
              ]
            ]
          }
        ],
        "attributeRules": [
          {
            "kind": "attributerule",
            "id": "purviewmetadatarole_builtin_collection-administrator:myparentcollection",
            "name": "purviewmetadatarole_builtin_collection-administrator:myparentcollection",
            "dnfCondition": [
              [
                {
                  "attributeName": "principal.microsoft.id",
                  "attributeValueIncludedIn": [
                    "6545aabd-7f83-4e63-adc1-45dcab61d5c3"
                  ]
                },
                {
                  "attributeName": "derived.purview.role",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
                }
              ]
            ]
          },
          {
            "kind": "attributerule",
            "id": "purviewmetadatarole_builtin_purview-reader:myparentcollection",
            "name": "purviewmetadatarole_builtin_purview-reader:myparentcollection",
            "dnfCondition": [
              [
                {
                  "attributeName": "principal.microsoft.id",
                  "attributeValueIncludedIn": [
                    "6545aabd-7f83-4e63-adc1-45dcab61d5c3"
                  ]
                },
                {
                  "attributeName": "derived.purview.role",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_purview-reader"
                }
              ]
            ]
          },
          {
            "kind": "attributerule",
            "id": "purviewmetadatarole_builtin_data-curator:myparentcollection",
            "name": "purviewmetadatarole_builtin_data-curator:myparentcollection",
            "dnfCondition": [
              [
                {
                  "attributeName": "principal.microsoft.id",
                  "attributeValueIncludedIn": [
                    "6545aabd-7f83-4e63-adc1-45dcab61d5c3"
                  ]
                },
                {
                  "attributeName": "derived.purview.role",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_data-curator"
                }
              ]
            ]
          },
          {
            "kind": "attributerule",
            "id": "purviewmetadatarole_builtin_data-source-administrator:myparentcollection",
            "name": "purviewmetadatarole_builtin_data-source-administrator:myparentcollection",
            "dnfCondition": [
              [
                {
                  "attributeName": "principal.microsoft.id",
                  "attributeValueIncludedIn": [
                    "6545aabd-7f83-4e63-adc1-45dcab61d5c3"
                  ]
                },
                {
                  "attributeName": "derived.purview.role",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_data-source-administrator"
                }
              ]
            ]
          },
          {
            "kind": "attributerule",
            "id": "permission:myparentcollection",
            "name": "permission:myparentcollection",
            "dnfCondition": [
              [
                {
                  "attributeName": "derived.purview.permission",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:myparentcollection"
                }
              ],
              [
                {
                  "attributeName": "derived.purview.permission",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_purview-reader:myparentcollection"
                }
              ],
              [
                {
                  "attributeName": "derived.purview.permission",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_data-curator:myparentcollection"
                }
              ],
              [
                {
                  "attributeName": "derived.purview.permission",
                  "attributeValueIncludes": "purviewmetadatarole_builtin_data-source-administrator:myparentcollection"
                }
              ]
            ]
          }
        ],
        "collection": {
          "type": "CollectionReference",
          "referenceName": "myparentcollection"
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
AttributeMatcher	Buscador de coincidencias de atributos para una regla
AttributeRule	Regla de atributo para una directiva
CollectionReference	Referencia de colección de una directiva
Decision	El efecto de la regla
DecisionRule	Regla de decisión de una directiva
ErrorModel	El modelo de error para la directiva de metadatos
ErrorResponseModel	Modelo de respuesta de error para la directiva de metadatos
Kind	El tipo de regla
MetadataPolicy
MetadataPolicyList	Lista de directivas de metadatos
MetadataPolicyProperties

AttributeMatcher

Buscador de coincidencias de atributos para una regla

Nombre	Tipo	Description
attributeName	string	AttributeName
attributeValueExcludedIn	string[]	Lista de valores excluidos para el atributo
attributeValueExcludes	string	Valor excluido para el atributo
attributeValueIncludedIn	string[]	Lista de valores para el atributo
attributeValueIncludes	string	Valor para el atributo

AttributeRule

Regla de atributo para una directiva

Nombre	Tipo	Description
dnfCondition	AttributeMatcher[]	Condición dnf para una regla
id	string	Identificador de la regla
kind	Kind	El tipo de regla
name	string	Nombre de la regla

CollectionReference

Referencia de colección de una directiva

Nombre	Tipo	Valor predeterminado	Description
referenceName	string		Nombre de referencia
type	string	CollectionReference	Tipo de referencia

Decision

El efecto de la regla

Nombre	Tipo	Description
Deny	string
Permit	string

DecisionRule

Regla de decisión de una directiva

Nombre	Tipo	Description
dnfCondition	AttributeMatcher[]	Condición dnf para una regla
effect	Decision	El efecto de la regla
kind	Kind	El tipo de regla

ErrorModel

El modelo de error para la directiva de metadatos

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorModel[]	Detalles del error
message	string	El mensaje de error.
target	string	Destino del error

ErrorResponseModel

Modelo de respuesta de error para la directiva de metadatos

Nombre	Tipo	Description
error	ErrorModel	El modelo de error para la directiva de metadatos

Kind

El tipo de regla

Nombre	Tipo	Description
decisionrule	string

MetadataPolicy

Nombre	Tipo	Description
id	string	El identificador de la directiva
name	string	El nombre de la directiva
properties	MetadataPolicyProperties
version	integer	La versión de la directiva

MetadataPolicyList

Lista de directivas de metadatos

Nombre	Tipo	Description
nextLink	string
values	MetadataPolicy[]

MetadataPolicyProperties

Nombre	Tipo	Description
attributeRules	AttributeRule[]	AttributeRules de la directiva
collection	CollectionReference	Referencia de colección de una directiva
decisionRules	DecisionRule[]	DecisionRules de la directiva
description	string	Descripción de la directiva
parentCollectionName	string	La colección primaria de la directiva