pulumi-azure-native-kotlin/com.pulumi.azurenative.resources.kotlin/AzureCliScriptArgs

AzureCliScriptArgs

data class AzureCliScriptArgs(val arguments: Output<String>? = null, val azCliVersion: Output<String>? = null, val cleanupPreference: Output<Either<String, CleanupOptions>>? = null, val containerSettings: Output<ContainerConfigurationArgs>? = null, val environmentVariables: Output<List<EnvironmentVariableArgs>>? = null, val forceUpdateTag: Output<String>? = null, val identity: Output<ManagedServiceIdentityArgs>? = null, val kind: Output<String>? = null, val location: Output<String>? = null, val primaryScriptUri: Output<String>? = null, val resourceGroupName: Output<String>? = null, val retentionInterval: Output<String>? = null, val scriptContent: Output<String>? = null, val scriptName: Output<String>? = null, val storageAccountSettings: Output<StorageAccountConfigurationArgs>? = null, val supportingScriptUris: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<AzureCliScriptArgs>

Object model for the Azure CLI script. Uses Azure REST API version 2020-10-01. In version 1.x of the Azure Native provider, it used API version 2020-10-01.

Example Usage

DeploymentScriptsCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var azureCliScript = new AzureNative.Resources.AzureCliScript("azureCliScript", new()
    {
        ResourceGroupName = "script-rg",
        ScriptName = "MyDeploymentScript",
    });
});
Content copied to clipboard
package main
import (
	resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resources.NewAzureCliScript(ctx, "azureCliScript", &resources.AzureCliScriptArgs{
			ResourceGroupName: pulumi.String("script-rg"),
			ScriptName:        pulumi.String("MyDeploymentScript"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.AzureCliScript;
import com.pulumi.azurenative.resources.AzureCliScriptArgs;
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 azureCliScript = new AzureCliScript("azureCliScript", AzureCliScriptArgs.builder()
            .resourceGroupName("script-rg")
            .scriptName("MyDeploymentScript")
            .build());
    }
}
Content copied to clipboard

DeploymentScriptsCreateNoUserManagedIdentity

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var azureCliScript = new AzureNative.Resources.AzureCliScript("azureCliScript", new()
    {
        ResourceGroupName = "script-rg",
        ScriptName = "MyDeploymentScript",
    });
});
Content copied to clipboard
package main
import (
	resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resources.NewAzureCliScript(ctx, "azureCliScript", &resources.AzureCliScriptArgs{
			ResourceGroupName: pulumi.String("script-rg"),
			ScriptName:        pulumi.String("MyDeploymentScript"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.AzureCliScript;
import com.pulumi.azurenative.resources.AzureCliScriptArgs;
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 azureCliScript = new AzureCliScript("azureCliScript", AzureCliScriptArgs.builder()
            .resourceGroupName("script-rg")
            .scriptName("MyDeploymentScript")
            .build());
    }
}
Content copied to clipboard

DeploymentScriptsCreate_MinCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var azureCliScript = new AzureNative.Resources.AzureCliScript("azureCliScript", new()
    {
        ResourceGroupName = "script-rg",
        ScriptName = "MyDeploymentScript",
    });
});
Content copied to clipboard
package main
import (
	resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resources.NewAzureCliScript(ctx, "azureCliScript", &resources.AzureCliScriptArgs{
			ResourceGroupName: pulumi.String("script-rg"),
			ScriptName:        pulumi.String("MyDeploymentScript"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.AzureCliScript;
import com.pulumi.azurenative.resources.AzureCliScriptArgs;
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 azureCliScript = new AzureCliScript("azureCliScript", AzureCliScriptArgs.builder()
            .resourceGroupName("script-rg")
            .scriptName("MyDeploymentScript")
            .build());
    }
}
Content copied to clipboard

DeploymentScriptsCreate_UsingCustomACIName

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var azureCliScript = new AzureNative.Resources.AzureCliScript("azureCliScript", new()
    {
        ResourceGroupName = "script-rg",
        ScriptName = "MyDeploymentScript",
    });
});
Content copied to clipboard
package main
import (
	resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resources.NewAzureCliScript(ctx, "azureCliScript", &resources.AzureCliScriptArgs{
			ResourceGroupName: pulumi.String("script-rg"),
			ScriptName:        pulumi.String("MyDeploymentScript"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.AzureCliScript;
import com.pulumi.azurenative.resources.AzureCliScriptArgs;
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 azureCliScript = new AzureCliScript("azureCliScript", AzureCliScriptArgs.builder()
            .resourceGroupName("script-rg")
            .scriptName("MyDeploymentScript")
            .build());
    }
}
Content copied to clipboard

DeploymentScriptsCreate_UsingExistingStorageAccount

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var azureCliScript = new AzureNative.Resources.AzureCliScript("azureCliScript", new()
    {
        ResourceGroupName = "script-rg",
        ScriptName = "MyDeploymentScript",
    });
});
Content copied to clipboard
package main
import (
	resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resources.NewAzureCliScript(ctx, "azureCliScript", &resources.AzureCliScriptArgs{
			ResourceGroupName: pulumi.String("script-rg"),
			ScriptName:        pulumi.String("MyDeploymentScript"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.AzureCliScript;
import com.pulumi.azurenative.resources.AzureCliScriptArgs;
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 azureCliScript = new AzureCliScript("azureCliScript", AzureCliScriptArgs.builder()
            .resourceGroupName("script-rg")
            .scriptName("MyDeploymentScript")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:resources:AzureCliScript myresource1 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(arguments: Output<String>? = null, azCliVersion: Output<String>? = null, cleanupPreference: Output<Either<String, CleanupOptions>>? = null, containerSettings: Output<ContainerConfigurationArgs>? = null, environmentVariables: Output<List<EnvironmentVariableArgs>>? = null, forceUpdateTag: Output<String>? = null, identity: Output<ManagedServiceIdentityArgs>? = null, kind: Output<String>? = null, location: Output<String>? = null, primaryScriptUri: Output<String>? = null, resourceGroupName: Output<String>? = null, retentionInterval: Output<String>? = null, scriptContent: Output<String>? = null, scriptName: Output<String>? = null, storageAccountSettings: Output<StorageAccountConfigurationArgs>? = null, supportingScriptUris: Output<List<String>>? = null, tags: Output<Map<String, String>>? = null, timeout: Output<String>? = null)

Properties

Link copied to clipboard
val arguments: Output<String>? = null

Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'

Link copied to clipboard
val azCliVersion: Output<String>? = null

Azure CLI module version to be used.

Link copied to clipboard
val cleanupPreference: Output<Either<String, CleanupOptions>>? = null

The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.

Link copied to clipboard
val containerSettings: Output<ContainerConfigurationArgs>? = null

Container settings.

Link copied to clipboard
val environmentVariables: Output<List<EnvironmentVariableArgs>>? = null

The environment variables to pass over to the script.

Link copied to clipboard
val forceUpdateTag: Output<String>? = null

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID.

Link copied to clipboard
val identity: Output<ManagedServiceIdentityArgs>? = null

Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.

Link copied to clipboard
val kind: Output<String>? = null

Type of the script. Expected value is 'AzureCLI'.

Link copied to clipboard
val location: Output<String>? = null

The location of the ACI and the storage account for the deployment script.

Link copied to clipboard
val primaryScriptUri: Output<String>? = null

Uri for the script. This is the entry point for the external script.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val retentionInterval: Output<String>? = null

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day).

Link copied to clipboard
val scriptContent: Output<String>? = null

Script body.

Link copied to clipboard
val scriptName: Output<String>? = null

Name of the deployment script.

Link copied to clipboard
val storageAccountSettings: Output<StorageAccountConfigurationArgs>? = null

Storage Account settings.

Link copied to clipboard
val supportingScriptUris: Output<List<String>>? = null

Supporting files for the external script.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val timeout: Output<String>? = null

Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D

Functions

Link copied to clipboard
open override fun toJava(): AzureCliScriptArgs