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

Bicep リソース定義

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-03-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()
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

名前 形容 価値
名前 リソース名

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

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

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

名前 形容 価値
コード 状態コード。
displayStatus 状態の短いローカライズ可能なラベル。
レベル レベル コード。 'Error'
'Info'
'Warning'
メッセージ アラートやエラー メッセージを含む詳細なステータス メッセージ。
時間 状態の時刻。

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

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2021-03-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": {},
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

名前 形容 価値
種類 リソースの種類 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions'
apiVersion リソース API のバージョン '2021-03-01'
名前 リソース名

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

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

名前 形容 価値
コード 状態コード。
displayStatus 状態の短いローカライズ可能なラベル。
レベル レベル コード。 'Error'
'Info'
'Warning'
メッセージ アラートやエラー メッセージを含む詳細なステータス メッセージ。
時間 状態の時刻。

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

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

  • リソース グループの

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

リソースの形式

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

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

プロパティ値

virtualMachineScaleSets/virtualMachines/extensions

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

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

名前 形容 価値
コード 状態コード。
displayStatus 状態の短いローカライズ可能なラベル。
レベル レベル コード。 "Error"
"Info"
"警告"
メッセージ アラートやエラー メッセージを含む詳細なステータス メッセージ。
時間 状態の時刻。