Share via

Azure Automanage-Clientbibliothek für JavaScript– Version 1.0.2

  • Artikel

Dieses Paket enthält ein isomorphes SDK (wird sowohl in Node.js als auch in Browsern ausgeführt) für den Azure Automanage-Client.

Automanage-Client

Quellcode | Paket (NPM) | API-Referenzdokumentation | Proben

Erste Schritte

Die derzeitig unterstützten Umgebungen

Ausführlichere Informationen finden Sie in der Supportrichtlinie.

Voraussetzungen

Installieren Sie das Paket @azure/arm-automanage.

Installieren Sie die Azure Automanage-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-automanage

Erstellen und Authentifizieren eines AutomanageClient

Um ein Clientobjekt für den Zugriff auf die Azure Automanage-API zu erstellen, benötigen Sie die endpoint ihrer Azure Automanage-Ressource und eine credential. Der Azure Automanage-Client kann Azure Active Directory-Anmeldeinformationen für die Authentifizierung verwenden. Den Endpunkt für Ihre Azure Automanage-Ressource finden Sie im Azure-Portal.

Sie können sich mit Azure Active Directory mithilfe von Anmeldeinformationen aus der @azure-/Identitätsbibliothek oder einem vorhandenen AAD-Token authentifizieren.

Um den unten gezeigten DefaultAzureCredential-Anbieter oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie das @azure/identity Paket:

npm install @azure/identity

Sie müssen auch eine neue AAD-Anwendung registrieren und Zugriff auf Azure Automanage gewähren , indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner" erteilen nicht die erforderlichen Berechtigungen). Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie in diesem Leitfaden.

const { AutomanageClient } = require("@azure/arm-automanage");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AutomanageClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AutomanageClient(credential, subscriptionId);

Beispiele

Erstellen oder Aktualisieren des Konfigurationsprofils

Um eine Datei zu aktualisieren, ersetzen Sie einfach einen der Werte in den Eigenschaften , und führen Sie die Funktion createOrUpdate() erneut aus.

const newProfile = {
    "location": "eastus",
    "tags": {
        "environment": "prod"
    },
    "properties": {
        "configuration": {
            "Antimalware/Enable": true,
            "Antimalware/EnableRealTimeProtection": true,
            "Antimalware/RunScheduledScan": true,
            "Antimalware/ScanType": "Quick",
            "Antimalware/ScanDay": 7,
            "Antimalware/ScanTimeInMinutes": 120,
            "Backup/Enable": true,
            "Backup/PolicyName": "dailyBackupPolicy",
            "Backup/TimeZone": "UTC",
            "Backup/InstantRpRetentionRangeInDays": 2,
            "Backup/SchedulePolicy/ScheduleRunFrequency": "Daily",
            "Backup/SchedulePolicy/SchedulePolicyType": "SimpleSchedulePolicy",
            "Backup/RetentionPolicy/RetentionPolicyType": "LongTermRetentionPolicy",
            "Backup/RetentionPolicy/DailySchedule/RetentionDuration/Count": 180,
            "Backup/RetentionPolicy/DailySchedule/RetentionDuration/DurationType": "Days",
            "WindowsAdminCenter/Enable": false,
            "VMInsights/Enable": true,
            "AzureSecurityCenter/Enable": true,
            "UpdateManagement/Enable": true,
            "ChangeTrackingAndInventory/Enable": true,
            "GuestConfiguration/Enable": true,
            "AutomationAccount/Enable": true,
            "LogAnalytics/Enable": true,
            "BootDiagnostics/Enable": true
        }
    }
}

await client.configurationProfiles.createOrUpdate("configurationProfileName", "resourceGroupName", newProfile);

Löschen des Konfigurationsprofils

await client.configurationProfiles.delete("resourceGroupName", "configurationProfileName");

Erstellen von Bewährten Methoden für die Zuweisung von Produktionsprofilen

let assignment = {
    "properties": {
        "configurationProfile": "/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction"
    }
}

await client.configurationProfileAssignments.createOrUpdate("default", "resourceGroupName", "vmName", assignment);

Erstellen einer benutzerdefinierten Profilzuweisung

let assignment = {
    "properties": {
        "configurationProfile": "/subscriptions/<subscription ID>/resourceGroups/resourceGroupName/providers/Microsoft.Automanage/configurationProfiles/configurationProfileName"
    }
}

await client.configurationProfileAssignments.createOrUpdate("default", "resourceGroupName", "vmName", assignment);

JavaScript-Paket

Um diese Clientbibliothek im Browser verwenden zu können, müssen Sie zunächst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Begriffe

AutomanageClient

AutomanageClient ist die primäre Schnittstelle für Entwickler, die die Azure Automanage-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure Automanage-Diensts zu verstehen, auf die Sie zugreifen können.

Problembehandlung

Protokollierung

Die Aktivierung der Protokollierung kann hilfreiche Informationen über Fehler aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die Umgebungsvariable AZURE_LOG_LEVEL auf info fest. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie setLogLevel in @azure/logger aufrufen:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in der Paketdokumentation zu @azure/logger.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.

Aufrufe