Udostępnij za pośrednictwem

Biblioteka klienta usługi Azure Automanage dla języka JavaScript — wersja 1.0.2

  • Artykuł

Ten pakiet zawiera zestaw SDK izomorficzny (uruchamiany zarówno w Node.js, jak i w przeglądarkach) dla klienta usługi Azure Automanage.

Automatyczne zarządzanie klientem

Kod | źródłowy Pakiet (NPM) | Dokumentacja referencyjna interfejsu | API Próbki

Wprowadzenie

Obecnie obsługiwane środowiska

Aby uzyskać więcej informacji, zobacz nasze zasady pomocy technicznej .

Wymagania wstępne

Instalowanie pakietu @azure/arm-automanage

Zainstaluj bibliotekę klienta usługi Azure Automanage dla języka JavaScript za pomocą polecenia npm:

npm install @azure/arm-automanage

Tworzenie i uwierzytelnianie AutomanageClient

Aby utworzyć obiekt klienta w celu uzyskania dostępu do interfejsu API rozwiązania Azure Automanage, potrzebny endpoint będzie zasób usługi Azure Automanage i element credential. Klient usługi Azure Automanage może używać poświadczeń usługi Azure Active Directory do uwierzytelniania. Punkt końcowy zasobu usługi Azure Automanage można znaleźć w witrynie Azure Portal.

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi AAD.

Aby użyć podanego poniżej dostawcy DefaultAzureCredential lub innych dostawców poświadczeń dostarczanych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Musisz również zarejestrować nową aplikację usługi AAD i udzielić dostępu do usługi Azure Automanage , przypisując odpowiednią rolę do jednostki usługi (uwaga: role, takie jak "Owner" nie będą udzielać niezbędnych uprawnień). Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i klucza tajnego klienta aplikacji usługi AAD jako zmienne środowiskowe: AZURE_CLIENT_ID, , AZURE_CLIENT_SECRETAZURE_TENANT_ID.

Aby uzyskać więcej informacji na temat tworzenia aplikacji Azure AD, zapoznaj się z tym przewodnikiem.

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);

Przykłady

Tworzenie lub aktualizowanie profilu konfiguracji

Aby zaktualizować plik, po prostu zastąp dowolne wartości we właściwościach i ponownie uruchom funkcję createOrUpdate().

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);

Usuwanie profilu konfiguracji

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

Tworzenie najlepszych rozwiązań — przypisywanie profilu produkcyjnego

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

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

Tworzenie niestandardowego przypisania profilu

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

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć narzędzia bundler. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów.

Kluczowe pojęcia

AutomanageClient

AutomanageClient jest podstawowym interfejsem dla deweloperów korzystających z biblioteki klienta usługi Azure Automanage. Zapoznaj się z metodami w tym obiekcie klienta, aby poznać różne funkcje usługi Azure Automanage, do których można uzyskać dostęp.

Rozwiązywanie problemów

Rejestrowanie

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną AZURE_LOG_LEVEL środowiskową na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel polecenie w pliku @azure/logger:

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

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.

Następne kroki

Zapoznaj się z katalogiem samples , aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.

Współtworzenie

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

Wrażenia