Konfigurieren Sie API Service Graph Connector für Azure API Management mithilfe des geführten Setups
Richten Sie geplante Importaufträge ein, um Azure API Management -Daten in Ihre CMDBabzurufen.
Vorbereitungen
- Die Store App Integration Common for CMDB (Integration Common für CMDB), die automatisch installiert wird. Siehe Gemeinsame Komponenten für CMDB-Integrationen.
- Die Store-App CMDB CI-Klassenmodelle, die automatisch installiert wird. Weitere Informationen finden Sie unter CMDB CI-Klassenmodelle.
- Plugin „ITOM Discovery License“ (com.snc.itom.discovery.license). Sie müssen dieses Plugin aktivieren.
- ITOM-Lizenzierungs-Plugin (com.snc.itom.license). Weitere Informationen finden Sie unter Request Discovery.
- Anwendungs-ID (Client)
- Geheimer Clientschlüssel
- Verzeichnis-ID (Mandant)
- Verbindungs-URL
Erforderliche Rolle: Administrator
Prozedur
-
Stellen Sie mithilfe der Anwendungsauswahl sicher, dass der Anwendungsbereich auf die Anwendung API Service Graph Connector für Azure API Management festgelegt ist.
Weitere Informationen finden Sie unter Anwendungsauswahl.
- Navigieren zu Alle > Service Graph Connectors > Azure API-Verwaltung > Setup.
- Stellen Sie auf der Seite API Service Graph Connector für Azure API Management sicher, dass die Option Schnellstart ausgewählt ist, und wählen Sie dann Fortsetzenaus.
-
Konfigurieren Sie die Authentifizierungsanmeldeinformationen, um Anforderungen an die Anwendung Azure API Management zu senden.
- Wählen Sie auf der Seite API Service Graph Connector für Azure API Management im Abschnitt „Verbindung und Anmeldeinformationen konfigurieren“Startenaus.
-
Konfigurieren Sie die Verbindung.
- Wählen Sie die Aufgabe Anmeldeinformationen für die Azure-Authentifizierung konfigurieren aus.
- Wählen Sie Hier klicken, um die Seite „Verbindungen“ in einer separaten Browserregisterkarte zu öffnen.
- Suchen Sie nach Bearbeiten für Azure API Management-Verbindung, und wählen Sie diesen aus.
- Füllen Sie im Abschnitt „Verbindungsinformationen“ des Fensters „Verbindung bearbeiten“ die Felder aus.
Tabelle : 1. Verbindungsinformation Feld Beschreibung Verbindungsname für Azure API Management Name zur Identifizierung des Azure API Management -Verbindungsdatensatzes. Azure API Management-Verbindungist der standardmäßige Aliasname für Anmeldeinformationen. Sie können mehrere Azure API Management- Instanzen hinzufügen. Versuchen Sie jedoch nicht, den Standardverbindungsnamen zu ändern.Verbindungs-URL Basis-URL zum Herstellen einer Verbindung mit dem Service Azure API Management. Geben Sie die URL basierend auf der Region Ihrer Azure -Client-Anwendung in einem der folgenden Formate ein:- Global
https://management.azure.com - US-Regierung
htttps://management.usgovcloudapi.net - China
https://management.chinacloudapi.cn - Deutschland
https://management.microsoftazure.de/
- Global
- Füllen Sie im Abschnitt „Anmeldeinformationen“ des Fensters „Verbindung bearbeiten“ die Felder aus.
Tabelle : 2. Anmeldedaten Feld Beschreibung OAuth-Client-ID Anwendungs-ID (Client) Ihrer Azure-Clientanwendung, wie im Abschnitt „Bevor Sie beginnen“ angegeben. OAuth-Client-Geheimnis Geheimer Clientschlüssel Ihrer Clientanwendung Azure, wie im Abschnitt „Bevor Sie beginnen“ angegeben. OAuth-Token-URL Token-URL Ihrer Azure -Client-Anwendung. Geben Sie die Token-URL basierend auf der Region Ihrer Azure -Client-Anwendung in einem der folgenden Formate ein:Wo<tenantid> ist die Mandanten-ID Ihrer Client-Anwendung Azure , wie im Abschnitt „ Bevor Sie beginnen“ angegeben.api-sgc-azure-mgmt-config.html#api-sgc-azure-mgmt-config__prereq- Global
https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/token - US-Regierung
https://login.microsoftonline.us/<tenantid>/oauth2/v2.0/token - China
https://login.partner.microsoftonline.cn/<tenantid>/oauth2/v2.0/token - Deutschland
https://login.microsoftonline.de/<tenantid>/oauth2/v2.0/token
- Global
- Wählen Sie Bearbeiten und OAuth-Token abrufen aus.
- Wählen Sie Aktualisieren.
- Wenn der OAuth-Token-Flow erfolgreich abgeschlossen wurde, kehren Sie zur Seite des geführten Setups zurück, und legen Sie die Aufgabe Anmeldeinformationen für die Azure-Authentifizierung konfigurieren auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren und dann Fortfahrenauswählen.
-
Konfigurieren Sie eine Verbindung, um Azure -Ressourcen über Azure API Managementzu verwalten.
- Wählen Sie die Aufgabe Eigenschaften konfigurieren aus.
- Geben Sie in der zugehörigen Liste Service Graph-Verbindungseigenschaften die Werte für die Eigenschaften ein.
Tabelle : 3. Service Graph-Verbindungseigenschaften Eigenschaft Beschreibung CollectionPeriod (Tage) Dauer der Erfassung von API-Nutzungsdaten in Tagen. SammlungNutzungsdaten Aktivieren Sie die Nutzungsdatenerfassung, um API-Nutzungsdaten über einen angegebenen Zeitraum abzurufen. Discovery-Bereich Discovery-Bereich der Clientanwendung Azure. Verfügbare Optionen: - Verwaltungsgruppe
- Wählen Sie die Verwaltungsgruppe aus, wenn das Servicekonto ServiceNow Zugriff auf Daten innerhalb der Verwaltungsgruppe Azure hat.
- Abonnement
- Wählen Sie Abonnement aus, wenn das Servicekonto ServiceNow nur Zugriff auf Daten innerhalb des Abonnements Azure hat.
Services ausschließen Azure API Management Services, die von der Verbindung ausgeschlossen werden sollen. Trennen Sie mehrere Services durch Kommas. Alle Gateways mit Ausnahme der in der Eigenschaft ExcludeServices aufgeführten werden abgerufen.
GetNestedGroupSubscriptions Aktivieren Sie das Abrufen von Daten aus allen geschachtelten untergeordneten Abonnements, wenn die Verwaltungsgruppe als Discovery-Bereich festgelegt ist. Legen Sie die Eigenschaft auf
„false“fest, um geschachtelte untergeordnete Abonnements auszuschließen.ManagementGroupId Verwaltungsgruppen-IDs von Azure API Management Services. Trennen Sie mehrere Verwaltungsgruppen durch Kommas.
Partitionsgröße Partitionsgröße für Azure verwaltete APIs, wenn paralleles Laden aktiviert ist. Akzeptiert einen numerischen Wert größer als null. Wenn es leer gelassen wird, wird der Wert automatisch berechnet.
ResourceGroups Ressourcengruppenname von Azure API Management Services. Trennen Sie bei mehreren Ressourcengruppen deren Namen durch Kommas. Wenn Sie dieses Feld leer lassen, importieren die Datenquellen im Connector Daten aus allen verfügbaren Ressourcengruppen.
SubscriptionId Abonnement-IDs von Azure API Management Services. Trennen Sie mehrere Abonnement-IDs durch Kommas. Wenn der Discovery-Bereich auf Abonnement festgelegt ist und dieses Feld leer gelassen wird, werden alle Abonnements für den angegebenen Mandanten in den Anmeldeinformationen erkannt.
Tipp:Um einen Eigenschaftswert einzugeben, doppelklicken Sie (oder verwenden Sie die Tastenkombination), um einen Wert in die Zelle Wert für die Eigenschaft einzugeben. - Legen Sie die Aufgabe Konfigurieren Sie Eigenschaften als abgeschlossen fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren, und wählen Sie dann Weiteraus.
-
Testen Sie die Verbindung.
- Wählen Sie die Aufgabe Verbindung testen aus.
- Testen Sie die Verbindung, indem Sie den zugehörigen Link Test Connection (Verbindung testen) auswählen.
Das Testen der Verbindung kann einige Minuten dauern. Die Seite wird aktualisiert, um die Testergebnisse anzuzeigen.
- Wenn das Feld Status auf Erfolgfestgelegt ist, wählen Sie Aktualisieren.
Wenn bei einem der Tests Fehler auftreten, befolgen Sie die Vorschläge zur Korrektur.
- Setzen Sie die Aufgabe Testverbindung auf den Abschluss, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und dann Fortsetzenwählen.
- Wahlweise:
Integration mit mehreren Azure API Management -Instanzen.
- Wählen Sie auf der Seite API Service Graph Connector für Azure API Management im Abschnitt „Mehrere Instanzen hinzufügen“ Startenaus.
-
Aktivieren Sie die Erstellung von Datenquellen für die neue Azure API Management -Verbindung.
- Vergewissern Sie sich, dass Sie über Bearbeitungsberechtigungen für die Tabelle Datenquelle [sys_data_source] verfügen.
- Wählen Sie die Aufgabe Datenquellenzugriff aktualisieren aus.
- Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
- Aktivieren Sie in der zugehörigen Liste „Anwendungszugriff“ des Formulars „Datenquelle“, das auf einer anderen Registerkarte geöffnet wird, die Kontrollkästchen „ Kann erstellen“, „Kann aktualisieren“ und „Kann löschen“.
- Wählen Sie Aktualisieren.
- Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für Azure API Management aus.
- Legen Sie die Aufgabe „Datenquellenzugriff aktualisieren“ auf „Abgeschlossen“ fest, indem Sie das Kontrollkästchen „Als abgeschlossen markieren“ aktivieren, und wählen Sie dann Weiteraus.
-
Aktivieren Sie die Erstellung eines geplanten Importauftrags für die neue Verbindung Azure API Management.
- Vergewissern Sie sich, dass Sie über Bearbeitungsberechtigungen für die Tabelle „Geplanter Datenimport“ [schedule_import_set] verfügen.
- Wählen Sie die Aufgabe Zugriff für geplanten Datenimport aktualisieren aus.
- Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
- Aktivieren Sie in der zugehörigen Liste „Anwendungszugriff“ des Formulars „Geplanter Datenimport“ die Kontrollkästchen „ Kann erstellen“, „Kann aktualisieren“ und „Kann löschen“.
- Wählen Sie Aktualisieren.
- Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für Azure API Management aus.
- Legen Sie die Aufgabe „Zugriff für geplanten Datenimport aktualisieren“ auf „Abgeschlossen“ fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
-
Leeren Sie den Cache in den Tabellen „Datenquelle“ [sys_data_source] und „Geplante Datenimporte“ [schedule_import_set].
- Wählen Sie die Aufgabe Cache für Datenquellen und geplante Datenimporte leeren aus.
- Um den Datensatz zu bearbeiten, wählen Sie in der Anwendungsauswahl den Anwendungsbereich Global aus.
- Geben Sie im Feld Skript ausführen den folgenden Code ein:
GlideTableManager.invalidateTable("sys_data_source"); GlideCacheManager.flushTable("sys_data_source"); GlideTableManager.invalidateTable("scheduled_import_set"); GlideCacheManager.flushTable("scheduled_import_set"); GlideTableManager.invalidateTable("sys_db_object"); GlideCacheManager.flushTable("sys_db_object"); - Wählen Sie Skript ausführenaus.
- Wählen Sie in der Anwendungsauswahl den Anwendungsbereich API Service Graph Connector für Azure API Management aus.
- Legen Sie die Aufgabe Cache für Datenquellen und geplante Datenimporte leeren auf den Abschluss fest, indem Sie Als abgeschlossen markierenwählen.
-
Fügen Sie eine weitere Verbindung für die neue Instanz Azure API Management hinzu.
- Stellen Sie mithilfe der Anwendungsauswahl sicher, dass der Anwendungsbereich auf die Anwendung API Service Graph Connector für Azure API Management festgelegt ist.
- Wählen Sie die Aufgabe Weitere Verbindung hinzufügen und dann Klicken Sie hieraus.
- Wählen Sie auf der Seite „Verbindungen“, die in einer anderen Browserregisterkarte geöffnet wird, Verbindung hinzufügen.
- Füllen Sie im Fenster Verbindung herstellen die Details zu Verbindung, Anmeldeinformationen und Abonnement-ID aus.
- Wählen Sie OAuth-Token erstellen und abrufen aus.
- Schließen Sie die Seite „Verbindungen“, und kehren Sie zur Registerkarte des geführten Setups zurück.
- Setzen Sie die Aufgabe Weitere Verbindung hinzufügen auf den Abschluss, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren, und wählen Sie dann Weiteraus.
-
Fügen Sie Eigenschaften für die neue Verbindung hinzu.
- Stellen Sie mithilfe der Anwendungsauswahl sicher, dass der Anwendungsbereich auf die Anwendung API Service Graph Connector für Azure API Management festgelegt ist.
- Wählen Sie die Aufgabe Eigenschaften zu neuen Verbindungen hinzufügen aus.
- Wählen Sie in der Spalte „Name“ den Verbindungsnamen aus, den Sie in Schritt 5.eerstellt haben.
- Geben Sie in der zugehörigen Liste Service Graph-Verbindungseigenschaften die Werte für die Eigenschaften ein.
Weitere Informationen zu Eigenschaften finden Sie unter 4.c.ii.
Tipp:Um einen Eigenschaftswert einzugeben, doppelklicken Sie (oder verwenden Sie die Tastenkombination), um einen Wert in die Zelle Wert für die Eigenschaft einzugeben. - Legen Sie die Aufgabe „Eigenschaften zu neuen Verbindungen hinzufügen“ auf „Abgeschlossen“ fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
-
Testen Sie die neue Verbindung.
- Wählen Sie die Aufgabe Neue Verbindungen testen aus.
- Wählen Sie in der Spalte „Name“ den Verbindungsnamen aus, den Sie in Schritt 5.eerstellt haben.
- Testen Sie die Verbindung, indem Sie den zugehörigen Link Test Connection (Verbindung testen) auswählen.
Das Testen der Verbindung kann einige Minuten dauern. Die Seite wird aktualisiert, um die Testergebnisse anzuzeigen.
- Wenn das Feld Status auf Erfolgfestgelegt ist, wählen Sie Aktualisieren.
Wenn bei einem der Tests Fehler auftreten, befolgen Sie die Vorschläge zur Korrektur.
- Legen Sie die Aufgabe Neue Verbindungen testen auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und dann Fortfahrenwählen.
-
Konfigurieren Sie die geplante Aufgabe für den Import von Azure API Management -Daten.
- Wählen Sie im Abschnitt Geplante Importaufträge einrichten der Seite API Service Graph Connector für Azure API ManagementStarten aus.
-
Wählen Sie die geplante Aufgabe „SGA Azure API Management Services“ aus.
Wählen Sie für ein Setup mit mehreren Instanzen den geplanten Import aus, der mit der Verbindung in Schritt 5.eerstellt wurde.
-
Überprüfen Sie im Formular „Geplanter Datenimport“ die Feldwerte.
Weitere Informationen finden Sie unter Schedule a data import.
- Aktivieren Sie das Kontrollkästchen Aktiv, um die geplante Aufgabe zu aktivieren.
- Wählen Sie im Feld Ausführen die Option Regelmäßig aus, um anzugeben, wie häufig die Aufgabe ausgeführt werden soll.
- Wählen Sie Aktualisieren.
- Legen Sie die Aufgabe Geplante Importaufträge einrichten auf den Abschluss fest, indem Sie das Kontrollkästchen Als abgeschlossen markieren aktivieren und anschließend Fortfahrenwählen.
- Wählen Sie auf der Seite API Service Graph Connector für Azure API Management die Option Abschließen aus, um Ihre Änderungen zu speichern.
- Wählen Sie im Dialogfeld Setup abschließen die Option Abschließen aus, um das Setup abzuschließen.
- Wählen Sie im angezeigten Meldungsfeld Fertig aus.