Virtual Machine Extensions - Create Or Update

Referensi

Service:: Compute

API Version:: 2024-03-01

Operasi untuk membuat atau memperbarui ekstensi.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-03-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmExtensionName	path	True	string	Nama ekstensi komputer virtual.
vmName	path	True	string	Nama komputer virtual tempat ekstensi harus dibuat atau diperbarui.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
location	string	Lokasi sumber daya
properties.autoUpgradeMinorVersion	boolean	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.
properties.enableAutomaticUpgrade	boolean	Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.
properties.forceUpdateTag	string	Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi tidak berubah.
properties.instanceView	VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.
properties.protectedSettings	object	Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Pengaturan ekstensi yang dilindungi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci
properties.provisionAfterExtensions	string[]	Kumpulan nama ekstensi setelah ekstensi ini perlu disediakan.
properties.publisher	string	Nama penerbit handler ekstensi.
properties.settings	object	Pengaturan publik berformat Json untuk ekstensi.
properties.suppressFailures	boolean	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).
properties.type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
properties.typeHandlerVersion	string	Menentukan versi handler skrip.
tags	object	Tag sumber daya

Respons

Nama	Jenis	Deskripsi
200 OK	VirtualMachineExtension	OK
201 Created	VirtualMachineExtension	Dibuat
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2024-03-01

{
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}

Sample Response

Status code:: 200

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}

Status code:: 201

location: https://foo.com/operationstatus

Response Body

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-03-01

{
  "location": "westus"
}

Sample Response

Status code:: 200

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

Status code:: 201

location: https://foo.com/operationstatus

Response Body

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

Definisi

Nama	Deskripsi
ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
CloudError	Respons kesalahan dari layanan Komputasi.
InnerError	Detail kesalahan dalam.
InstanceViewStatus	Status tampilan instans.
KeyVaultSecretReference	Menjelaskan referensi ke Rahasia Key Vault
StatusLevelTypes	Kode tingkat.
SubResource
VirtualMachineExtension	Menjelaskan Ekstensi Komputer Virtual.
VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.

ApiError

Kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan api.

InnerError

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Nama	Jenis	Deskripsi
code	string	Kode status.
displayStatus	string	Label pendek yang dapat dilokalkan untuk status tersebut.
level	StatusLevelTypes	Kode tingkat.
message	string	Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.
time	string	Waktu status.

KeyVaultSecretReference

Menjelaskan referensi ke Rahasia Key Vault

Nama	Jenis	Deskripsi
secretUrl	string	URL yang mereferensikan rahasia dalam Key Vault.
sourceVault	SubResource	URL relatif dari Key Vault yang berisi rahasia.

StatusLevelTypes

Kode tingkat.

Nama	Jenis	Deskripsi
Error	string
Info	string
Warning	string

SubResource

Nama	Jenis	Deskripsi
id	string	ID sumber daya

VirtualMachineExtension

Menjelaskan Ekstensi Komputer Virtual.

Nama	Jenis	Deskripsi
id	string	ID sumber daya
location	string	Lokasi sumber daya
name	string	Nama sumber daya
properties.autoUpgradeMinorVersion	boolean	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.
properties.enableAutomaticUpgrade	boolean	Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.
properties.forceUpdateTag	string	Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi tidak berubah.
properties.instanceView	VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.
properties.protectedSettings	object	Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Pengaturan ekstensi yang dilindungi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci
properties.provisionAfterExtensions	string[]	Kumpulan nama ekstensi setelah ekstensi ini perlu disediakan.
properties.provisioningState	string	Status penyediaan, yang hanya muncul dalam respons.
properties.publisher	string	Nama penerbit handler ekstensi.
properties.settings	object	Pengaturan publik berformat Json untuk ekstensi.
properties.suppressFailures	boolean	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).
properties.type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
properties.typeHandlerVersion	string	Menentukan versi handler skrip.
tags	object	Tag sumber daya
type	string	Jenis Sumber Daya

VirtualMachineExtensionInstanceView

Tampilan instans ekstensi komputer virtual.

Nama	Jenis	Deskripsi
name	string	Nama ekstensi komputer virtual.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
substatuses	InstanceViewStatus[]	Informasi status sumber daya.
type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
typeHandlerVersion	string	Menentukan versi handler skrip.

Virtual Machine Extensions - Create Or Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

Sample Request

Sample Response

Definisi

ApiError

ApiErrorBase

CloudError

InnerError

InstanceViewStatus

KeyVaultSecretReference

StatusLevelTypes

SubResource

VirtualMachineExtension

VirtualMachineExtensionInstanceView

Sumber Daya Tambahan: