Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2021-07-01

Bicep リソース定義

virtualMachineScaleSets/virtualMachines/extensions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-07-01' = {
  name: '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()
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: virtualMachines
properties 仮想マシン拡張機能のプロパティについて説明します。 VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 string
instanceView 仮想マシン拡張機能インスタンス ビュー。 VirtualMachineExtensionInstanceView
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 Bicep の場合は、 any() 関数を使用できます。
publisher 拡張ハンドラーの発行元の名前。 string
settings 拡張機能の Json 形式のパブリック設定。 Bicep の場合は、 any() 関数を使用できます。
suppressFailures 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 [bool]
拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineExtensionInstanceView

名前 説明
name 仮想マシンの拡張機能名。 string
statuses リソースの状態情報。 InstanceViewStatus[]
substatuses リソースの状態情報。 InstanceViewStatus[]
拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

InstanceViewStatus

名前 説明
code ステータス コード。 string
displayStatus 状態の短いローカライズ可能なラベル。 string
レベル レベル コード。 'Error'
'Info'
'警告'
message アラートとエラー メッセージを含む詳細なステータス メッセージ。 string
time 状態の時刻。 string

ARM テンプレート リソース定義

virtualMachineScaleSets/virtualMachines/extensions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2021-07-01",
  "name": "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": {},
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

名前 説明
type リソースの種類 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions'
apiVersion リソース API のバージョン '2021-07-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
properties 仮想マシン拡張機能のプロパティについて説明します。 VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 string
instanceView 仮想マシン拡張機能インスタンス ビュー。 VirtualMachineExtensionInstanceView
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。
publisher 拡張ハンドラーの発行元の名前。 string
settings 拡張機能の Json 形式のパブリック設定。
suppressFailures 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。 [bool]
拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineExtensionInstanceView

名前 説明
name 仮想マシンの拡張機能名。 string
statuses リソースの状態情報。 InstanceViewStatus[]
substatuses リソースの状態情報。 InstanceViewStatus[]
拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

InstanceViewStatus

名前 説明
code ステータス コード。 string
displayStatus 状態の短いローカライズ可能なラベル。 string
レベル レベル コード。 'Error'
'Info'
'警告'
message アラートやエラー メッセージを含む詳細なステータス メッセージ。 string
time 状態の時刻。 string

Terraform (AzAPI プロバイダー) リソース定義

virtualMachineScaleSets/virtualMachines/extensions リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-07-01"
  name = "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"
      }
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

名前 説明
type リソースの種類 "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-07-01"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: virtualMachines
properties 仮想マシン拡張機能のプロパティについて説明します。 VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 使用可能な拡張機能の新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。 string
instanceView 仮想マシン拡張機能インスタンス ビュー。 VirtualMachineExtensionInstanceView
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。
publisher 拡張ハンドラーパブリッシャーの名前。 string
settings 拡張機能の Json 形式のパブリック設定。
suppressFailures 拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの運用エラーは、この値に関係なく抑制されません)。 既定値は false です。 [bool]
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineExtensionInstanceView

名前 説明
name 仮想マシン拡張機能の名前。 string
statuses リソースの状態情報。 InstanceViewStatus[]
substatuses リソースの状態情報。 InstanceViewStatus[]
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

InstanceViewStatus

名前 説明
code ステータス コード。 string
displayStatus 状態の短いローカライズ可能なラベル。 string
レベル レベル コード。 "エラー"
"Info"
"Warning"
message アラートやエラー メッセージを含む詳細なステータス メッセージ。 string
time 状態の時刻。 string