Share via


Virtual Machine Extensions - Create Or Update

Uzantıyı oluşturma veya güncelleştirme işlemi.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
path True

string

Kaynak grubunun adı.

subscriptionId
path True

string

Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.

vmExtensionName
path True

string

Sanal makine uzantısının adı.

vmName
path True

string

Uzantının oluşturulması veya güncelleştirilmesi gereken sanal makinenin adı.

api-version
query True

string

İstemci Api Sürümü.

İstek Gövdesi

Name Tür Description
location

string

Kaynak konumu

properties.autoUpgradeMinorVersion

boolean

Dağıtım zamanında kullanılabilirse uzantının daha yeni bir ikincil sürüm kullanıp kullanmayacağını gösterir. Ancak dağıtıldıktan sonra, bu özellik true olarak ayarlanmış olsa bile uzantı yeniden dağıtılmadığı sürece ikincil sürümleri yükseltmez.

properties.enableAutomaticUpgrade

boolean

Kullanılabilir uzantının daha yeni bir sürümü varsa, uzantının platform tarafından otomatik olarak yükseltilip yükseltilmeyeceğini gösterir.

properties.forceUpdateTag

string

Uzantı yapılandırması değişmese bile uzantı işleyicisinin nasıl güncelleştirilmeye zorlanması gerektiği.

properties.instanceView

VirtualMachineExtensionInstanceView

Sanal makine uzantısı örneği görünümü.

properties.protectedSettings

object

Uzantı protectedSettings veya protectedSettingsFromKeyVault içerebilir veya hiçbir korumalı ayar içeremez.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Başvuru ile geçirilen ve anahtar kasasından kullanılan korumalı uzantı ayarları

properties.provisionAfterExtensions

string[]

Bu uzantının sağlanması gereken uzantı adlarının koleksiyonu.

properties.publisher

string

Uzantı işleyici yayımcısının adı.

properties.settings

object

Uzantı için Json biçimlendirilmiş genel ayarlar.

properties.suppressFailures

boolean

Uzantıdan kaynaklanan hataların gizlenip gizlenmeyeceğini gösterir (VM'ye bağlanmama gibi operasyonel hatalar bu değerden bağımsız olarak gizlenmeyecektir). Varsayılan değer false.

properties.type

string

Uzantının türünü belirtir; "CustomScriptExtension" örnek olarak verilmiştir.

properties.typeHandlerVersion

string

Betik işleyicisinin sürümünü belirtir.

tags

object

Kaynak etiketleri

Yanıtlar

Name Tür Description
200 OK

VirtualMachineExtension

Tamam

201 Created

VirtualMachineExtension

Oluşturulan

Other Status Codes

CloudError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Sample Request

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

{
  "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"
  }
}
location: https://foo.com/operationstatus
{
  "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

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

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

Tanımlar

Name Description
ApiError

Api hatası.

ApiErrorBase

Api hata tabanı.

CloudError

İşlem hizmetinden bir hata yanıtı.

InnerError

İç hata ayrıntıları.

InstanceViewStatus

Örnek görünümü durumu.

KeyVaultSecretReference

Key Vault Gizli Dizisine başvuru açıklar

StatusLevelTypes

Düzey kodu.

SubResource
VirtualMachineExtension

Bir Sanal Makine Uzantısını açıklar.

VirtualMachineExtensionInstanceView

Sanal makine uzantısının örnek görünümü.

ApiError

Api hatası.

Name Tür Description
code

string

Hata kodu.

details

ApiErrorBase[]

Api hata ayrıntıları

innererror

InnerError

Api iç hatası

message

string

Hata iletisi.

target

string

Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name Tür Description
code

string

Hata kodu.

message

string

Hata iletisi.

target

string

Belirli bir hatanın hedefi.

CloudError

İşlem hizmetinden bir hata yanıtı.

Name Tür Description
error

ApiError

Api hatası.

InnerError

İç hata ayrıntıları.

Name Tür Description
errordetail

string

İç hata iletisi veya özel durum dökümü.

exceptiontype

string

Özel durum türü.

InstanceViewStatus

Örnek görünümü durumu.

Name Tür Description
code

string

Durum kodu.

displayStatus

string

Durum için kısa yerelleştirilebilir etiket.

level

StatusLevelTypes

Düzey kodu.

message

string

Uyarılar ve hata iletileri de dahil olmak üzere ayrıntılı durum iletisi.

time

string

Durum zamanı.

KeyVaultSecretReference

Key Vault Gizli Dizisine başvuru açıklar

Name Tür Description
secretUrl

string

Key Vault gizli diziye başvuran URL.

sourceVault

SubResource

Gizli diziyi içeren Key Vault göreli URL'si.

StatusLevelTypes

Düzey kodu.

Name Tür Description
Error

string

Info

string

Warning

string

SubResource

Name Tür Description
id

string

Kaynak Kimliği

VirtualMachineExtension

Bir Sanal Makine Uzantısını açıklar.

Name Tür Description
id

string

Kaynak Kimliği

location

string

Kaynak konumu

name

string

Kaynak adı

properties.autoUpgradeMinorVersion

boolean

Dağıtım zamanında kullanılabilirse uzantının daha yeni bir ikincil sürüm kullanıp kullanmayacağını gösterir. Ancak dağıtıldıktan sonra, bu özellik true olarak ayarlanmış olsa bile uzantı yeniden dağıtılmadığı sürece ikincil sürümleri yükseltmez.

properties.enableAutomaticUpgrade

boolean

Kullanılabilir uzantının daha yeni bir sürümü varsa, uzantının platform tarafından otomatik olarak yükseltilip yükseltilmeyeceğini gösterir.

properties.forceUpdateTag

string

Uzantı yapılandırması değişmese bile uzantı işleyicisinin nasıl güncelleştirilmeye zorlanması gerektiği.

properties.instanceView

VirtualMachineExtensionInstanceView

Sanal makine uzantısı örneği görünümü.

properties.protectedSettings

object

Uzantı protectedSettings veya protectedSettingsFromKeyVault içerebilir veya hiçbir korumalı ayar içeremez.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

Başvuru ile geçirilen ve anahtar kasasından kullanılan korumalı uzantı ayarları

properties.provisionAfterExtensions

string[]

Bu uzantının sağlanması gereken uzantı adlarının koleksiyonu.

properties.provisioningState

string

Yalnızca yanıtta görünen sağlama durumu.

properties.publisher

string

Uzantı işleyici yayımcısının adı.

properties.settings

object

Uzantı için Json biçimlendirilmiş genel ayarlar.

properties.suppressFailures

boolean

Uzantıdan kaynaklanan hataların gizlenip gizlenmeyeceğini gösterir (VM'ye bağlanmama gibi operasyonel hatalar bu değerden bağımsız olarak gizlenmeyecektir). Varsayılan değer false.

properties.type

string

Uzantının türünü belirtir; "CustomScriptExtension" örnek olarak verilmiştir.

properties.typeHandlerVersion

string

Betik işleyicisinin sürümünü belirtir.

tags

object

Kaynak etiketleri

type

string

Kaynak türü

VirtualMachineExtensionInstanceView

Sanal makine uzantısının örnek görünümü.

Name Tür Description
name

string

Sanal makine uzantısı adı.

statuses

InstanceViewStatus[]

Kaynak durumu bilgileri.

substatuses

InstanceViewStatus[]

Kaynak durumu bilgileri.

type

string

Uzantının türünü belirtir; "CustomScriptExtension" örnek olarak verilmiştir.

typeHandlerVersion

string

Betik işleyicisinin sürümünü belirtir.