VirtualMachineExtension interface

描述虛擬機擴充功能。

Extends

屬性

autoUpgradeMinorVersion

指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。

enableAutomaticUpgrade

指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。

forceUpdateTag

即使延伸模組組態尚未變更,延伸模組處理程式也應該強制更新。

instanceView

虛擬機擴充實例檢視。

protectedSettings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。

protectedSettingsFromKeyVault

以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用

provisionAfterExtensions

必須布建此延伸模組之後的延伸模組名稱集合。

provisioningState

只出現在回應中的布建狀態。

publisher

擴充處理程序發行者的名稱。

settings

擴充功能的 Json 格式化公用設定。

suppressFailures

指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。

typeHandlerVersion

指定腳本處理器的主次版本。 客戶只能指定擴充功能的 Major.Minor 版本,Azure 平台將提供 Major.Minor 系列中最新的 Patch.Hotfix 版本。

typePropertiesType

指定延伸模組的類型;例如“CustomScriptExtension”。

繼承的屬性

id

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

資源所在的地理位置

name

資源名稱

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

資源標籤。

type

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

屬性詳細資料

autoUpgradeMinorVersion

指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。

autoUpgradeMinorVersion?: boolean

屬性值

boolean

enableAutomaticUpgrade

指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。

enableAutomaticUpgrade?: boolean

屬性值

boolean

forceUpdateTag

即使延伸模組組態尚未變更,延伸模組處理程式也應該強制更新。

forceUpdateTag?: string

屬性值

string

instanceView

虛擬機擴充實例檢視。

instanceView?: VirtualMachineExtensionInstanceView

屬性值

protectedSettings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。

protectedSettings?: any

屬性值

any

protectedSettingsFromKeyVault

以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用

protectedSettingsFromKeyVault?: KeyVaultSecretReference

屬性值

provisionAfterExtensions

必須布建此延伸模組之後的延伸模組名稱集合。

provisionAfterExtensions?: string[]

屬性值

string[]

provisioningState

只出現在回應中的布建狀態。

provisioningState?: string

屬性值

string

publisher

擴充處理程序發行者的名稱。

publisher?: string

屬性值

string

settings

擴充功能的 Json 格式化公用設定。

settings?: any

屬性值

any

suppressFailures

指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。

suppressFailures?: boolean

屬性值

boolean

typeHandlerVersion

指定腳本處理器的主次版本。 客戶只能指定擴充功能的 Major.Minor 版本,Azure 平台將提供 Major.Minor 系列中最新的 Patch.Hotfix 版本。

typeHandlerVersion?: string

屬性值

string

typePropertiesType

指定延伸模組的類型;例如“CustomScriptExtension”。

typePropertiesType?: string

屬性值

string

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

屬性值

string

繼承自TrackedResource.id

location

資源所在的地理位置

location: string

屬性值

string

繼承自TrackedResource.location

name

資源名稱

name?: string

屬性值

string

繼承自 TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

systemData?: SystemData

屬性值

繼承自TrackedResource.systemData

tags

資源標籤。

tags?: Record<string, string>

屬性值

Record<string, string>

繼承自TrackedResource.tags

type

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

type?: string

屬性值

string

繼承自TrackedResource.type