Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2023-09-01

• 最新
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Bicep 資源定義

virtualMachineScaleSets/virtualMachines/extensions 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  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'
  }
}

屬性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	價值
名字	資源名稱 請參閱如何在 Bicep 中設定子資源的名稱和類型。	字串 （必要）
位置	延伸模組的位置。	字串
父母	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型資源的符號名稱：virtualMachines
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。	針對 Bicep，您可以使用 any（） 函式。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。	針對 Bicep，您可以使用 any（） 函式。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。 默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	'Error' 'Info' 'Warning'
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串 （必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串

ARM 樣本資源定義

virtualMachineScaleSets/virtualMachines/extensions 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "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"
  }
}

屬性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	價值
類型	資源類型	'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions'
apiVersion	資源 API 版本	'2023-09-01'
名字	資源名稱 請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。	字串 （必要）
位置	延伸模組的位置。	字串
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。 默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	'Error' 'Info' 'Warning'
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串 （必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串

Terraform （AzAPI 提供者） 資源定義

virtualMachineScaleSets/virtualMachines/extensions 資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  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"
    }
  })
}

屬性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	價值
類型	資源類型	“Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01”
名字	資源名稱	字串 （必要）
位置	延伸模組的位置。	字串
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：virtualMachines
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。 默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	“Error” “Info” “Warning”
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串 （必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串