Microsoft.Compute virtualMachines/extensions

Definisi sumber daya Bicep

Jenis sumber daya virtualMachines/extensions dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.Compute/virtualMachines/extensions, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Nilai properti

virtualMachines/ekstensi

Nama Deskripsi Nilai
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep.
string (diperlukan)
lokasi Lokasi sumber daya string
tag Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
induk Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk.

Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk.
Nama simbolis untuk sumber daya jenis: virtualMachines
properti Menjelaskan properti Ekstensi Komputer Virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nama Deskripsi Nilai
autoUpgradeMinorVersion Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Setelah disebarkan, bagaimanapun, ekstensi tidak akan meningkatkan versi kecil kecuali dipekerjakan kembali, bahkan jika properti ini diatur ke true. bool
enableAutomaticUpgrade Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia. bool
forceUpdateTag Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi tidak berubah. string
instanceView Tampilan instans ekstensi komputer virtual. VirtualMachineExtensionInstanceView
protectedSettings Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali. Untuk Bicep, Anda dapat menggunakan fungsi any().
protectedSettingsFromKeyVault Pengaturan ekstensi yang dilindungi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci KeyVaultSecretReference
provisionAfterExtensions Kumpulan nama ekstensi setelah ekstensi ini perlu disediakan. string[]
penerbit Nama penerbit handler ekstensi. string
pengaturan Pengaturan publik berformat Json untuk ekstensi. Untuk Bicep, Anda dapat menggunakan fungsi any().
suppressFailures Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak tersambung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false (salah). bool
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

VirtualMachineExtensionInstanceView

Nama Deskripsi Nilai
nama Nama ekstensi komputer virtual. string
status Informasi status sumber daya. InstanceViewStatus[]
substatus Informasi status sumber daya. InstanceViewStatus[]
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

InstanceViewStatus

Nama Deskripsi Nilai
kode Kode status. string
displayStatus Label pendek yang dapat dilokalkan untuk status tersebut. string
tingkat Kode tingkat. 'Kesalahan'
'Info'
'Peringatan'
pesan Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan. string
waktu Waktu status. string

KeyVaultSecretReference

Nama Deskripsi Nilai
secretUrl URL yang mereferensikan rahasia dalam Key Vault. string (diperlukan)
sourceVault URL relatif dari Key Vault yang berisi rahasia. SubResource (diperlukan)

SubResource

Nama Deskripsi Nilai
id ID sumber daya string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat VM Windows dengan ekstensi Anti-Malware diaktifkan

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan perlindungan Anti-Malware
Server IIS menggunakan ekstensi DSC pada VM Windows

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan server IIS menggunakan ekstensi DSC. Perhatikan, modul konfigurasi DSC memerlukan token SAS untuk diteruskan jika Anda menggunakan Azure Storage. Untuk tautan modul DSC dari GitHub (default dalam templat ini), ini tidak diperlukan.
Ekstensi VM ESET

Sebarkan ke Azure
Membuat VM dengan ekstensi ESET
McAfee Endpoint Security (lisensi uji coba) pada Windows VM

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan versi uji coba McAfee Endpoint Security
Menyebarkan VM Ubuntu dengan ekstensi OMS

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Ubuntu dengan ekstensi OMS yang diinstal dan diorientasikan ke ruang kerja tertentu
Menyebarkan VM Windows dengan ekstensi OMS

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows dengan ekstensi OMS yang diinstal dan diorientasikan ke ruang kerja tertentu
Uji coba ekstensi Symantec Endpoint Protection pada Windows VM

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan versi uji coba Symantec Endpoint Protection
Ekstensi Skrip Kustom pada VM Ubuntu

Sebarkan ke Azure
Templat ini membuat VM Ubuntu dan menginstal ekstensi CustomScript
Ekstensi Patching OS pada VM Ubuntu

Sebarkan ke Azure
Templat ini membuat VM Ubuntu dan menginstal ekstensi OSPatching
Menyebarkan VM Windows Premium dengan diagnostik

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows Premium menggunakan beberapa opsi berbeda untuk versi Windows, menggunakan versi patch terbaru.
Menyebarkan VM Windows sederhana dengan pemantauan dan diagnostik

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows sederhana bersama dengan ekstensi diagnostik yang memungkinkan pemantauan dan diagnostik untuk VM
Menggunakan ekstensi skrip untuk menginstal Mongo DB pada VM Ubuntu

Sebarkan ke Azure
Templat ini menyebarkan Konfigurasi dan Menginstal Mongo DB pada Ubuntu Virtual Machine dalam dua skrip terpisah. Templat ini adalah contoh yang baik yang menampilkan cara mengekspresikan dependensi antara dua skrip yang berjalan pada komputer virtual yang sama. Templat ini juga menyebarkan Akun Penyimpanan, Virtual Network, alamat IP Publik, dan Antarmuka Jaringan.

Definisi sumber daya templat ARM

Jenis sumber daya virtualMachines/extensions dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.Compute/virtualMachines/extensions, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Nilai properti

virtualMachines/ekstensi

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.Compute/virtualMachines/extensions'
apiVersion Versi api sumber daya '2023-09-01'
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di templat JSON ARM.
string (diperlukan)
lokasi Lokasi sumber daya string
tag Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
properti Menjelaskan properti Ekstensi Komputer Virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nama Deskripsi Nilai
autoUpgradeMinorVersion Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Setelah disebarkan, bagaimanapun, ekstensi tidak akan meningkatkan versi kecil kecuali dipekerjakan kembali, bahkan jika properti ini diatur ke true. bool
enableAutomaticUpgrade Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia. bool
forceUpdateTag Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi tidak berubah. string
instanceView Tampilan instans ekstensi komputer virtual. VirtualMachineExtensionInstanceView
protectedSettings Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
protectedSettingsFromKeyVault Pengaturan ekstensi yang dilindungi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci KeyVaultSecretReference
provisionAfterExtensions Kumpulan nama ekstensi setelah ekstensi ini perlu disediakan. string[]
penerbit Nama penerbit handler ekstensi. string
pengaturan Pengaturan publik berformat Json untuk ekstensi.
suppressFailures Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak tersambung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false (salah). bool
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

VirtualMachineExtensionInstanceView

Nama Deskripsi Nilai
nama Nama ekstensi komputer virtual. string
status Informasi status sumber daya. InstanceViewStatus[]
substatus Informasi status sumber daya. InstanceViewStatus[]
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

InstanceViewStatus

Nama Deskripsi Nilai
kode Kode status. string
displayStatus Label pendek yang dapat dilokalkan untuk status tersebut. string
tingkat Kode tingkat. 'Kesalahan'
'Info'
'Peringatan'
pesan Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan. string
waktu Waktu status. string

KeyVaultSecretReference

Nama Deskripsi Nilai
secretUrl URL yang mereferensikan rahasia dalam Key Vault. string (diperlukan)
sourceVault URL relatif dari Key Vault yang berisi rahasia. SubResource (diperlukan)

SubResource

Nama Deskripsi Nilai
id ID sumber daya string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat VM Windows dengan ekstensi Anti-Malware diaktifkan

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan perlindungan Anti-Malware
Server IIS menggunakan ekstensi DSC pada VM Windows

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan server IIS menggunakan ekstensi DSC. Perhatikan, modul konfigurasi DSC memerlukan token SAS untuk diteruskan jika Anda menggunakan Azure Storage. Untuk tautan modul DSC dari GitHub (default dalam templat ini), ini tidak diperlukan.
Ekstensi VM ESET

Sebarkan ke Azure
Membuat VM dengan ekstensi ESET
McAfee Endpoint Security (lisensi uji coba) pada Windows VM

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan versi uji coba McAfee Endpoint Security
Menyebarkan VM Ubuntu dengan ekstensi OMS

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Ubuntu dengan ekstensi OMS yang diinstal dan diorientasikan ke ruang kerja tertentu
Menyebarkan VM Windows dengan ekstensi OMS

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows dengan ekstensi OMS yang diinstal dan diorientasikan ke ruang kerja tertentu
Uji coba ekstensi Symantec Endpoint Protection pada Windows VM

Sebarkan ke Azure
Templat ini membuat VM Windows dan menyiapkan versi uji coba Symantec Endpoint Protection
Ekstensi Skrip Kustom pada VM Ubuntu

Sebarkan ke Azure
Templat ini membuat VM Ubuntu dan menginstal ekstensi CustomScript
Ekstensi Patching OS pada VM Ubuntu

Sebarkan ke Azure
Templat ini membuat VM Ubuntu dan menginstal ekstensi OSPatching
Menyebarkan VM Windows Premium dengan diagnostik

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows Premium menggunakan beberapa opsi berbeda untuk versi Windows, menggunakan versi patch terbaru.
Menyebarkan VM Windows sederhana dengan pemantauan dan diagnostik

Sebarkan ke Azure
Templat ini memungkinkan Anda untuk menyebarkan VM Windows sederhana bersama dengan ekstensi diagnostik yang memungkinkan pemantauan dan diagnostik untuk VM
Menggunakan ekstensi skrip untuk menginstal Mongo DB pada VM Ubuntu

Sebarkan ke Azure
Templat ini menyebarkan Konfigurasi dan Menginstal Mongo DB pada Ubuntu Virtual Machine dalam dua skrip terpisah. Templat ini adalah contoh yang baik yang menampilkan cara mengekspresikan dependensi antara dua skrip yang berjalan pada komputer virtual yang sama. Templat ini juga menyebarkan Akun Penyimpanan, Virtual Network, alamat IP Publik, dan Antarmuka Jaringan.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya virtualMachines/extensions dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.Compute/virtualMachines/extensions, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Nilai properti

virtualMachines/ekstensi

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
nama Nama sumber daya string (diperlukan)
lokasi Lokasi sumber daya string
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: virtualMachines
tag Tag sumber daya Kamus nama dan nilai tag.
properti Menjelaskan properti Ekstensi Komputer Virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nama Deskripsi Nilai
autoUpgradeMinorVersion Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Setelah disebarkan, bagaimanapun, ekstensi tidak akan meningkatkan versi kecil kecuali dipekerjakan kembali, bahkan jika properti ini diatur ke true. bool
enableAutomaticUpgrade Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia. bool
forceUpdateTag Bagaimana handler ekstensi harus dipaksa untuk memperbarui meskipun konfigurasi ekstensi tidak berubah. string
instanceView Tampilan instans ekstensi komputer virtual. VirtualMachineExtensionInstanceView
protectedSettings Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
protectedSettingsFromKeyVault Pengaturan yang dilindungi ekstensi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci KeyVaultSecretReference
provisionAfterExtensions Kumpulan nama ekstensi setelah itu ekstensi ini perlu disediakan. string[]
penerbit Nama penerbit handler ekstensi. string
pengaturan Pengaturan publik berformat Json untuk ekstensi.
suppressFailures Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak terhubung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false (salah). bool
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

VirtualMachineExtensionInstanceView

Nama Deskripsi Nilai
nama Nama ekstensi komputer virtual. string
status Informasi status sumber daya. InstanceViewStatus[]
substatus Informasi status sumber daya. InstanceViewStatus[]
jenis Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". string
typeHandlerVersion Menentukan versi handler skrip. string

InstanceViewStatus

Nama Deskripsi Nilai
kode Kode status. string
displayStatus Label pendek yang dapat dilokalkan untuk status tersebut. string
tingkat Kode tingkat. "Kesalahan"
"Info"
"Peringatan"
pesan Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan. string
waktu Waktu status. string

KeyVaultSecretReference

Nama Deskripsi Nilai
secretUrl URL yang merujuk rahasia dalam Key Vault. string (diperlukan)
sourceVault URL relatif Key Vault yang berisi rahasia. SubResource (diperlukan)

SubResource

Nama Deskripsi Nilai
id ID sumber daya string