Tutorial: Nova funcionalidade do Atlas 2.2

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

Pré-requisitos

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

• Você deve ter uma conta existente do Microsoft Purview. Se você não tiver um catálogo, consulte o início rápido para criar uma conta do Microsoft Purview.

• Para estabelecer um token de portador e chamar as APIs do plano de dados, consulte a documentação sobre como chamar APIs REST para os planos de dados do Microsoft Purview.

APIs de metadados de negócios

Metadados de negócios são um modelo que contém atributos personalizados (valores-chave). Você pode criar esses atributos globalmente e aplicá-los em vários typedefs.

Ponto de extremidade do Atlas

Para todas as solicitações, você precisará do ponto de extremidade do Atlas para sua conta do Microsoft Purview.

1. Encontre 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 de extremidade do Atlas

Criar metadados de negócios com atributos

Você pode enviar uma solicitação POST para o seguinte ponto de extremidade:

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

Dica

A propriedadeEntityTypes aplicável informa a quais tipos de dados os metadados serão aplicados.

JSON de exemplo:

   {
  "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 aos metadados de negócios existentes

Você pode enviar uma solicitação PUT para o seguinte ponto de extremidade:

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

JSON de exemplo:

   {
  "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 de negócios

Você pode enviar uma solicitação GET para o seguinte ponto de extremidade:

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

Definir um atributo de metadados de negócios para uma entidade

Você pode enviar uma solicitação POST para o seguinte ponto de extremidade:

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

JSON de exemplo:

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

Excluir um atributo de metadados de negócios de uma entidade

Você pode enviar uma solicitação DELETE para o seguinte ponto de extremidade:

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

JSON de exemplo:

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

Excluir uma definição de tipo de metadados de negócios

Observação

Você só poderá excluir a definição de tipo de metadados empresariais se ela não tiver referências, ou seja, se ela não tiver sido atribuída a nenhum ativo no catálogo.

Você pode enviar uma solicitação DELETE para o seguinte ponto de extremidade:

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

APIs de atributo personalizado

Atributos personalizados são pares de chave/valor que podem ser adicionados diretamente a uma entidade do Atlas.

Definir um atributo personalizado como uma entidade

Você pode enviar uma solicitação POST para o seguinte ponto de extremidade:

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

JSON de exemplo:

{
    "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 rótulo

Rótulos são marcas de texto gratuitas que podem ser aplicadas a qualquer entidade do Atlas.

Definir rótulos como uma entidade

Você pode enviar uma solicitação POST para o seguinte ponto de extremidade:

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

JSON de exemplo:

[
  "label1",
  "label2"
]

Excluir rótulos para uma entidade

Você pode enviar uma solicitação DELETE para o seguinte ponto de extremidade:

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

JSON de exemplo:

[
  "label2"
]

Próximas etapas

GerenciarAPIs REST do plano de dados do Microsoft Purview