Tutorial: Neue Atlas 2.2-Funktionalität

In diesem Tutorial erfahren Sie, wie Sie programmgesteuert mit neuen Atlas 2.2-APIs mit der Datenzuordnung in Microsoft Purview interagieren.

Voraussetzungen

• Wenn Sie nicht über ein Azure-Abonnement verfügen, erstellen Sie ein kostenloses Konto , bevor Sie beginnen.

• Sie müssen über ein vorhandenes Microsoft Purview-Konto verfügen. Wenn Sie über keinen Katalog verfügen, lesen Sie den Schnellstart zum Erstellen eines Microsoft Purview-Kontos.

• Informationen zum Einrichten eines Bearertokens und zum Aufrufen beliebiger APIs finden Sie in der Dokumentation zum Authentifizieren von APIs für Microsoft Purview.

Geschäftsmetadaten-APIs

Geschäftsmetadaten sind eine Vorlage, die benutzerdefinierte Attribute (Schlüsselwerte) enthält. Sie können diese Attribute global erstellen und dann auf mehrere Typedefs anwenden.

Atlas-Endpunkt

Für alle Anforderungen benötigen Sie den Atlas-Endpunkt für Ihr Microsoft Purview-Konto.

1. Suchen Sie Ihr Microsoft Purview-Konto im Azure-Portal
2. Wählen Sie im Menü auf der linken Seite die Seite Eigenschaften aus.
3. Kopieren des Atlas-Endpunktwerts

Erstellen von Geschäftsmetadaten mit Attributen

Sie können eine POST Anforderung an den folgenden Endpunkt senden:

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

Tipp

Die applicableEntityTypes-Eigenschaft gibt an, auf welche Datentypen die Metadaten angewendet werden.

JSON-Beispiel:

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

Hinzufügen oder Aktualisieren eines Attributs zu vorhandenen Geschäftsmetadaten

Sie können eine PUT Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

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

Abrufen einer Unternehmensmetadatendefinition

Sie können eine GET Anforderung an den folgenden Endpunkt senden:

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

Festlegen eines Geschäftsmetadaten-Attributs auf eine Entität

Sie können eine POST Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

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

Löschen eines Geschäftsmetadatenattributes aus einer Entität

Sie können eine DELETE Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

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

Löschen einer Unternehmensmetadatentypdefinition

Hinweis

Sie können die Definition des Unternehmensmetadatentyps nur löschen, wenn sie keine Verweise aufweist, d. h., wenn sie keinem Objekt im Katalog zugewiesen wurde.

Sie können eine DELETE Anforderung an den folgenden Endpunkt senden:

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

APIs für benutzerdefinierte Attribute

Benutzerdefinierte Attribute sind Schlüssel-Wert-Paare, die einer Atlas-Entität direkt hinzugefügt werden können.

Festlegen eines benutzerdefinierten Attributs auf eine Entität

Sie können eine POST Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

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

Bezeichnungs-APIs

Bezeichnungen sind Freitexttags, die auf jede Atlas-Entität angewendet werden können.

Festlegen von Bezeichnungen auf eine Entität

Sie können eine POST Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

[
  "label1",
  "label2"
]

Löschen von Bezeichnungen für eine Entität

Sie können eine DELETE Anforderung an den folgenden Endpunkt senden:

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

JSON-Beispiel:

[
  "label2"
]

Nächste Schritte

Verwalten von MicrosoftPurview-DATENebenen-REST-APIs für Datenquellen