Tutorial: Funcionalidad de Atlas 2.2

Importante

Se retirarán el Catálogo unificado de Microsoft Purview y las funcionalidades clásicas de gobierno de datos de Microsoft Purview (anteriormente Azure Purview). Microsoft está consolidando sus capacidades de gobernanza de datos en Microsoft Fabric. Ya no puede crear cuentas nuevas y las funcionalidades existentes permanecerán en modo de mantenimiento hasta el 12 de noviembre de 2027. Para conocer los plazos de retirada, las instrucciones de transición y los próximos pasos recomendados, consulte el anuncio de retirada de la gobernanza de datos de Microsoft Purview.

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

API de metadatos empresariales

Los metadatos empresariales son una plantilla que contiene atributos personalizados (valores clave). Puede crear estos atributos globalmente y, a continuación, aplicarlos en varias definiciones de tipo.

Punto de conexión de Atlas

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

  1. Buscar una cuenta de Microsoft Purview en Azure Portal
  2. Seleccione la página Propiedades en el menú del lado izquierdo
  3. Copie el valor del extremo de Atlas

Captura de pantalla de la página de propiedades de Microsoft Purview con el cuadro de punto de conexión Atlas resaltado.

Crear 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 muestra:

   {
  "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\"]"
          }          
        }
      ]
    }
  ]
}

Agregar o actualizar un atributo a los metadatos empresariales existentes

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

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

JSON de muestra:

   {
  "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\"]"
          }          
        }
      ]
    }
  ]
}

Obtener 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}}

Establecer 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 muestra:

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

Eliminar 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 muestra:

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

Eliminar una definición de tipo de metadatos empresariales

Nota:

Solo puede eliminar la definición de tipo de metadatos empresariales si no tiene referencias, es decir, si no se ha asignado a ningún activo 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 de Atlas.

Establecer un atributo personalizado a una entidad

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

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

JSON de muestra:

{
    "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 de 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 muestra:

[
  "label1",
  "label2"
]

Eliminar etiquetas para una entidad

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

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

JSON de muestra:

[
  "label2"
]

Pasos siguientes

Administrar orígenes de datosAPI REST del plano de datos de Microsoft Purview

  • Se actualizó por última vez el