Tutorial: Nova funcionalidade do Atlas 2.2

Neste tutorial, aprenda a interagir programaticamente com as novas APIs do Atlas 2.2 com o mapa de dados no Microsoft Purview.

Pré-requisitos

• Se não tiver uma subscrição do Azure, crie uma conta gratuita antes de começar.

• Tem de ter uma conta do Microsoft Purview existente. Se não tiver um catálogo, veja o início rápido para criar uma conta do Microsoft Purview.

• Para estabelecer um token de portador e chamar quaisquer APIs, consulte a documentação sobre como autenticar APIs para o Microsoft Purview..

APIs de metadados empresariais

Os metadados empresariais são um modelo que contém atributos personalizados (valores chave). Pode criar estes atributos globalmente e, em seguida, aplicá-los em vários typedefs.

Ponto final do Atlas

Para todos os pedidos, precisará do ponto final do Atlas para a sua conta do Microsoft Purview.

1. Localize a sua conta do Microsoft Purview no portal do Azure
2. Selecione a página Propriedades no menu do lado esquerdo
3. Copiar o valor do ponto final do Atlas

Criar metadados empresariais com atributos

Pode enviar um POST pedido para o seguinte ponto final:

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

Dica

A propriedade applicableEntityTypes indica a que tipos de dados os metadados serão aplicados.

JSON de exemplo:

JSON

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

Adicionar ou atualizar um atributo para metadados empresariais existentes

Pode enviar um PUT pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

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

Obter uma definição de metadados empresariais

Pode enviar um GET pedido para o seguinte ponto final:

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

Definir um atributo de metadados empresariais para uma entidade

Pode enviar um POST pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

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

Eliminar um atributo de metadados empresariais de uma entidade

Pode enviar um DELETE pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

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

Eliminar uma definição de tipo de metadados empresariais

Observação

Só pode eliminar a definição do tipo de metadados empresariais se não tiver referências, ou seja, se não tiver sido atribuída a quaisquer recursos no catálogo.

Pode enviar um DELETE pedido para o seguinte ponto final:

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

APIs de atributo personalizado

Os atributos personalizados são pares chave/valor que podem ser adicionados diretamente a uma entidade Atlas.

Definir um atributo personalizado para uma entidade

Pode enviar um POST pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

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

APIs de Etiqueta

As etiquetas são etiquetas de texto livre que podem ser aplicadas a qualquer entidade Atlas.

Definir etiquetas para uma entidade

Pode enviar um POST pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

[
  "label1",
  "label2"
]

Eliminar etiquetas para uma entidade

Pode enviar um DELETE pedido para o seguinte ponto final:

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

JSON de exemplo:

JSON

[
  "label2"
]

Próximas etapas

Gerir origens de dadosapIs REST do plano de dados do Microsoft Purview