Lernprogramm: Definieren von benutzerdefinierten Metadaten

In diesem Lernprogramm wird erläutert, wie Sie benutzerdefinierte Metadaten definieren, um Ihre APIs und andere Informationen im API Center zu organisieren. Sie können benutzerdefinierte und integrierte Metadaten für die Suche und Filterung verwenden und Governancestandards in Ihrer Organisation erzwingen.

Weitere Informationen zu Metadaten im Azure API Center finden Sie unter:

• Schlüsselkonzepte – Metadaten
• Verwenden von Metadaten für API-Governance

In diesem Lernprogramm erfahren Sie, wie Sie das Azure-Portal verwenden, um:

• Definieren von benutzerdefinierten Metadaten im API Center
• Anzeigen des Metadatenschemas

Voraussetzungen

• Ein API-Center in Ihrem Azure-Abonnement. Informationen zum Erstellen finden Sie in der Schnellstartanleitung: Erstellen Ihres API-Centers.

Definieren von Metadaten

Hier definieren Sie zwei benutzerdefinierte Metadatenbeispiele: Branche und öffentlich zugänglich; Wenn Sie es vorziehen, definieren Sie andere Metadaten Ihrer eigenen. Wenn Sie APIs und andere Informationen in Ihrem Bestand hinzufügen oder aktualisieren, legen Sie Werte für benutzerdefinierte und alle gängigen integrierten Metadaten fest.

Von Bedeutung

Fügen Sie keine vertraulichen, vertraulichen oder persönlichen Informationen in die Titel (Namen) von Metadaten ein, die Sie definieren. Diese Titel sind in Überwachungsprotokollen sichtbar, die von Microsoft verwendet werden, um die Funktionalität des Diensts zu verbessern. Andere Metadatendetails und -werte sind jedoch Ihre geschützten Kundendaten.

1. Melden Sie sich beim Azure-Portal an, und navigieren Sie dann zum API Center.

2. Wählen Sie im Randleistenmenü unter "Objekte" "Metadaten>+ Neue Metadaten" aus.

3. Geben Sie auf der Registerkarte "Details " Informationen zu den Metadaten ein.

   1. Geben Sie für TitelLine of business ein.

   2. Geben Sie optional unter Beschreibung eine Beschreibung ein.

   3. Wählen Sie " Vordefinierte Optionen " aus, und geben Sie Auswahlmöglichkeiten wie Marketing, Finanzen, IT, Vertrieb usw. ein. Aktivieren Sie optional die Option "Auswahl mehrerer Werte zulassen". Wählen Sie Weiteraus.

   

4. Wählen Sie auf der Registerkarte " Aufgaben " die Option "Erforderlich " für APIs aus. Wählen Sie "Optional " für Bereitstellungen und Umgebungen aus. Sie können diese Entitäten in späteren Lernprogrammen hinzufügen. Wählen Sie Weiteraus.

   

5. Überprüfen Sie auf der Registerkarte " Überprüfen+ Erstellen " die Einstellungen, und wählen Sie "Erstellen" aus.

   Die Metadaten werden der Liste auf der Metadatenseite hinzugefügt.

6. Wählen Sie +Neue Metadaten aus, um ein weiteres Beispiel hinzuzufügen.

7. Geben Sie auf der Registerkarte "Details " Informationen zu den Metadaten ein.

   1. Geben Sie für "Titel" "Öffentlich zugänglich" ein.

   2. Wählen Sie den Typ Boolean aus.

8. Wählen Sie auf der Registerkarte " Aufgaben " die Option "Erforderlich " für APIs aus. Wählen Sie "Nicht zutreffend" für Bereitstellungen und Umgebungen aus.

9. Überprüfen Sie auf der Registerkarte " Überprüfen+ Erstellen " die Einstellungen, und wählen Sie "Erstellen" aus.

   Die Metadaten werden der Liste hinzugefügt.

Metadatenschema anzeigen

Sie können das JSON-Schema für die im API Center definierten Metadaten anzeigen und herunterladen. Das Schema enthält integrierte und benutzerdefinierte Metadaten.

1. Wählen Sie im linken Menü unter VermögenswerteMetadaten>Metadatenschema anzeigen aus.

2. Wählen Sie "Metadatenschema-APIs> anzeigen" aus, um das Metadatenschema für APIs anzuzeigen, das integrierte und benutzerdefinierte Metadaten enthält. Sie können auch das metadatenschema anzeigen, das für Bereitstellungen und Umgebungen im API Center definiert ist.

   

Nächster Schritt

Fügen Sie dem Bestand im API Center APIs hinzu.

Registrieren von APIs in Ihrem API-Inventar