Esercitazione: Nuove funzionalità di Atlas 2.2
Questa esercitazione descrive come interagire a livello di codice con le nuove API Atlas 2.2 con la mappa dati in Microsoft Purview.
Prerequisiti
Se non si ha una sottoscrizione di Azure, creare un account gratuito prima di iniziare.
È necessario disporre di un account Microsoft Purview esistente. Se non si dispone di un catalogo, vedere la guida introduttiva per la creazione di un account Microsoft Purview.
Per stabilire un token di connessione e chiamare qualsiasi API, vedere la documentazione su come autenticare le API per Microsoft Purview.
API dei metadati aziendali
I metadati aziendali sono un modello che contiene attributi personalizzati (valori chiave). È possibile creare questi attributi a livello globale e quindi applicarli tra più typedef.
Endpoint atlas
Per tutte le richieste, è necessario l'endpoint Atlas per l'account Microsoft Purview.
- Trovare l'account Microsoft Purview nella portale di Azure
- Selezionare la pagina Proprietà nel menu a sinistra
- Copiare il valore dell'endpoint Atlas
Creare metadati aziendali con attributi
È possibile inviare una POST richiesta all'endpoint seguente:
POST {{endpoint}}/api/atlas/v2/types/typedefs
Consiglio
La proprietà applicableEntityTypes indica a quali tipi di dati verranno applicati i metadati.
JSON di esempio:
{
"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\"]"
}
}
]
}
]
}
Aggiungere o aggiornare un attributo ai metadati aziendali esistenti
È possibile inviare una PUT richiesta all'endpoint seguente:
PUT {{endpoint}}/api/atlas/v2/types/typedefs
JSON di esempio:
{
"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\"]"
}
}
]
}
]
}
Ottenere una definizione di metadati di business
È possibile inviare una GET richiesta all'endpoint seguente:
GET {endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
Impostare un attributo di metadati di business su un'entità
È possibile inviare una POST richiesta all'endpoint seguente:
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
JSON di esempio:
{
"myBizMetaData1": {
"bizAttr1": "I am myBizMetaData1.bizAttr1",
"bizAttr2": 123,
}
}
Eliminare un attributo di metadati di business da un'entità
È possibile inviare una DELETE richiesta all'endpoint seguente:
'DELETE' {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
JSON di esempio:
{
"myBizMetaData1": {
"bizAttr1": ""
}
}
Eliminare una definizione del tipo di metadati business
Nota
È possibile eliminare la definizione del tipo di metadati business solo se non contiene riferimenti, ad esempio se non è stata assegnata ad alcun asset nel catalogo.
È possibile inviare una DELETE richiesta all'endpoint seguente:
DELETE {{endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
API dell'attributo personalizzato
Gli attributi personalizzati sono coppie chiave/valore che possono essere aggiunte direttamente a un'entità Atlas.
Impostare un attributo personalizzato su un'entità
È possibile inviare una POST richiesta all'endpoint seguente:
POST {{endpoint}}/api/atlas/v2/entity
JSON di esempio:
{
"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 etichetta
Le etichette sono tag di testo libero che possono essere applicati a qualsiasi entità Atlas.
Impostare le etichette su un'entità
È possibile inviare una POST richiesta all'endpoint seguente:
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
JSON di esempio:
[
"label1",
"label2"
]
Eliminare etichette in un'entità
È possibile inviare una DELETE richiesta all'endpoint seguente:
DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
JSON di esempio:
[
"label2"
]