Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.azure.compute.kotlin.VirtualMachineScaleSetExtension.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.compute.kotlin
import com.pulumi.azure.compute.kotlin.outputs.VirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
import com.pulumi.azure.compute.kotlin.outputs.VirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [VirtualMachineScaleSetExtension].
*/
@PulumiTagMarker
public class VirtualMachineScaleSetExtensionResourceBuilder internal constructor() {
public var name: String? = null
public var args: VirtualMachineScaleSetExtensionArgs = VirtualMachineScaleSetExtensionArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend VirtualMachineScaleSetExtensionArgsBuilder.() -> Unit) {
val builder = VirtualMachineScaleSetExtensionArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): VirtualMachineScaleSetExtension {
val builtJavaResource =
com.pulumi.azure.compute.VirtualMachineScaleSetExtension(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return VirtualMachineScaleSetExtension(builtJavaResource)
}
}
/**
* Manages an Extension for a Virtual Machine Scale Set.
* > **NOTE:** This resource is not intended to be used with the `azure.compute.ScaleSet` resource - instead it's intended for this to be used with the `azure.compute.LinuxVirtualMachineScaleSet` and `azure.compute.WindowsVirtualMachineScaleSet` resources.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example",
* location: "West Europe",
* });
* const exampleLinuxVirtualMachineScaleSet = new azure.compute.LinuxVirtualMachineScaleSet("example", {
* name: "example",
* resourceGroupName: example.name,
* location: example.location,
* sku: "Standard_F2",
* adminUsername: "adminuser",
* instances: 1,
* sourceImageReference: {
* publisher: "Canonical",
* offer: "0001-com-ubuntu-server-jammy",
* sku: "22_04-lts",
* version: "latest",
* },
* networkInterfaces: [{
* name: "example",
* ipConfigurations: [{
* name: "internal",
* }],
* }],
* osDisk: {
* storageAccountType: "Standard_LRS",
* caching: "ReadWrite",
* },
* });
* const exampleVirtualMachineScaleSetExtension = new azure.compute.VirtualMachineScaleSetExtension("example", {
* name: "example",
* virtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.id,
* publisher: "Microsoft.Azure.Extensions",
* type: "CustomScript",
* typeHandlerVersion: "2.0",
* settings: JSON.stringify({
* commandToExecute: "echo $HOSTNAME",
* }),
* });
* ```
* ```python
* import pulumi
* import json
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example",
* location="West Europe")
* example_linux_virtual_machine_scale_set = azure.compute.LinuxVirtualMachineScaleSet("example",
* name="example",
* resource_group_name=example.name,
* location=example.location,
* sku="Standard_F2",
* admin_username="adminuser",
* instances=1,
* source_image_reference={
* "publisher": "Canonical",
* "offer": "0001-com-ubuntu-server-jammy",
* "sku": "22_04-lts",
* "version": "latest",
* },
* network_interfaces=[{
* "name": "example",
* "ip_configurations": [{
* "name": "internal",
* }],
* }],
* os_disk={
* "storage_account_type": "Standard_LRS",
* "caching": "ReadWrite",
* })
* example_virtual_machine_scale_set_extension = azure.compute.VirtualMachineScaleSetExtension("example",
* name="example",
* virtual_machine_scale_set_id=example_linux_virtual_machine_scale_set.id,
* publisher="Microsoft.Azure.Extensions",
* type="CustomScript",
* type_handler_version="2.0",
* settings=json.dumps({
* "commandToExecute": "echo $HOSTNAME",
* }))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using System.Text.Json;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example",
* Location = "West Europe",
* });
* var exampleLinuxVirtualMachineScaleSet = new Azure.Compute.LinuxVirtualMachineScaleSet("example", new()
* {
* Name = "example",
* ResourceGroupName = example.Name,
* Location = example.Location,
* Sku = "Standard_F2",
* AdminUsername = "adminuser",
* Instances = 1,
* SourceImageReference = new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetSourceImageReferenceArgs
* {
* Publisher = "Canonical",
* Offer = "0001-com-ubuntu-server-jammy",
* Sku = "22_04-lts",
* Version = "latest",
* },
* NetworkInterfaces = new[]
* {
* new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetNetworkInterfaceArgs
* {
* Name = "example",
* IpConfigurations = new[]
* {
* new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
* {
* Name = "internal",
* },
* },
* },
* },
* OsDisk = new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetOsDiskArgs
* {
* StorageAccountType = "Standard_LRS",
* Caching = "ReadWrite",
* },
* });
* var exampleVirtualMachineScaleSetExtension = new Azure.Compute.VirtualMachineScaleSetExtension("example", new()
* {
* Name = "example",
* VirtualMachineScaleSetId = exampleLinuxVirtualMachineScaleSet.Id,
* Publisher = "Microsoft.Azure.Extensions",
* Type = "CustomScript",
* TypeHandlerVersion = "2.0",
* Settings = JsonSerializer.Serialize(new Dictionary
* {
* ["commandToExecute"] = "echo $HOSTNAME",
* }),
* });
* });
* ```
* ```go
* package main
* import (
* "encoding/json"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleLinuxVirtualMachineScaleSet, err := compute.NewLinuxVirtualMachineScaleSet(ctx, "example", &compute.LinuxVirtualMachineScaleSetArgs{
* Name: pulumi.String("example"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* Sku: pulumi.String("Standard_F2"),
* AdminUsername: pulumi.String("adminuser"),
* Instances: pulumi.Int(1),
* SourceImageReference: &compute.LinuxVirtualMachineScaleSetSourceImageReferenceArgs{
* Publisher: pulumi.String("Canonical"),
* Offer: pulumi.String("0001-com-ubuntu-server-jammy"),
* Sku: pulumi.String("22_04-lts"),
* Version: pulumi.String("latest"),
* },
* NetworkInterfaces: compute.LinuxVirtualMachineScaleSetNetworkInterfaceArray{
* &compute.LinuxVirtualMachineScaleSetNetworkInterfaceArgs{
* Name: pulumi.String("example"),
* IpConfigurations: compute.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
* &compute.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
* Name: pulumi.String("internal"),
* },
* },
* },
* },
* OsDisk: &compute.LinuxVirtualMachineScaleSetOsDiskArgs{
* StorageAccountType: pulumi.String("Standard_LRS"),
* Caching: pulumi.String("ReadWrite"),
* },
* })
* if err != nil {
* return err
* }
* tmpJSON0, err := json.Marshal(map[string]interface{}{
* "commandToExecute": "echo $HOSTNAME",
* })
* if err != nil {
* return err
* }
* json0 := string(tmpJSON0)
* _, err = compute.NewVirtualMachineScaleSetExtension(ctx, "example", &compute.VirtualMachineScaleSetExtensionArgs{
* Name: pulumi.String("example"),
* VirtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.ID(),
* Publisher: pulumi.String("Microsoft.Azure.Extensions"),
* Type: pulumi.String("CustomScript"),
* TypeHandlerVersion: pulumi.String("2.0"),
* Settings: pulumi.String(json0),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.compute.LinuxVirtualMachineScaleSet;
* import com.pulumi.azure.compute.LinuxVirtualMachineScaleSetArgs;
* import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetSourceImageReferenceArgs;
* import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetNetworkInterfaceArgs;
* import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetOsDiskArgs;
* import com.pulumi.azure.compute.VirtualMachineScaleSetExtension;
* import com.pulumi.azure.compute.VirtualMachineScaleSetExtensionArgs;
* import static com.pulumi.codegen.internal.Serialization.*;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example")
* .location("West Europe")
* .build());
* var exampleLinuxVirtualMachineScaleSet = new LinuxVirtualMachineScaleSet("exampleLinuxVirtualMachineScaleSet", LinuxVirtualMachineScaleSetArgs.builder()
* .name("example")
* .resourceGroupName(example.name())
* .location(example.location())
* .sku("Standard_F2")
* .adminUsername("adminuser")
* .instances(1)
* .sourceImageReference(LinuxVirtualMachineScaleSetSourceImageReferenceArgs.builder()
* .publisher("Canonical")
* .offer("0001-com-ubuntu-server-jammy")
* .sku("22_04-lts")
* .version("latest")
* .build())
* .networkInterfaces(LinuxVirtualMachineScaleSetNetworkInterfaceArgs.builder()
* .name("example")
* .ipConfigurations(LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
* .name("internal")
* .build())
* .build())
* .osDisk(LinuxVirtualMachineScaleSetOsDiskArgs.builder()
* .storageAccountType("Standard_LRS")
* .caching("ReadWrite")
* .build())
* .build());
* var exampleVirtualMachineScaleSetExtension = new VirtualMachineScaleSetExtension("exampleVirtualMachineScaleSetExtension", VirtualMachineScaleSetExtensionArgs.builder()
* .name("example")
* .virtualMachineScaleSetId(exampleLinuxVirtualMachineScaleSet.id())
* .publisher("Microsoft.Azure.Extensions")
* .type("CustomScript")
* .typeHandlerVersion("2.0")
* .settings(serializeJson(
* jsonObject(
* jsonProperty("commandToExecute", "echo $HOSTNAME")
* )))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example
* location: West Europe
* exampleLinuxVirtualMachineScaleSet:
* type: azure:compute:LinuxVirtualMachineScaleSet
* name: example
* properties:
* name: example
* resourceGroupName: ${example.name}
* location: ${example.location}
* sku: Standard_F2
* adminUsername: adminuser
* instances: 1
* sourceImageReference:
* publisher: Canonical
* offer: 0001-com-ubuntu-server-jammy
* sku: 22_04-lts
* version: latest
* networkInterfaces:
* - name: example
* ipConfigurations:
* - name: internal
* osDisk:
* storageAccountType: Standard_LRS
* caching: ReadWrite
* exampleVirtualMachineScaleSetExtension:
* type: azure:compute:VirtualMachineScaleSetExtension
* name: example
* properties:
* name: example
* virtualMachineScaleSetId: ${exampleLinuxVirtualMachineScaleSet.id}
* publisher: Microsoft.Azure.Extensions
* type: CustomScript
* typeHandlerVersion: '2.0'
* settings:
* fn::toJSON:
* commandToExecute: echo $HOSTNAME
* ```
*
* ## Import
* Virtual Machine Scale Set Extensions can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:compute/virtualMachineScaleSetExtension:VirtualMachineScaleSetExtension test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleSet1/extensions/extension1
* ```
*/
public class VirtualMachineScaleSetExtension internal constructor(
override val javaResource: com.pulumi.azure.compute.VirtualMachineScaleSetExtension,
) : KotlinCustomResource(javaResource, VirtualMachineScaleSetExtensionMapper) {
/**
* Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to `true`.
*/
public val autoUpgradeMinorVersion: Output?
get() = javaResource.autoUpgradeMinorVersion().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
*/
public val automaticUpgradeEnabled: Output?
get() = javaResource.automaticUpgradeEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Should failures from the extension be suppressed? Possible values are `true` or `false`. Defaults to `false`.
* > **NOTE:** Operational failures such as not connecting to the VM will not be suppressed regardless of the `failure_suppression_enabled` value.
*/
public val failureSuppressionEnabled: Output?
get() = javaResource.failureSuppressionEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
*/
public val forceUpdateTag: Output?
get() = javaResource.forceUpdateTag().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
* > **NOTE:** Keys within the `protected_settings` block are notoriously case-sensitive, where the casing required (e.g. TitleCase vs snakeCase) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.
*/
public val protectedSettings: Output?
get() = javaResource.protectedSettings().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `protected_settings_from_key_vault` block as defined below.
* > **Note:** `protected_settings_from_key_vault` cannot be used with `protected_settings`
*/
public val protectedSettingsFromKeyVault:
Output?
get() = javaResource.protectedSettingsFromKeyVault().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
}).orElse(null)
})
/**
* An ordered list of Extension names which this should be provisioned after.
*/
public val provisionAfterExtensions: Output>?
get() = javaResource.provisionAfterExtensions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
*/
public val publisher: Output
get() = javaResource.publisher().applyValue({ args0 -> args0 })
/**
* A JSON String which specifies Settings for the Extension.
* > **NOTE:** Keys within the `settings` block are notoriously case-sensitive, where the casing required (e.g. TitleCase vs snakeCase) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.
*/
public val settings: Output?
get() = javaResource.settings().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies the Type of the Extension. Changing this forces a new resource to be created.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* Specifies the version of the extension to use, available versions can be found using the Azure CLI.
* > **Note:** The `Publisher` and `Type` of Virtual Machine Scale Set Extensions can be found using the Azure CLI, via:
* ```shell
* az vmss extension image list --location westus -o table
* ```
*/
public val typeHandlerVersion: Output
get() = javaResource.typeHandlerVersion().applyValue({ args0 -> args0 })
/**
* The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
* > **NOTE:** This should be the ID from the `azure.compute.LinuxVirtualMachineScaleSet` or `azure.compute.WindowsVirtualMachineScaleSet` resource - when using the older `azure.compute.ScaleSet` resource extensions should instead be defined inline.
*/
public val virtualMachineScaleSetId: Output
get() = javaResource.virtualMachineScaleSetId().applyValue({ args0 -> args0 })
}
public object VirtualMachineScaleSetExtensionMapper :
ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.compute.VirtualMachineScaleSetExtension::class == javaResource::class
override fun map(javaResource: Resource): VirtualMachineScaleSetExtension =
VirtualMachineScaleSetExtension(
javaResource as
com.pulumi.azure.compute.VirtualMachineScaleSetExtension,
)
}
/**
* @see [VirtualMachineScaleSetExtension].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [VirtualMachineScaleSetExtension].
*/
public suspend fun virtualMachineScaleSetExtension(
name: String,
block: suspend VirtualMachineScaleSetExtensionResourceBuilder.() -> Unit,
): VirtualMachineScaleSetExtension {
val builder = VirtualMachineScaleSetExtensionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [VirtualMachineScaleSetExtension].
* @param name The _unique_ name of the resulting resource.
*/
public fun virtualMachineScaleSetExtension(name: String): VirtualMachineScaleSetExtension {
val builder = VirtualMachineScaleSetExtensionResourceBuilder()
builder.name(name)
return builder.build()
}
