Tutorial: Nueva funcionalidad de Atlas 2.2

En este tutorial, aprenderá a interactuar mediante programación con las nuevas API de Atlas 2.2 con el mapa de datos de Microsoft Purview.

Requisitos previos

• Si no tiene una suscripción de Azure, cree una cuenta gratuita antes de empezar.

• Debe tener una cuenta de Microsoft Purview existente. Si no tiene un catálogo, consulte el inicio rápido para crear una cuenta de Microsoft Purview.

• Para establecer un token de portador y llamar a cualquier API, consulte la documentación sobre cómo autenticar las API para Microsoft Purview.

API de metadatos empresariales

Los metadatos empresariales son una plantilla que contiene atributos personalizados (valores de clave). Puede crear estos atributos globalmente y aplicarlos a través de varias definiciones de tipo.

Punto de conexión de Atlas

Para todas las solicitudes, necesitará el punto de conexión de Atlas para su cuenta de Microsoft Purview.

1. Busque su cuenta de Microsoft Purview en el Azure Portal
2. Seleccione la página Propiedades en el menú de la izquierda.
3. Copia del valor del punto de conexión de Atlas

Creación de metadatos empresariales con atributos

Puede enviar una POST solicitud al siguiente punto de conexión:

POST {{endpoint}}/api/atlas/v2/types/typedefs

Sugerencia

La propiedad applicableEntityTypes indica a qué tipos de datos se aplicarán los metadatos.

JSON de ejemplo:

   {
  "businessMetadataDefs": [
    {
      "category": "BUSINESS_METADATA",
      "createdBy": "admin",
      "updatedBy": "admin",
      "version": 1,
      "typeVersion": "1.1",
      "name": "<Name of Business Metadata>",
      "description": "",
      "attributeDefs": [
        {
          "name": "<Attribute Name>",
          "typeName": "string",
          "isOptional": true,
          "cardinality": "SINGLE",
          "isUnique": false,
          "isIndexable": true,
          "options": {
            "maxStrLength": "50",
            "applicableEntityTypes": "[\"Referenceable\"]"
          }          
        }
      ]
    }
  ]
}

Adición o actualización de un atributo a metadatos empresariales existentes

Puede enviar una PUT solicitud al siguiente punto de conexión:

PUT {{endpoint}}/api/atlas/v2/types/typedefs

JSON de ejemplo:

   {
  "businessMetadataDefs": [
    {
      "category": "BUSINESS_METADATA",
      "createdBy": "admin",
      "updatedBy": "admin",
      "version": 1,
      "typeVersion": "1.1",
      "name": "<Name of Business Metadata>",
      "description": "",
      "attributeDefs": [
        {
          "name": "<Attribute Name>",
          "typeName": "string",
          "isOptional": true,
          "cardinality": "SINGLE",
          "isUnique": false,
          "isIndexable": true,
          "options": {
            "maxStrLength": "500",
            "applicableEntityTypes": "[\"Referenceable\"]"
          }          
        },
        {
          "name": "<Attribute Name 2>",
          "typeName": "int",
          "isOptional": true,
          "cardinality": "SINGLE",
          "isUnique": false,
          "isIndexable": true,
          "options": {
            "applicableEntityTypes": "[\"Referenceable\"]"
          }          
        }
      ]
    }
  ]
}

Obtención de una definición de metadatos empresariales

Puede enviar una GET solicitud al siguiente punto de conexión:

GET {endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}

Establecimiento de un atributo de metadatos empresariales en una entidad

Puede enviar una POST solicitud al siguiente punto de conexión:

POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true

JSON de ejemplo:

{
  "myBizMetaData1": {
        "bizAttr1": "I am myBizMetaData1.bizAttr1",
        "bizAttr2": 123,
  }
 }

Eliminación de un atributo de metadatos empresariales de una entidad

Puede enviar una DELETE solicitud al siguiente punto de conexión:

'DELETE' {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true

JSON de ejemplo:

{
  "myBizMetaData1": {
    "bizAttr1": ""    
  }
}

Eliminación de una definición de tipo de metadatos empresariales

Nota:

Solo puede eliminar la definición del tipo de metadatos empresarial si no tiene referencias, es decir, si no se ha asignado a ningún recurso del catálogo.

Puede enviar una DELETE solicitud al siguiente punto de conexión:

DELETE {{endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}

API de atributos personalizados

Los atributos personalizados son pares clave-valor que se pueden agregar directamente a una entidad atlas.

Establecer un atributo personalizado en una entidad

Puede enviar una POST solicitud al siguiente punto de conexión:

POST {{endpoint}}/api/atlas/v2/entity

JSON de ejemplo:

{
    "entity": {
        "typeName": "azure_datalake_gen2_path",
        "attributes": {
           
            "qualifiedName": "<FQN of the asset>",
            "name": "data6.csv"
        },
        "guid": "3ffb28ff-138f-419e-84ba-348b0165e9e0",
        "customAttributes": {
            "custAttr1": "attr1",
            "custAttr2": "attr2"
        }
    }
}

API de etiquetas

Las etiquetas son etiquetas de texto libre que se pueden aplicar a cualquier entidad atlas.

Establecer etiquetas en una entidad

Puede enviar una POST solicitud al siguiente punto de conexión:

POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels

JSON de ejemplo:

[
  "label1",
  "label2"
]

Eliminación de etiquetas en una entidad

Puede enviar una DELETE solicitud al siguiente punto de conexión:

DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels

JSON de ejemplo:

[
  "label2"
]

Pasos siguientes

Administración de orígenes de datosApi REST del plano de datos de Microsoft Purview