Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2024-07-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で子リソースの名前と種類 設定する方法を参照してください。		 string (必須)
場所 拡張機能の場所。 糸
親 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。 string (必須)
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": "2024-07-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 のバージョン '2024-07-01'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)
場所 拡張機能の場所。 糸
プロパティ 仮想マシン拡張機能のプロパティについて説明します。 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。 string (必須)
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@2024-07-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@2024-07-01"
名前 リソース名 string (必須)
場所 拡張機能の場所。 糸
parent_id このリソースの親であるリソースの ID。 種類のリソースの 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"
"警告"
メッセージ アラートやエラー メッセージを含む詳細なステータス メッセージ。 糸
時間 状態の時刻。 糸

KeyVaultSecretReference

名前 形容 価値
secretUrl Key Vault 内のシークレットを参照する URL。 string (必須)
sourceVault シークレットを含む Key Vault の相対 URL。 SubResource (必須)

SubResource

名前 形容 価値
身分証明書 リソース ID 糸