Freigeben über

Tutorial: Definieren von benutzerdefinierten Metadaten

  • Artikel

Definieren Sie in diesem Tutorial benutzerdefinierte Metadaten, um Ihre APIs und andere Informationen im API Center zu organisieren. Verwenden Sie benutzerdefinierte und integrierte Metadaten für die Suche und Filterung und zum Erzwingen von Governancestandards in Ihrer Organisation.

Hintergrundinformationen zu Metadaten im Azure API Center finden Sie unter:

In diesem Tutorial erfahren Sie, wie Sie das Portal für Folgendes verwenden:

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

Voraussetzungen

Definieren von Metadaten

Hier definieren Sie zwei benutzerdefinierte Metadatenbeispiele: Branchen- und öffentlich zugängliche Metadaten. Wenn Sie es bevorzugen, können Sie andere eigene Metadaten definieren. Wenn Sie APIs und andere Informationen in Ihrem Bestand hinzufügen oder aktualisieren, legen Sie Werte für diese benutzerdefinierte und alle gängigen integrierten Metadaten fest.

Wichtig

Nehmen Sie keine sensiblen, vertraulichen oder persönlichen Informationen in die Titel (Namen) der Metadaten auf, 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. Navigieren Sie im Azure-Portal zu Ihrem API Center.

  2. Wählen Sie im linken Menü unter Objekte Metadaten> + Neue Metadaten aus.

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

    1. Geben Sie unter TitelBranche ein.

    2. Geben Sie optional unter Beschreibung eine Beschreibung ein.

    3. Wählen Sie den Typ Vordefinierte Optionen aus, und geben Sie Optionen wie Marketing, Finanzen, IT, Vertrieb usw. ein. Aktivieren Sie optional Die Auswahl mehrerer Werte zulassen. Wählen Sie Weiter aus.

    Screenshot des Hinzufügens von benutzerdefinierten Metadaten im Portal.

  4. Wählen Sie auf der Registerkarte Zuweisungen für APIs die Option erforderlich aus. Wählen Sie Optional für Bereitstellungen und Umgebungen aus. (Sie fügen diese Entitäten in späteren Tutorials hinzu.) Wählen Sie Weiter aus.

    Screenshot der Metadatenzuweisungen im Portal.

  5. Überprüfen Sie Ihre Einstellungen auf der Registerkarte Überprüfen und erstellen, 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 unter Titel den Namen Öffentlich ein.

    2. Wählen Sie den Typ Boolesch aus.

  8. Wählen Sie auf der Registerkarte Zuweisungen für APIs die Option erforderlich aus. Wählen Sie Nicht anwendbar für Bereitstellungen und Umgebungen aus.

  9. Überprüfen Sie Ihre Einstellungen auf der Registerkarte Überprüfen und erstellen, und wählen Sie Erstellen aus.

    Die Metadaten werden der Liste hinzugefügt.

Metadatenschema anzeigen

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

  1. Wählen Sie im linken Menü unter Objekte Metadaten > Metadatenschema anzeigen aus.

  2. Wählen Sie Metadatenschema anzeigen > APIs 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.

    Screenshot des Metadatenschemas im Portal

Nächste Schritte

In diesem Tutorial haben Sie erfahren, wie Sie das Portal für Folgendes verwenden:

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

Nachdem Sie ihr Metadatenschema vorbereitet haben, fügen Sie dem Bestand im API-Center APIs hinzu.

Registrieren von APIs in Ihrem API-Inventar