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

AzureCliScript

class AzureCliScript : KotlinCustomResource

Object model for the Azure CLI script. Azure REST API version: 2020-10-01. Prior API version in Azure Native 1.x: 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 (
	"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 (
	"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 (
	"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 (
	"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 (
	"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

Properties

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

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>

Azure CLI module version to be used.

Link copied to clipboard
val cleanupPreference: Output<String>?

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

Link copied to clipboard
val containerSettings: Output<ContainerConfigurationResponse>?

Container settings.

Link copied to clipboard
val environmentVariables: Output<List<EnvironmentVariableResponse>>?

The environment variables to pass over to the script.

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

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 id: Output<String>
Link copied to clipboard
val identity: Output<ManagedServiceIdentityResponse>?

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>

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

Link copied to clipboard
val location: Output<String>

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

Link copied to clipboard
val name: Output<String>

Name of this resource.

Link copied to clipboard
val outputs: Output<Map<String, Any>>

List of script outputs.

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

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

Link copied to clipboard
val provisioningState: Output<String>

State of the script execution. This only appears in the response.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val retentionInterval: Output<String>

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>?

Script body.

Link copied to clipboard
val status: Output<ScriptStatusResponse>

Contains the results of script execution.

Link copied to clipboard
val storageAccountSettings: Output<StorageAccountConfigurationResponse>?

Storage Account settings.

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

Supporting files for the external script.

Link copied to clipboard
val systemData: Output<SystemDataResponse>

The system metadata related to this resource.

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

Resource tags.

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

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

Link copied to clipboard
val type: Output<String>

Type of this resource.

Link copied to clipboard
val urn: Output<String>