Ekstensi PowerShell DSC

Nota

Ekstensi DSC akan dihentikan pada 31 Maret 2028. Pindah ke Azure Machine Configuration pada tanggal tersebut. Untuk informasi selengkapnya, lihat pengumuman posting blog . Layanan Azure Machine Configuration menggabungkan fitur tertentu dari Ekstensi DSC, Konfigurasi Status Azure Automation, dan fitur yang umum diminta dari umpan balik pelanggan. Azure Machine Configuration juga menyertakan dukungan komputer hibrid melalui server yang didukung Arc.

Gambaran Umum

Ekstensi PowerShell DSC untuk Windows mengunggah dan menerapkan Konfigurasi PowerShell DSC pada komputer virtual Azure. Ekstensi DSC memanggil PowerShell DSC untuk memberlakukan konfigurasi DSC yang diterima pada komputer virtual. Dokumen ini merinci platform, konfigurasi, dan opsi penyebaran yang didukung untuk ekstensi komputer virtual DSC untuk Windows.

Nota

Coba bantuan VM untuk diagnostik yang lebih cepat. Kami menyarankan agar Anda menjalankan VM assist untuk Windows atau VM assist untuk Linux. Alat diagnostik berbasis skrip ini membantu Anda mengidentifikasi masalah umum yang memengaruhi Agen Tamu Azure VM dan kesehatan VM secara keseluruhan.

Jika Anda mengalami masalah performa dengan komputer virtual, sebelum menghubungi dukungan, jalankan alat-alat ini.

Prasyarat

Sistem operasi

Ekstensi DSC mendukung sistem operasi berikut

Windows Server 2022, Windows Server 2019, Windows Server 2016, Windows Server 2012R2, Windows Server 2012, Windows Server 2008 R2 SP1, Windows Client 7/8.1/10

Internet connectivity

Ekstensi DSC untuk Windows mengharuskan komputer virtual target dapat berkomunikasi dengan Azure dan lokasi paket konfigurasi (file.zip) jika disimpan di luar Azure.

Skema ekstensi

JSON berikut menunjukkan skema untuk bagian pengaturan Ekstensi DSC dalam templat Azure Resource Manager.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "Microsoft.Powershell.DSC",
  "apiVersion": "2018-10-01",
  "location": "<location>",
  "properties": {
    "publisher": "Microsoft.Powershell",
    "type": "DSC",
    "typeHandlerVersion": "2.77",
    "autoUpgradeMinorVersion": true,
    "settings": {
        "wmfVersion": "latest",
        "configuration": {
            "url": "http://validURLToConfigLocation",
            "script": "ConfigurationScript.ps1",
            "function": "ConfigurationFunction"
        },
        "configurationArguments": {
            "argument1": "Value1",
            "argument2": "Value2"
        },
        "configurationData": {
            "url": "https://foo.psd1"
        },
        "privacy": {
            "dataCollection": "enable"
        },
        "advancedOptions": {
            "forcePullAndApply": false,
            "downloadMappings": {
             "specificDependencyKey": "https://myCustomDependencyLocation"
            }
        }
    },
    "protectedSettings": {
        "configurationArguments": {
            "parameterOfTypePSCredential1": {
                "userName": "UsernameValue1",
                "password": "PasswordValue1"
            },
            "parameterOfTypePSCredential2": {
                "userName": "UsernameValue2",
                "password": "PasswordValue2"
            }
        },
        "configurationUrlSasToken": "?g!bber1sht0k3n",
        "configurationDataUrlSasToken": "?dataAcC355T0k3N"
    }
  }
}

Nilai properti

Nama Nilai /Contoh Jenis Data
apiVersion 2018-10-01 date
penerbit Microsoft.Powershell.DSC string
jenis DSC string
typeHandlerVersion 2.77 int

Nilai Properti Pengaturan

Nama Jenis Data Description
settings.wmfVersion string Menentukan versi Windows Management Framework yang harus diinstal pada VM Anda. Mengatur properti ini ke 'terbaru' menginstal versi WMF yang paling diperbarui. Satu-satunya nilai saat ini yang mungkin untuk properti ini adalah '4.0', '5.0', dan 'terbaru'. Nilai yang mungkin ini tunduk pada pembaruan. Nilai defaultnya adalah 'terbaru'.
settings.configuration.url string Menentukan lokasi URL tempat mengunduh file zip konfigurasi DSC Anda. Jika URL yang disediakan memerlukan token SAS untuk akses, atur properti protectedSettings.configurationUrlSasToken ke nilai token SAS Anda. Properti ini diperlukan jika settings.configuration.script dan/atau settings.configuration.function ditentukan.
settings.configuration.script string Menentukan nama file skrip yang berisi definisi konfigurasi DSC Anda. Skrip ini harus berada di folder akar file zip yang diunduh dari URL yang ditentukan oleh properti configuration.url. Properti ini diperlukan jika settings.configuration.url dan/atau settings.configuration.script ditentukan.
settings.configuration.function string Menentukan nama konfigurasi DSC Anda. Konfigurasi bernama harus terkandung dalam skrip yang ditentukan oleh configuration.script. Properti ini diperlukan jika settings.configuration.url dan/atau settings.configuration.function ditentukan.
settings.configurationArguments Collection Menentukan parameter apa pun yang ingin Anda teruskan ke konfigurasi DSC Anda. Properti ini tidak akan dienkripsi.
settings.configurationData.url string Menentukan URL tempat mengunduh file data konfigurasi Anda (.pds1) untuk digunakan sebagai input untuk konfigurasi DSC Anda. Jika URL yang disediakan memerlukan token SAS untuk akses, atur properti protectedSettings.configurationDataUrlSasToken ke nilai token SAS Anda.
settings.privacy.dataEnabled string Mengaktifkan atau menonaktifkan koleksi telemetri. Satu-satunya nilai yang mungkin untuk properti ini adalah 'Aktifkan', 'Nonaktifkan', ", atau $null. Membiarkan properti ini kosong atau null memungkinkan telemetri
settings.advancedOptions.forcePullAndApply Bool Pengaturan ini dirancang untuk meningkatkan pengalaman bekerja dengan ekstensi untuk mendaftarkan simpul dengan Azure Automation DSC. Jika nilainya adalah $true, ekstensi menunggu eksekusi pertama konfigurasi yang ditarik dari layanan sebelum mengembalikan keberhasilan/kegagalan. Jika nilai diatur ke $false, status yang dikembalikan oleh ekstensi mengacu pada apakah simpul terdaftar dengan Konfigurasi Status Azure Automation berhasil dan konfigurasi simpul tidak akan berjalan selama pendaftaran.
settings.advancedOptions.downloadMappings Collection Menentukan lokasi alternatif untuk mengunduh dependensi seperti WMF dan .NET

Nilai Properti Pengaturan terproteksi

Nama Jenis Data Description
protectedSettings.configurationArguments string Menentukan parameter apa pun yang ingin Anda teruskan ke konfigurasi DSC Anda.
protectedSettings.configurationUrlSasToken string Menentukan token SAS untuk mengakses URL yang ditentukan oleh configuration.url.
protectedSettings.configurationDataUrlSasToken string Menentukan token SAS untuk mengakses URL yang ditentukan oleh configurationData.url.

Penyebaran templat

Ekstensi Azure VM dapat disebarkan dengan templat Azure Resource Manager. Templat sangat ideal saat menyebarkan satu atau beberapa komputer virtual yang memerlukan konfigurasi pasca penyebaran. Contoh templat Resource Manager yang menyertakan ekstensi DSC untuk Windows dapat ditemukan di Galeri Mulai Cepat Azure.

Pemecahan masalah dan dukungan

Troubleshoot

Data tentang status penyebaran ekstensi dapat diambil dari portal Microsoft Azure, dan dengan menggunakan Azure CLI. Untuk melihat status penyebaran ekstensi untuk VM tertentu, jalankan perintah berikut menggunakan Azure CLI.

az vm extension list --resource-group myResourceGroup --vm-name myVM -o table

Paket ekstensi diunduh dan disebarkan ke lokasi ini di Azure VM

C:\Packages\Plugins\{Extension_Name}\{Extension_Version}

File status ekstensi berisi sub status dan kode keberhasilan/kesalahan status bersama dengan kesalahan dan deskripsi terperinci untuk setiap ekstensi yang dijalankan.

C:\Packages\Plugins\{Extension_Name}\{Extension_Version}\Status\{0}.Status  -> {0} being the sequence number

Log output ekstensi dicatat ke direktori berikut:

C:\WindowsAzure\Logs\Plugins\{Extension_Name}\{Extension_Version}

Kode kesalahan dan artinya

Kode Kesalahan Meaning Kemungkinan Tindakan
1000 Kesalahan umum Pesan untuk kesalahan ini disediakan oleh pengecualian tertentu dalam log ekstensi
52 Kesalahan Penginstalan Ekstensi Pesan untuk kesalahan ini disediakan oleh pengecualian tertentu
1002 Kesalahan Penginstalan Wmf Kesalahan saat menginstal WMF.
1004 Paket Zip Tidak Valid Zip tidak valid; Kesalahan saat membuka kemasan zip
1100 Kesalahan Argumen Menunjukkan masalah dalam input yang disediakan oleh pengguna. Pesan untuk kesalahan disediakan oleh pengecualian tertentu

Support

Jika Anda memerlukan bantuan lebih lanjut kapan saja dalam artikel ini, Anda dapat menghubungi pakar Azure di forum MSDN Azure dan Stack Overflow. Atau, Anda dapat mengajukan insiden dukungan Azure. Buka situs dukungan Azure dan pilih Dapatkan dukungan. Untuk informasi tentang menggunakan Dukungan Azure, baca Tanya Jawab Umum dukungan Microsoft Azure.