azure-native.compute.VirtualMachineScaleSetExtension
Explore with Pulumi AI
Describes a Virtual Machine Scale Set Extension. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2021-03-01.
Other available API versions: 2021-11-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.
Example Usage
VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var virtualMachineScaleSetExtension = new AzureNative.Compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", new()
    {
        AutoUpgradeMinorVersion = true,
        EnableAutomaticUpgrade = true,
        ForceUpdateTag = "aaaaaaaaa",
        Name = "{extension-name}",
        ProtectedSettings = null,
        ProvisionAfterExtensions = new[]
        {
            "aa",
        },
        Publisher = "{extension-Publisher}",
        ResourceGroupName = "rgcompute",
        Settings = null,
        SuppressFailures = true,
        Type = "{extension-Type}",
        TypeHandlerVersion = "{handler-version}",
        VmScaleSetName = "aaaaaaa",
        VmssExtensionName = "aaaaaaaaaaaaaaaaaaaaa",
    });
});
package main
import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewVirtualMachineScaleSetExtension(ctx, "virtualMachineScaleSetExtension", &compute.VirtualMachineScaleSetExtensionArgs{
			AutoUpgradeMinorVersion: pulumi.Bool(true),
			EnableAutomaticUpgrade:  pulumi.Bool(true),
			ForceUpdateTag:          pulumi.String("aaaaaaaaa"),
			Name:                    pulumi.String("{extension-name}"),
			ProtectedSettings:       pulumi.Any(map[string]interface{}{}),
			ProvisionAfterExtensions: pulumi.StringArray{
				pulumi.String("aa"),
			},
			Publisher:          pulumi.String("{extension-Publisher}"),
			ResourceGroupName:  pulumi.String("rgcompute"),
			Settings:           pulumi.Any(map[string]interface{}{}),
			SuppressFailures:   pulumi.Bool(true),
			Type:               pulumi.String("{extension-Type}"),
			TypeHandlerVersion: pulumi.String("{handler-version}"),
			VmScaleSetName:     pulumi.String("aaaaaaa"),
			VmssExtensionName:  pulumi.String("aaaaaaaaaaaaaaaaaaaaa"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.VirtualMachineScaleSetExtension;
import com.pulumi.azurenative.compute.VirtualMachineScaleSetExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var virtualMachineScaleSetExtension = new VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", VirtualMachineScaleSetExtensionArgs.builder()
            .autoUpgradeMinorVersion(true)
            .enableAutomaticUpgrade(true)
            .forceUpdateTag("aaaaaaaaa")
            .name("{extension-name}")
            .protectedSettings()
            .provisionAfterExtensions("aa")
            .publisher("{extension-Publisher}")
            .resourceGroupName("rgcompute")
            .settings()
            .suppressFailures(true)
            .type("{extension-Type}")
            .typeHandlerVersion("{handler-version}")
            .vmScaleSetName("aaaaaaa")
            .vmssExtensionName("aaaaaaaaaaaaaaaaaaaaa")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const virtualMachineScaleSetExtension = new azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", {
    autoUpgradeMinorVersion: true,
    enableAutomaticUpgrade: true,
    forceUpdateTag: "aaaaaaaaa",
    name: "{extension-name}",
    protectedSettings: {},
    provisionAfterExtensions: ["aa"],
    publisher: "{extension-Publisher}",
    resourceGroupName: "rgcompute",
    settings: {},
    suppressFailures: true,
    type: "{extension-Type}",
    typeHandlerVersion: "{handler-version}",
    vmScaleSetName: "aaaaaaa",
    vmssExtensionName: "aaaaaaaaaaaaaaaaaaaaa",
});
import pulumi
import pulumi_azure_native as azure_native
virtual_machine_scale_set_extension = azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension",
    auto_upgrade_minor_version=True,
    enable_automatic_upgrade=True,
    force_update_tag="aaaaaaaaa",
    name="{extension-name}",
    protected_settings={},
    provision_after_extensions=["aa"],
    publisher="{extension-Publisher}",
    resource_group_name="rgcompute",
    settings={},
    suppress_failures=True,
    type="{extension-Type}",
    type_handler_version="{handler-version}",
    vm_scale_set_name="aaaaaaa",
    vmss_extension_name="aaaaaaaaaaaaaaaaaaaaa")
resources:
  virtualMachineScaleSetExtension:
    type: azure-native:compute:VirtualMachineScaleSetExtension
    properties:
      autoUpgradeMinorVersion: true
      enableAutomaticUpgrade: true
      forceUpdateTag: aaaaaaaaa
      name: '{extension-name}'
      protectedSettings: {}
      provisionAfterExtensions:
        - aa
      publisher: '{extension-Publisher}'
      resourceGroupName: rgcompute
      settings: {}
      suppressFailures: true
      type: '{extension-Type}'
      typeHandlerVersion: '{handler-version}'
      vmScaleSetName: aaaaaaa
      vmssExtensionName: aaaaaaaaaaaaaaaaaaaaa
VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var virtualMachineScaleSetExtension = new AzureNative.Compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", new()
    {
        ResourceGroupName = "rgcompute",
        VmScaleSetName = "aaaaaaaaaaa",
        VmssExtensionName = "aaaaaaaaaaa",
    });
});
package main
import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewVirtualMachineScaleSetExtension(ctx, "virtualMachineScaleSetExtension", &compute.VirtualMachineScaleSetExtensionArgs{
			ResourceGroupName: pulumi.String("rgcompute"),
			VmScaleSetName:    pulumi.String("aaaaaaaaaaa"),
			VmssExtensionName: pulumi.String("aaaaaaaaaaa"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.VirtualMachineScaleSetExtension;
import com.pulumi.azurenative.compute.VirtualMachineScaleSetExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var virtualMachineScaleSetExtension = new VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", VirtualMachineScaleSetExtensionArgs.builder()
            .resourceGroupName("rgcompute")
            .vmScaleSetName("aaaaaaaaaaa")
            .vmssExtensionName("aaaaaaaaaaa")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const virtualMachineScaleSetExtension = new azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension", {
    resourceGroupName: "rgcompute",
    vmScaleSetName: "aaaaaaaaaaa",
    vmssExtensionName: "aaaaaaaaaaa",
});
import pulumi
import pulumi_azure_native as azure_native
virtual_machine_scale_set_extension = azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtension",
    resource_group_name="rgcompute",
    vm_scale_set_name="aaaaaaaaaaa",
    vmss_extension_name="aaaaaaaaaaa")
resources:
  virtualMachineScaleSetExtension:
    type: azure-native:compute:VirtualMachineScaleSetExtension
    properties:
      resourceGroupName: rgcompute
      vmScaleSetName: aaaaaaaaaaa
      vmssExtensionName: aaaaaaaaaaa
Create VirtualMachineScaleSetExtension Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VirtualMachineScaleSetExtension(name: string, args: VirtualMachineScaleSetExtensionArgs, opts?: CustomResourceOptions);@overload
def VirtualMachineScaleSetExtension(resource_name: str,
                                    args: VirtualMachineScaleSetExtensionInitArgs,
                                    opts: Optional[ResourceOptions] = None)
@overload
def VirtualMachineScaleSetExtension(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    resource_group_name: Optional[str] = None,
                                    vm_scale_set_name: Optional[str] = None,
                                    provision_after_extensions: Optional[Sequence[str]] = None,
                                    name: Optional[str] = None,
                                    protected_settings: Optional[Any] = None,
                                    protected_settings_from_key_vault: Optional[KeyVaultSecretReferenceArgs] = None,
                                    auto_upgrade_minor_version: Optional[bool] = None,
                                    publisher: Optional[str] = None,
                                    force_update_tag: Optional[str] = None,
                                    settings: Optional[Any] = None,
                                    suppress_failures: Optional[bool] = None,
                                    type: Optional[str] = None,
                                    type_handler_version: Optional[str] = None,
                                    enable_automatic_upgrade: Optional[bool] = None,
                                    vmss_extension_name: Optional[str] = None)func NewVirtualMachineScaleSetExtension(ctx *Context, name string, args VirtualMachineScaleSetExtensionArgs, opts ...ResourceOption) (*VirtualMachineScaleSetExtension, error)public VirtualMachineScaleSetExtension(string name, VirtualMachineScaleSetExtensionArgs args, CustomResourceOptions? opts = null)
public VirtualMachineScaleSetExtension(String name, VirtualMachineScaleSetExtensionArgs args)
public VirtualMachineScaleSetExtension(String name, VirtualMachineScaleSetExtensionArgs args, CustomResourceOptions options)
type: azure-native:compute:VirtualMachineScaleSetExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VirtualMachineScaleSetExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VirtualMachineScaleSetExtensionInitArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VirtualMachineScaleSetExtensionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualMachineScaleSetExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VirtualMachineScaleSetExtensionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var virtualMachineScaleSetExtensionResource = new AzureNative.Compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtensionResource", new()
{
    ResourceGroupName = "string",
    VmScaleSetName = "string",
    ProvisionAfterExtensions = new[]
    {
        "string",
    },
    Name = "string",
    ProtectedSettings = "any",
    ProtectedSettingsFromKeyVault = new AzureNative.Compute.Inputs.KeyVaultSecretReferenceArgs
    {
        SecretUrl = "string",
        SourceVault = new AzureNative.Compute.Inputs.SubResourceArgs
        {
            Id = "string",
        },
    },
    AutoUpgradeMinorVersion = false,
    Publisher = "string",
    ForceUpdateTag = "string",
    Settings = "any",
    SuppressFailures = false,
    Type = "string",
    TypeHandlerVersion = "string",
    EnableAutomaticUpgrade = false,
    VmssExtensionName = "string",
});
example, err := compute.NewVirtualMachineScaleSetExtension(ctx, "virtualMachineScaleSetExtensionResource", &compute.VirtualMachineScaleSetExtensionArgs{
	ResourceGroupName: pulumi.String("string"),
	VmScaleSetName:    pulumi.String("string"),
	ProvisionAfterExtensions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:              pulumi.String("string"),
	ProtectedSettings: pulumi.Any("any"),
	ProtectedSettingsFromKeyVault: &compute.KeyVaultSecretReferenceArgs{
		SecretUrl: pulumi.String("string"),
		SourceVault: &compute.SubResourceArgs{
			Id: pulumi.String("string"),
		},
	},
	AutoUpgradeMinorVersion: pulumi.Bool(false),
	Publisher:               pulumi.String("string"),
	ForceUpdateTag:          pulumi.String("string"),
	Settings:                pulumi.Any("any"),
	SuppressFailures:        pulumi.Bool(false),
	Type:                    pulumi.String("string"),
	TypeHandlerVersion:      pulumi.String("string"),
	EnableAutomaticUpgrade:  pulumi.Bool(false),
	VmssExtensionName:       pulumi.String("string"),
})
var virtualMachineScaleSetExtensionResource = new VirtualMachineScaleSetExtension("virtualMachineScaleSetExtensionResource", VirtualMachineScaleSetExtensionArgs.builder()
    .resourceGroupName("string")
    .vmScaleSetName("string")
    .provisionAfterExtensions("string")
    .name("string")
    .protectedSettings("any")
    .protectedSettingsFromKeyVault(KeyVaultSecretReferenceArgs.builder()
        .secretUrl("string")
        .sourceVault(SubResourceArgs.builder()
            .id("string")
            .build())
        .build())
    .autoUpgradeMinorVersion(false)
    .publisher("string")
    .forceUpdateTag("string")
    .settings("any")
    .suppressFailures(false)
    .type("string")
    .typeHandlerVersion("string")
    .enableAutomaticUpgrade(false)
    .vmssExtensionName("string")
    .build());
virtual_machine_scale_set_extension_resource = azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtensionResource",
    resource_group_name="string",
    vm_scale_set_name="string",
    provision_after_extensions=["string"],
    name="string",
    protected_settings="any",
    protected_settings_from_key_vault={
        "secret_url": "string",
        "source_vault": {
            "id": "string",
        },
    },
    auto_upgrade_minor_version=False,
    publisher="string",
    force_update_tag="string",
    settings="any",
    suppress_failures=False,
    type="string",
    type_handler_version="string",
    enable_automatic_upgrade=False,
    vmss_extension_name="string")
const virtualMachineScaleSetExtensionResource = new azure_native.compute.VirtualMachineScaleSetExtension("virtualMachineScaleSetExtensionResource", {
    resourceGroupName: "string",
    vmScaleSetName: "string",
    provisionAfterExtensions: ["string"],
    name: "string",
    protectedSettings: "any",
    protectedSettingsFromKeyVault: {
        secretUrl: "string",
        sourceVault: {
            id: "string",
        },
    },
    autoUpgradeMinorVersion: false,
    publisher: "string",
    forceUpdateTag: "string",
    settings: "any",
    suppressFailures: false,
    type: "string",
    typeHandlerVersion: "string",
    enableAutomaticUpgrade: false,
    vmssExtensionName: "string",
});
type: azure-native:compute:VirtualMachineScaleSetExtension
properties:
    autoUpgradeMinorVersion: false
    enableAutomaticUpgrade: false
    forceUpdateTag: string
    name: string
    protectedSettings: any
    protectedSettingsFromKeyVault:
        secretUrl: string
        sourceVault:
            id: string
    provisionAfterExtensions:
        - string
    publisher: string
    resourceGroupName: string
    settings: any
    suppressFailures: false
    type: string
    typeHandlerVersion: string
    vmScaleSetName: string
    vmssExtensionName: string
VirtualMachineScaleSetExtension Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VirtualMachineScaleSetExtension resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group.
- VmScale stringSet Name 
- The name of the VM scale set where the extension should be create or updated.
- AutoUpgrade boolMinor Version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- EnableAutomatic boolUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- ForceUpdate stringTag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- Name string
- The name of the extension.
- ProtectedSettings object
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- ProtectedSettings Pulumi.From Key Vault Azure Native. Compute. Inputs. Key Vault Secret Reference 
- The extensions protected settings that are passed by reference, and consumed from key vault
- ProvisionAfter List<string>Extensions 
- Collection of extension names after which this extension needs to be provisioned.
- Publisher string
- The name of the extension handler publisher.
- Settings object
- Json formatted public settings for the extension.
- SuppressFailures bool
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- VmssExtension stringName 
- The name of the VM scale set extension.
- ResourceGroup stringName 
- The name of the resource group.
- VmScale stringSet Name 
- The name of the VM scale set where the extension should be create or updated.
- AutoUpgrade boolMinor Version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- EnableAutomatic boolUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- ForceUpdate stringTag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- Name string
- The name of the extension.
- ProtectedSettings interface{}
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- ProtectedSettings KeyFrom Key Vault Vault Secret Reference Args 
- The extensions protected settings that are passed by reference, and consumed from key vault
- ProvisionAfter []stringExtensions 
- Collection of extension names after which this extension needs to be provisioned.
- Publisher string
- The name of the extension handler publisher.
- Settings interface{}
- Json formatted public settings for the extension.
- SuppressFailures bool
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- TypeHandler stringVersion 
- Specifies the version of the script handler.
- VmssExtension stringName 
- The name of the VM scale set extension.
- resourceGroup StringName 
- The name of the resource group.
- vmScale StringSet Name 
- The name of the VM scale set where the extension should be create or updated.
- autoUpgrade BooleanMinor Version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- enableAutomatic BooleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- forceUpdate StringTag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- name String
- The name of the extension.
- protectedSettings Object
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- protectedSettings KeyFrom Key Vault Vault Secret Reference 
- The extensions protected settings that are passed by reference, and consumed from key vault
- provisionAfter List<String>Extensions 
- Collection of extension names after which this extension needs to be provisioned.
- publisher String
- The name of the extension handler publisher.
- settings Object
- Json formatted public settings for the extension.
- suppressFailures Boolean
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandler StringVersion 
- Specifies the version of the script handler.
- vmssExtension StringName 
- The name of the VM scale set extension.
- resourceGroup stringName 
- The name of the resource group.
- vmScale stringSet Name 
- The name of the VM scale set where the extension should be create or updated.
- autoUpgrade booleanMinor Version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- enableAutomatic booleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- forceUpdate stringTag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- name string
- The name of the extension.
- protectedSettings any
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- protectedSettings KeyFrom Key Vault Vault Secret Reference 
- The extensions protected settings that are passed by reference, and consumed from key vault
- provisionAfter string[]Extensions 
- Collection of extension names after which this extension needs to be provisioned.
- publisher string
- The name of the extension handler publisher.
- settings any
- Json formatted public settings for the extension.
- suppressFailures boolean
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandler stringVersion 
- Specifies the version of the script handler.
- vmssExtension stringName 
- The name of the VM scale set extension.
- resource_group_ strname 
- The name of the resource group.
- vm_scale_ strset_ name 
- The name of the VM scale set where the extension should be create or updated.
- auto_upgrade_ boolminor_ version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- enable_automatic_ boolupgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- force_update_ strtag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- name str
- The name of the extension.
- protected_settings Any
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- protected_settings_ Keyfrom_ key_ vault Vault Secret Reference Args 
- The extensions protected settings that are passed by reference, and consumed from key vault
- provision_after_ Sequence[str]extensions 
- Collection of extension names after which this extension needs to be provisioned.
- publisher str
- The name of the extension handler publisher.
- settings Any
- Json formatted public settings for the extension.
- suppress_failures bool
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_handler_ strversion 
- Specifies the version of the script handler.
- vmss_extension_ strname 
- The name of the VM scale set extension.
- resourceGroup StringName 
- The name of the resource group.
- vmScale StringSet Name 
- The name of the VM scale set where the extension should be create or updated.
- autoUpgrade BooleanMinor Version 
- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- enableAutomatic BooleanUpgrade 
- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- forceUpdate StringTag 
- If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- name String
- The name of the extension.
- protectedSettings Any
- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- protectedSettings Property MapFrom Key Vault 
- The extensions protected settings that are passed by reference, and consumed from key vault
- provisionAfter List<String>Extensions 
- Collection of extension names after which this extension needs to be provisioned.
- publisher String
- The name of the extension handler publisher.
- settings Any
- Json formatted public settings for the extension.
- suppressFailures Boolean
- Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandler StringVersion 
- Specifies the version of the script handler.
- vmssExtension StringName 
- The name of the VM scale set extension.
Outputs
All input properties are implicitly available as output properties. Additionally, the VirtualMachineScaleSetExtension resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- ProvisioningState string
- The provisioning state, which only appears in the response.
- Id string
- The provider-assigned unique ID for this managed resource.
- ProvisioningState string
- The provisioning state, which only appears in the response.
- id String
- The provider-assigned unique ID for this managed resource.
- provisioningState String
- The provisioning state, which only appears in the response.
- id string
- The provider-assigned unique ID for this managed resource.
- provisioningState string
- The provisioning state, which only appears in the response.
- id str
- The provider-assigned unique ID for this managed resource.
- provisioning_state str
- The provisioning state, which only appears in the response.
- id String
- The provider-assigned unique ID for this managed resource.
- provisioningState String
- The provisioning state, which only appears in the response.
Supporting Types
KeyVaultSecretReference, KeyVaultSecretReferenceArgs        
- SecretUrl string
- The URL referencing a secret in a Key Vault.
- SourceVault Pulumi.Azure Native. Compute. Inputs. Sub Resource 
- The relative URL of the Key Vault containing the secret.
- SecretUrl string
- The URL referencing a secret in a Key Vault.
- SourceVault SubResource 
- The relative URL of the Key Vault containing the secret.
- secretUrl String
- The URL referencing a secret in a Key Vault.
- sourceVault SubResource 
- The relative URL of the Key Vault containing the secret.
- secretUrl string
- The URL referencing a secret in a Key Vault.
- sourceVault SubResource 
- The relative URL of the Key Vault containing the secret.
- secret_url str
- The URL referencing a secret in a Key Vault.
- source_vault SubResource 
- The relative URL of the Key Vault containing the secret.
- secretUrl String
- The URL referencing a secret in a Key Vault.
- sourceVault Property Map
- The relative URL of the Key Vault containing the secret.
KeyVaultSecretReferenceResponse, KeyVaultSecretReferenceResponseArgs          
- SecretUrl string
- The URL referencing a secret in a Key Vault.
- SourceVault Pulumi.Azure Native. Compute. Inputs. Sub Resource Response 
- The relative URL of the Key Vault containing the secret.
- SecretUrl string
- The URL referencing a secret in a Key Vault.
- SourceVault SubResource Response 
- The relative URL of the Key Vault containing the secret.
- secretUrl String
- The URL referencing a secret in a Key Vault.
- sourceVault SubResource Response 
- The relative URL of the Key Vault containing the secret.
- secretUrl string
- The URL referencing a secret in a Key Vault.
- sourceVault SubResource Response 
- The relative URL of the Key Vault containing the secret.
- secret_url str
- The URL referencing a secret in a Key Vault.
- source_vault SubResource Response 
- The relative URL of the Key Vault containing the secret.
- secretUrl String
- The URL referencing a secret in a Key Vault.
- sourceVault Property Map
- The relative URL of the Key Vault containing the secret.
SubResource, SubResourceArgs    
- Id string
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
- Id string
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
- id String
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
- id string
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
- id str
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
- id String
- Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
SubResourceResponse, SubResourceResponseArgs      
- Id string
- Resource Id
- Id string
- Resource Id
- id String
- Resource Id
- id string
- Resource Id
- id str
- Resource Id
- id String
- Resource Id
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:VirtualMachineScaleSetExtension {extension-name} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0