Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. compute
  5. VirtualMachineScaleSetExtension
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.compute.VirtualMachineScaleSetExtension

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Describes a Virtual Machine Scale Set Extension. API Version: 2021-03-01.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:compute:VirtualMachineScaleSetExtension myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}

    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,
                                    publisher: Optional[str] = None,
                                    name: Optional[str] = None,
                                    protected_settings: Optional[Any] = None,
                                    provision_after_extensions: Optional[Sequence[str]] = None,
                                    auto_upgrade_minor_version: Optional[bool] = None,
                                    force_update_tag: Optional[str] = None,
                                    settings: Optional[Any] = 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",
    Publisher = "string",
    Name = "string",
    ProtectedSettings = "any",
    ProvisionAfterExtensions = new[]
    {
        "string",
    },
    AutoUpgradeMinorVersion = false,
    ForceUpdateTag = "string",
    Settings = "any",
    Type = "string",
    TypeHandlerVersion = "string",
    EnableAutomaticUpgrade = false,
    VmssExtensionName = "string",
});

    example, err := compute.NewVirtualMachineScaleSetExtension(ctx, "virtualMachineScaleSetExtensionResource", &compute.VirtualMachineScaleSetExtensionArgs{
	ResourceGroupName: "string",
	VmScaleSetName:    "string",
	Publisher:         "string",
	Name:              "string",
	ProtectedSettings: "any",
	ProvisionAfterExtensions: []string{
		"string",
	},
	AutoUpgradeMinorVersion: false,
	ForceUpdateTag:          "string",
	Settings:                "any",
	Type:                    "string",
	TypeHandlerVersion:      "string",
	EnableAutomaticUpgrade:  false,
	VmssExtensionName:       "string",
})

    var virtualMachineScaleSetExtensionResource = new VirtualMachineScaleSetExtension("virtualMachineScaleSetExtensionResource", VirtualMachineScaleSetExtensionArgs.builder()
    .resourceGroupName("string")
    .vmScaleSetName("string")
    .publisher("string")
    .name("string")
    .protectedSettings("any")
    .provisionAfterExtensions("string")
    .autoUpgradeMinorVersion(false)
    .forceUpdateTag("string")
    .settings("any")
    .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,
    publisher=string,
    name=string,
    protected_settings=any,
    provision_after_extensions=[string],
    auto_upgrade_minor_version=False,
    force_update_tag=string,
    settings=any,
    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",
    publisher: "string",
    name: "string",
    protectedSettings: "any",
    provisionAfterExtensions: ["string"],
    autoUpgradeMinorVersion: false,
    forceUpdateTag: "string",
    settings: "any",
    type: "string",
    typeHandlerVersion: "string",
    enableAutomaticUpgrade: false,
    vmssExtensionName: "string",
});

    type: azure-native:compute:VirtualMachineScaleSetExtension
properties:
    autoUpgradeMinorVersion: false
    enableAutomaticUpgrade: false
    forceUpdateTag: string
    name: string
    protectedSettings: any
    provisionAfterExtensions:
        - string
    publisher: string
    resourceGroupName: string
    settings: any
    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

    The VirtualMachineScaleSetExtension resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    VmScaleSetName string
    The name of the VM scale set where the extension should be create or updated.
    AutoUpgradeMinorVersion bool
    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.
    EnableAutomaticUpgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    ForceUpdateTag string
    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.
    ProvisionAfterExtensions List<string>
    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.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    VmssExtensionName string
    The name of the VM scale set extension.
    ResourceGroupName string
    The name of the resource group.
    VmScaleSetName string
    The name of the VM scale set where the extension should be create or updated.
    AutoUpgradeMinorVersion bool
    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.
    EnableAutomaticUpgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    ForceUpdateTag string
    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.
    ProvisionAfterExtensions []string
    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.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    VmssExtensionName string
    The name of the VM scale set extension.
    resourceGroupName String
    The name of the resource group.
    vmScaleSetName String
    The name of the VM scale set where the extension should be create or updated.
    autoUpgradeMinorVersion Boolean
    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.
    enableAutomaticUpgrade Boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    forceUpdateTag String
    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.
    provisionAfterExtensions List<String>
    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.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    vmssExtensionName String
    The name of the VM scale set extension.
    resourceGroupName string
    The name of the resource group.
    vmScaleSetName string
    The name of the VM scale set where the extension should be create or updated.
    autoUpgradeMinorVersion boolean
    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.
    enableAutomaticUpgrade boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    forceUpdateTag string
    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.
    provisionAfterExtensions string[]
    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.
    type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion string
    Specifies the version of the script handler.
    vmssExtensionName string
    The name of the VM scale set extension.
    resource_group_name str
    The name of the resource group.
    vm_scale_set_name str
    The name of the VM scale set where the extension should be create or updated.
    auto_upgrade_minor_version bool
    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_upgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    force_update_tag str
    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.
    provision_after_extensions Sequence[str]
    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.
    type str
    Specifies the type of the extension; an example is "CustomScriptExtension".
    type_handler_version str
    Specifies the version of the script handler.
    vmss_extension_name str
    The name of the VM scale set extension.
    resourceGroupName String
    The name of the resource group.
    vmScaleSetName String
    The name of the VM scale set where the extension should be create or updated.
    autoUpgradeMinorVersion Boolean
    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.
    enableAutomaticUpgrade Boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
    forceUpdateTag String
    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.
    provisionAfterExtensions List<String>
    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.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    vmssExtensionName String
    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.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native