Microsoft.Compute virtualMachineScaleSets/extensions 2020-12-01

Bicep リソース定義

virtualMachineScaleSets/extensions リソースの種類は、次の対象にデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/extensions@2020-12-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    protectedSettings: any()
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

プロパティの値

virtualMachineScaleSets/extensions

名前 説明
name リソース名

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

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

VirtualMachineScaleSetExtensionProperties

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
このテンプレートは、以前に暗号化された Windows VMSS の暗号化を解除します

Azure へのデプロイ
このテンプレートは、実行中の Windows VM スケール セットでの暗号化を無効にします
このテンプレートは、実行中の Windows VMSS を暗号化します

Azure へのデプロイ
このテンプレートにより、実行中の Windows VM スケール セットでの暗号化が有効になります
ジャンプボックスを使用して新しい Windows VMSS を作成して暗号化する

Azure へのデプロイ
このテンプレートを使用すると、最新のパッチが適用されたバージョンのサーバー Windows バージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 このテンプレートでは、パブリック IP アドレスを持つジャンプボックスも同じ仮想ネットワークにデプロイされます。 このパブリック IP アドレスを使用してジャンプボックスに接続し、そこからプライベート IP アドレスを介してスケール セット内の VM に接続できます。このテンプレートにより、Windows VM の VM スケール セットでの暗号化が有効になります。

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

virtualMachineScaleSets/extensions リソースの種類は、次の対象にデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/extensions",
  "apiVersion": "2020-12-01",
  "name": "string",
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "protectedSettings": {},
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

プロパティの値

virtualMachineScaleSets/extensions

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

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

VirtualMachineScaleSetExtensionProperties

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
このテンプレートは、以前に暗号化された Windows VMSS の暗号化を解除します

Azure へのデプロイ
このテンプレートは、実行中の Windows VM スケール セットでの暗号化を無効にします
このテンプレートは、実行中の Windows VMSS を暗号化します

Azure へのデプロイ
このテンプレートにより、実行中の Windows VM スケール セットでの暗号化が有効になります
ジャンプボックスを使用して新しい Windows VMSS を作成して暗号化する

Azure へのデプロイ
このテンプレートを使用すると、最新のパッチが適用されたバージョンのサーバー Windows バージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 このテンプレートでは、パブリック IP アドレスを持つジャンプボックスも同じ仮想ネットワークにデプロイされます。 このパブリック IP アドレスを使用してジャンプボックスに接続し、そこからプライベート IP アドレスを介してスケール セット内の VM に接続できます。このテンプレートにより、Windows VM の VM スケール セットでの暗号化が有効になります。

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

virtualMachineScaleSets/extensions リソースの種類は、次の対象にデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/extensions@2020-12-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

プロパティの値

virtualMachineScaleSets/extensions

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

VirtualMachineScaleSetExtensionProperties

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