Microsoft.GuestConfiguration guestConfigurationAssignments 2018-11-20

Definisi sumber daya Bicep

Jenis sumber daya guestConfigurationAssignments adalah sumber daya ekstensi, yang berarti Anda dapat menerapkannya ke sumber daya lain.

scope Gunakan properti pada sumber daya ini untuk mengatur cakupan untuk sumber daya ini. Lihat Mengatur cakupan pada sumber daya ekstensi di Bicep.

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

Format sumber daya

Untuk membuat sumber daya Microsoft.GuestConfiguration/guestConfigurationAssignments, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationSetting: {
        actionAfterReboot: 'string'
        allowModuleOverwrite: bool
        configurationMode: 'string'
        configurationModeFrequencyMins: int
        rebootIfNeeded: bool
        refreshFrequencyMins: int
      }
      contentHash: 'string'
      contentUri: 'string'
      kind: 'DSC'
      name: 'string'
      version: 'string'
    }
    vmssVMList: [
      {
      }
    ]
  }
}

Nilai properti

guestConfigurationAssignments

Nama Deskripsi Nilai
nama Nama sumber daya string (diperlukan)
lokasi Wilayah tempat VM berada. string
scope Gunakan saat membuat sumber daya ekstensi pada cakupan yang berbeda dari cakupan penyebaran. Sumber daya target

Untuk Bicep, atur properti ini ke nama simbolis sumber daya untuk menerapkan sumber daya ekstensi.
properti Properti penetapan konfigurasi Tamu. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nama Deskripsi Nilai
konteks Sumber yang memulai penetapan konfigurasi tamu. Misalnya: Azure Policy string
guestConfiguration Konfigurasi tamu yang akan ditetapkan. GuestConfigurationNavigation
vmssVMList Daftar data Kepatuhan VM untuk VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nama Deskripsi Nilai
assignmentType Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Audit'
'DeployAndAutoCorrect'
configurationParameter Parameter konfigurasi untuk konfigurasi tamu. ConfigurationParameter[]
configurationProtectedParameter Parameter konfigurasi yang dilindungi untuk konfigurasi tamu. ConfigurationParameter[]
configurationSetting Pengaturan konfigurasi untuk konfigurasi tamu. ConfigurationSetting
contentHash Hash gabungan dari paket konfigurasi tamu dan parameter konfigurasi. string
contentUri Uri penyimpanan tempat paket konfigurasi tamu diunggah. string
jenis Jenis konfigurasi tamu. Misalnya:DSC 'DSC'
nama Nama konfigurasi tamu. string
versi Versi konfigurasi tamu. string

ConfigurationParameter

Nama Deskripsi Nilai
name Nama parameter konfigurasi. string
nilai Nilai parameter konfigurasi. string

ConfigurationSetting

Nama Deskripsi Nilai
actionAfterReboot Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration 'LanjutkanKonfigurasi'
'StopConfiguration'
allowModuleOverwrite Jika true - konfigurasi baru yang diunduh dari layanan penarikan diizinkan untuk menimpa yang lama pada simpul target. Jika tidak, false bool
configurationMode Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Seberapa sering, dalam hitungan menit, konfigurasi saat ini diperiksa dan diterapkan. Properti ini diabaikan jika properti ConfigurationMode diatur ke ApplyOnly. Nilai default-nya adalah 15. int
rebootIfNeeded Atur ini ke true untuk me-reboot simpul secara otomatis setelah konfigurasi yang memerlukan reboot diterapkan. Jika tidak, Anda harus me-reboot simpul secara manual untuk konfigurasi apa pun yang memerlukannya. Nilai defaultnya adalah false. Untuk menggunakan pengaturan ini ketika kondisi reboot diberlakukan oleh sesuatu selain DSC (seperti Pemasang Windows), gabungkan pengaturan ini dengan modul xPendingReboot. bool
refreshFrequencyMins Interval waktu, dalam hitungan menit, di mana LCM memeriksa layanan penarikan untuk mendapatkan konfigurasi yang diperbarui. Nilai ini diabaikan jika LCM tidak dikonfigurasi dalam mode penarikan. Nilai default adalah 30. int

VmssvmInfo

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Windows VM dengan garis besar aman Azure

Sebarkan ke Azure
Templat membuat komputer virtual yang menjalankan Windows Server di jaringan virtual baru, dengan alamat IP publik. Setelah komputer disebarkan, ekstensi konfigurasi tamu diinstal dan garis besar aman Azure untuk Windows Server diterapkan. Jika konfigurasi komputer menyimpang, Anda dapat menerapkan kembali pengaturan dengan menyebarkan templat lagi.

Definisi sumber daya templat ARM

Jenis sumber daya guestConfigurationAssignments adalah sumber daya ekstensi, yang berarti Anda dapat menerapkannya ke sumber daya lain.

Gunakan properti pada scope sumber daya ini untuk mengatur cakupan untuk sumber daya ini. Lihat Mengatur cakupan pada sumber daya ekstensi di templat ARM.

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

Format sumber daya

Untuk membuat sumber daya Microsoft.GuestConfiguration/guestConfigurationAssignments, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2018-11-20",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationSetting": {
        "actionAfterReboot": "string",
        "allowModuleOverwrite": "bool",
        "configurationMode": "string",
        "configurationModeFrequencyMins": "int",
        "rebootIfNeeded": "bool",
        "refreshFrequencyMins": "int"
      },
      "contentHash": "string",
      "contentUri": "string",
      "kind": "DSC",
      "name": "string",
      "version": "string"
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Nilai properti

guestConfigurationAssignments

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion Versi api sumber daya '2018-11-20'
nama Nama sumber daya string (diperlukan)
lokasi Wilayah tempat VM berada. string
scope Gunakan saat membuat sumber daya ekstensi pada cakupan yang berbeda dari cakupan penyebaran. Sumber daya target

Untuk JSON, atur nilai ke nama lengkap sumber daya untuk menerapkan sumber daya ekstensi .
properti Properti penetapan konfigurasi Tamu. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nama Deskripsi Nilai
konteks Sumber yang memulai penetapan konfigurasi tamu. Misalnya: Azure Policy string
guestConfiguration Konfigurasi tamu yang akan ditetapkan. GuestConfigurationNavigation
vmssVMList Daftar data Kepatuhan VM untuk VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nama Deskripsi Nilai
assignmentType Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Audit'
'DeployAndAutoCorrect'
configurationParameter Parameter konfigurasi untuk konfigurasi tamu. ConfigurationParameter[]
configurationProtectedParameter Parameter konfigurasi yang dilindungi untuk konfigurasi tamu. ConfigurationParameter[]
configurationSetting Pengaturan konfigurasi untuk konfigurasi tamu. ConfigurationSetting
contentHash Hash gabungan dari paket konfigurasi tamu dan parameter konfigurasi. string
contentUri Uri penyimpanan tempat paket konfigurasi tamu diunggah. string
jenis Jenis konfigurasi tamu. Misalnya:DSC 'DSC'
nama Nama konfigurasi tamu. string
versi Versi konfigurasi tamu. string

ConfigurationParameter

Nama Deskripsi Nilai
nama Nama parameter konfigurasi. string
nilai Nilai parameter konfigurasi. string

ConfigurationSetting

Nama Deskripsi Nilai
actionAfterReboot Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration 'LanjutkanKonfigurasi'
'StopConfiguration'
allowModuleOverwrite Jika true - konfigurasi baru yang diunduh dari layanan penarikan diizinkan untuk menimpa yang lama pada simpul target. Jika tidak, false bool
configurationMode Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Seberapa sering, dalam hitungan menit, konfigurasi saat ini diperiksa dan diterapkan. Properti ini diabaikan jika properti ConfigurationMode diatur ke ApplyOnly. Nilai default-nya adalah 15. int
rebootIfNeeded Atur ini ke true untuk me-reboot simpul secara otomatis setelah konfigurasi yang memerlukan reboot diterapkan. Jika tidak, Anda harus me-reboot simpul secara manual untuk konfigurasi apa pun yang memerlukannya. Nilai defaultnya adalah false. Untuk menggunakan pengaturan ini ketika kondisi reboot diberlakukan oleh sesuatu selain DSC (seperti Pemasang Windows), gabungkan pengaturan ini dengan modul xPendingReboot. bool
refreshFrequencyMins Interval waktu, dalam hitungan menit, di mana LCM memeriksa layanan penarikan untuk mendapatkan konfigurasi yang diperbarui. Nilai ini diabaikan jika LCM tidak dikonfigurasi dalam mode penarikan. Nilai default adalah 30. int

VmssvmInfo

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Windows VM dengan garis besar aman Azure

Sebarkan ke Azure
Templat membuat komputer virtual yang menjalankan Windows Server di jaringan virtual baru, dengan alamat IP publik. Setelah komputer disebarkan, ekstensi konfigurasi tamu diinstal dan garis besar aman Azure untuk Windows Server diterapkan. Jika konfigurasi komputer menyimpang, Anda dapat menerapkan kembali pengaturan dengan menyebarkan templat lagi.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya guestConfigurationAssignments adalah sumber daya ekstensi, yang berarti Anda dapat menerapkannya ke sumber daya lain.

Gunakan properti pada parent_id sumber daya ini untuk mengatur cakupan untuk sumber daya ini.

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

Format sumber daya

Untuk membuat sumber daya Microsoft.GuestConfiguration/guestConfigurationAssignments, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      context = "string"
      guestConfiguration = {
        assignmentType = "string"
        configurationParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationProtectedParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationSetting = {
          actionAfterReboot = "string"
          allowModuleOverwrite = bool
          configurationMode = "string"
          configurationModeFrequencyMins = int
          rebootIfNeeded = bool
          refreshFrequencyMins = int
        }
        contentHash = "string"
        contentUri = "string"
        kind = "DSC"
        name = "string"
        version = "string"
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Nilai properti

guestConfigurationAssignments

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20"
name Nama sumber daya string (diperlukan)
lokasi Wilayah tempat VM berada. string
parent_id ID sumber daya untuk menerapkan sumber daya ekstensi ini. string (diperlukan)
properti Properti penetapan konfigurasi Tamu. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nama Deskripsi Nilai
konteks Sumber yang memulai penetapan konfigurasi tamu. Misalnya: Azure Policy string
guestConfiguration Konfigurasi tamu yang akan ditetapkan. GuestConfigurationNavigation
vmssVMList Daftar data Kepatuhan VM untuk VMSS VmssvmInfo[]

GuestConfigurationNavigation

Nama Deskripsi Nilai
assignmentType Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Audit"
"DeployAndAutoCorrect"
configurationParameter Parameter konfigurasi untuk konfigurasi tamu. ConfigurationParameter[]
configurationProtectedParameter Parameter konfigurasi yang dilindungi untuk konfigurasi tamu. ConfigurationParameter[]
configurationSetting Pengaturan konfigurasi untuk konfigurasi tamu. ConfigurationSetting
contentHash Hash gabungan dari paket konfigurasi tamu dan parameter konfigurasi. string
contentUri Uri penyimpanan tempat paket konfigurasi tamu diunggah. string
jenis Jenis konfigurasi tamu. Misalnya:DSC "DSC"
nama Nama konfigurasi tamu. string
versi Versi konfigurasi tamu. string

ConfigurationParameter

Nama Deskripsi Nilai
name Nama parameter konfigurasi. string
nilai Nilai parameter konfigurasi. string

ConfigurationSetting

Nama Deskripsi Nilai
actionAfterReboot Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration "ContinueConfiguration"
"StopConfiguration"
allowModuleOverwrite Jika true - konfigurasi baru yang diunduh dari layanan penarikan diizinkan untuk menimpa yang lama pada simpul target. Jika tidak, false bool
configurationMode Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"ApplyOnly"
configurationModeFrequencyMins Seberapa sering, dalam hitungan menit, konfigurasi saat ini diperiksa dan diterapkan. Properti ini diabaikan jika properti ConfigurationMode diatur ke ApplyOnly. Nilai default-nya adalah 15. int
rebootIfNeeded Atur ini ke true untuk me-reboot simpul secara otomatis setelah konfigurasi yang memerlukan reboot diterapkan. Jika tidak, Anda harus me-reboot simpul secara manual untuk konfigurasi apa pun yang memerlukannya. Nilai defaultnya adalah false. Untuk menggunakan pengaturan ini ketika kondisi reboot diberlakukan oleh sesuatu selain DSC (seperti Pemasang Windows), gabungkan pengaturan ini dengan modul xPendingReboot. bool
refreshFrequencyMins Interval waktu, dalam hitungan menit, di mana LCM memeriksa layanan penarikan untuk mendapatkan konfigurasi yang diperbarui. Nilai ini diabaikan jika LCM tidak dikonfigurasi dalam mode penarikan. Nilai default adalah 30. int

VmssvmInfo

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.