Azure Native v1.103.0, Jun 2 23

azure-native.avs.ScriptExecution

Explore with Pulumi AI

An instance of a script executed by a user - custom or AVS API Version: 2021-06-01.

Example Usage

ScriptExecutions_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var scriptExecution = new AzureNative.AVS.ScriptExecution("scriptExecution", new()
    {
        HiddenParameters = new[]
        {
            new AzureNative.AVS.Inputs.ScriptSecureStringExecutionParameterArgs
            {
                Name = "Password",
                SecureValue = "PlaceholderPassword",
                Type = "SecureValue",
            },
        },
        Parameters = new[]
        {
            new AzureNative.AVS.Inputs.ScriptStringExecutionParameterArgs
            {
                Name = "DomainName",
                Type = "Value",
                Value = "placeholderDomain.local",
            },
            new AzureNative.AVS.Inputs.ScriptStringExecutionParameterArgs
            {
                Name = "BaseUserDN",
                Type = "Value",
                Value = "DC=placeholder, DC=placeholder",
            },
        },
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Retention = "P0Y0M60DT0H60M60S",
        ScriptCmdletId = "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
        ScriptExecutionName = "addSsoServer",
        Timeout = "P0Y0M0DT0H60M60S",
    });

});

package main

import (
	avs "github.com/pulumi/pulumi-azure-native-sdk/avs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewScriptExecution(ctx, "scriptExecution", &avs.ScriptExecutionArgs{
			HiddenParameters: pulumi.AnyArray{
				avs.ScriptSecureStringExecutionParameter{
					Name:        "Password",
					SecureValue: "PlaceholderPassword",
					Type:        "SecureValue",
				},
			},
			Parameters: pulumi.AnyArray{
				avs.ScriptStringExecutionParameter{
					Name:  "DomainName",
					Type:  "Value",
					Value: "placeholderDomain.local",
				},
				avs.ScriptStringExecutionParameter{
					Name:  "BaseUserDN",
					Type:  "Value",
					Value: "DC=placeholder, DC=placeholder",
				},
			},
			PrivateCloudName:    pulumi.String("cloud1"),
			ResourceGroupName:   pulumi.String("group1"),
			Retention:           pulumi.String("P0Y0M60DT0H60M60S"),
			ScriptCmdletId:      pulumi.String("/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource"),
			ScriptExecutionName: pulumi.String("addSsoServer"),
			Timeout:             pulumi.String("P0Y0M0DT0H60M60S"),
		})
		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.avs.ScriptExecution;
import com.pulumi.azurenative.avs.ScriptExecutionArgs;
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 scriptExecution = new ScriptExecution("scriptExecution", ScriptExecutionArgs.builder()        
            .hiddenParameters(Map.ofEntries(
                Map.entry("name", "Password"),
                Map.entry("secureValue", "PlaceholderPassword"),
                Map.entry("type", "SecureValue")
            ))
            .parameters(            
                Map.ofEntries(
                    Map.entry("name", "DomainName"),
                    Map.entry("type", "Value"),
                    Map.entry("value", "placeholderDomain.local")
                ),
                Map.ofEntries(
                    Map.entry("name", "BaseUserDN"),
                    Map.entry("type", "Value"),
                    Map.entry("value", "DC=placeholder, DC=placeholder")
                ))
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .retention("P0Y0M60DT0H60M60S")
            .scriptCmdletId("/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource")
            .scriptExecutionName("addSsoServer")
            .timeout("P0Y0M0DT0H60M60S")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

script_execution = azure_native.avs.ScriptExecution("scriptExecution",
    hidden_parameters=[azure_native.avs.ScriptSecureStringExecutionParameterArgs(
        name="Password",
        secure_value="PlaceholderPassword",
        type="SecureValue",
    )],
    parameters=[
        azure_native.avs.ScriptStringExecutionParameterArgs(
            name="DomainName",
            type="Value",
            value="placeholderDomain.local",
        ),
        azure_native.avs.ScriptStringExecutionParameterArgs(
            name="BaseUserDN",
            type="Value",
            value="DC=placeholder, DC=placeholder",
        ),
    ],
    private_cloud_name="cloud1",
    resource_group_name="group1",
    retention="P0Y0M60DT0H60M60S",
    script_cmdlet_id="/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    script_execution_name="addSsoServer",
    timeout="P0Y0M0DT0H60M60S")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const scriptExecution = new azure_native.avs.ScriptExecution("scriptExecution", {
    hiddenParameters: [{
        name: "Password",
        secureValue: "PlaceholderPassword",
        type: "SecureValue",
    }],
    parameters: [
        {
            name: "DomainName",
            type: "Value",
            value: "placeholderDomain.local",
        },
        {
            name: "BaseUserDN",
            type: "Value",
            value: "DC=placeholder, DC=placeholder",
        },
    ],
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    retention: "P0Y0M60DT0H60M60S",
    scriptCmdletId: "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    scriptExecutionName: "addSsoServer",
    timeout: "P0Y0M0DT0H60M60S",
});

resources:
  scriptExecution:
    type: azure-native:avs:ScriptExecution
    properties:
      hiddenParameters:
        - name: Password
          secureValue: PlaceholderPassword
          type: SecureValue
      parameters:
        - name: DomainName
          type: Value
          value: placeholderDomain.local
        - name: BaseUserDN
          type: Value
          value: DC=placeholder, DC=placeholder
      privateCloudName: cloud1
      resourceGroupName: group1
      retention: P0Y0M60DT0H60M60S
      scriptCmdletId: /subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource
      scriptExecutionName: addSsoServer
      timeout: P0Y0M0DT0H60M60S

Create ScriptExecution Resource

new ScriptExecution(name: string, args: ScriptExecutionArgs, opts?: CustomResourceOptions);

@overload
def ScriptExecution(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    failure_reason: Optional[str] = None,
                    hidden_parameters: Optional[Sequence[Union[PSCredentialExecutionParameterArgs, ScriptSecureStringExecutionParameterArgs, ScriptStringExecutionParameterArgs]]] = None,
                    named_outputs: Optional[Mapping[str, Any]] = None,
                    output: Optional[Sequence[str]] = None,
                    parameters: Optional[Sequence[Union[PSCredentialExecutionParameterArgs, ScriptSecureStringExecutionParameterArgs, ScriptStringExecutionParameterArgs]]] = None,
                    private_cloud_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    retention: Optional[str] = None,
                    script_cmdlet_id: Optional[str] = None,
                    script_execution_name: Optional[str] = None,
                    timeout: Optional[str] = None)
@overload
def ScriptExecution(resource_name: str,
                    args: ScriptExecutionArgs,
                    opts: Optional[ResourceOptions] = None)

func NewScriptExecution(ctx *Context, name string, args ScriptExecutionArgs, opts ...ResourceOption) (*ScriptExecution, error)

public ScriptExecution(string name, ScriptExecutionArgs args, CustomResourceOptions? opts = null)

public ScriptExecution(String name, ScriptExecutionArgs args)
public ScriptExecution(String name, ScriptExecutionArgs args, CustomResourceOptions options)

type: azure-native:avs:ScriptExecution
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScriptExecutionArgs: 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 ScriptExecutionArgs: 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 ScriptExecutionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScriptExecutionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ScriptExecutionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ScriptExecution 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 ScriptExecution resource accepts the following input properties:

PrivateCloudName string: The name of the private cloud.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
Timeout string: Time limit for execution
FailureReason string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
HiddenParameters List<object>: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
NamedOutputs Dictionary<string, object>: User-defined dictionary.
Output List<string>: Standard output stream from the powershell execution
Parameters List<object>: Parameters the script will accept
Retention string: Time to live for the resource. If not provided, will be available for 60 days
ScriptCmdletId string: A reference to the script cmdlet resource if user is running a AVS script
ScriptExecutionName string: Name of the user-invoked script execution resource

PrivateCloudName string: The name of the private cloud.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
Timeout string: Time limit for execution
FailureReason string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
HiddenParameters []interface{}: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
NamedOutputs map[string]interface{}: User-defined dictionary.
Output []string: Standard output stream from the powershell execution
Parameters []interface{}: Parameters the script will accept
Retention string: Time to live for the resource. If not provided, will be available for 60 days
ScriptCmdletId string: A reference to the script cmdlet resource if user is running a AVS script
ScriptExecutionName string: Name of the user-invoked script execution resource

privateCloudName String: The name of the private cloud.
resourceGroupName String: The name of the resource group. The name is case insensitive.
timeout String: Time limit for execution
failureReason String: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
hiddenParameters List<Object>: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
namedOutputs Map<String,Object>: User-defined dictionary.
output List<String>: Standard output stream from the powershell execution
parameters List<Object>: Parameters the script will accept
retention String: Time to live for the resource. If not provided, will be available for 60 days
scriptCmdletId String: A reference to the script cmdlet resource if user is running a AVS script
scriptExecutionName String: Name of the user-invoked script execution resource

privateCloudName string: The name of the private cloud.
resourceGroupName string: The name of the resource group. The name is case insensitive.
timeout string: Time limit for execution
failureReason string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
hiddenParameters (PSCredentialExecutionParameterArgs | ScriptSecureStringExecutionParameterArgs | ScriptStringExecutionParameterArgs)[]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
namedOutputs {[key: string]: any}: User-defined dictionary.
output string[]: Standard output stream from the powershell execution
parameters (PSCredentialExecutionParameterArgs | ScriptSecureStringExecutionParameterArgs | ScriptStringExecutionParameterArgs)[]: Parameters the script will accept
retention string: Time to live for the resource. If not provided, will be available for 60 days
scriptCmdletId string: A reference to the script cmdlet resource if user is running a AVS script
scriptExecutionName string: Name of the user-invoked script execution resource

private_cloud_name str: The name of the private cloud.
resource_group_name str: The name of the resource group. The name is case insensitive.
timeout str: Time limit for execution
failure_reason str: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
hidden_parameters Sequence[Union[PSCredentialExecutionParameterArgs, ScriptSecureStringExecutionParameterArgs, ScriptStringExecutionParameterArgs]]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
named_outputs Mapping[str, Any]: User-defined dictionary.
output Sequence[str]: Standard output stream from the powershell execution
parameters Sequence[Union[PSCredentialExecutionParameterArgs, ScriptSecureStringExecutionParameterArgs, ScriptStringExecutionParameterArgs]]: Parameters the script will accept
retention str: Time to live for the resource. If not provided, will be available for 60 days
script_cmdlet_id str: A reference to the script cmdlet resource if user is running a AVS script
script_execution_name str: Name of the user-invoked script execution resource

privateCloudName String: The name of the private cloud.
resourceGroupName String: The name of the resource group. The name is case insensitive.
timeout String: Time limit for execution
failureReason String: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
hiddenParameters List<Property Map | Property Map | Property Map>: Parameters that will be hidden/not visible to ARM, such as passwords and credentials
namedOutputs Map<Any>: User-defined dictionary.
output List<String>: Standard output stream from the powershell execution
parameters List<Property Map | Property Map | Property Map>: Parameters the script will accept
retention String: Time to live for the resource. If not provided, will be available for 60 days
scriptCmdletId String: A reference to the script cmdlet resource if user is running a AVS script
scriptExecutionName String: Name of the user-invoked script execution resource

Outputs

All input properties are implicitly available as output properties. Additionally, the ScriptExecution resource produces the following output properties:

Errors List<string>: Standard error output stream from the powershell execution
FinishedAt string: Time the script execution was finished
Id string: The provider-assigned unique ID for this managed resource.
Information List<string>: Standard information out stream from the powershell execution
Name string: Resource name.
ProvisioningState string: The state of the script execution resource
StartedAt string: Time the script execution was started
SubmittedAt string: Time the script execution was submitted
Type string: Resource type.
Warnings List<string>: Standard warning out stream from the powershell execution

Errors []string: Standard error output stream from the powershell execution
FinishedAt string: Time the script execution was finished
Id string: The provider-assigned unique ID for this managed resource.
Information []string: Standard information out stream from the powershell execution
Name string: Resource name.
ProvisioningState string: The state of the script execution resource
StartedAt string: Time the script execution was started
SubmittedAt string: Time the script execution was submitted
Type string: Resource type.
Warnings []string: Standard warning out stream from the powershell execution

errors List<String>: Standard error output stream from the powershell execution
finishedAt String: Time the script execution was finished
id String: The provider-assigned unique ID for this managed resource.
information List<String>: Standard information out stream from the powershell execution
name String: Resource name.
provisioningState String: The state of the script execution resource
startedAt String: Time the script execution was started
submittedAt String: Time the script execution was submitted
type String: Resource type.
warnings List<String>: Standard warning out stream from the powershell execution

errors string[]: Standard error output stream from the powershell execution
finishedAt string: Time the script execution was finished
id string: The provider-assigned unique ID for this managed resource.
information string[]: Standard information out stream from the powershell execution
name string: Resource name.
provisioningState string: The state of the script execution resource
startedAt string: Time the script execution was started
submittedAt string: Time the script execution was submitted
type string: Resource type.
warnings string[]: Standard warning out stream from the powershell execution

errors Sequence[str]: Standard error output stream from the powershell execution
finished_at str: Time the script execution was finished
id str: The provider-assigned unique ID for this managed resource.
information Sequence[str]: Standard information out stream from the powershell execution
name str: Resource name.
provisioning_state str: The state of the script execution resource
started_at str: Time the script execution was started
submitted_at str: Time the script execution was submitted
type str: Resource type.
warnings Sequence[str]: Standard warning out stream from the powershell execution

errors List<String>: Standard error output stream from the powershell execution
finishedAt String: Time the script execution was finished
id String: The provider-assigned unique ID for this managed resource.
information List<String>: Standard information out stream from the powershell execution
name String: Resource name.
provisioningState String: The state of the script execution resource
startedAt String: Time the script execution was started
submittedAt String: Time the script execution was submitted
type String: Resource type.
warnings List<String>: Standard warning out stream from the powershell execution

Supporting Types

PSCredentialExecutionParameter

Name string: The parameter name
Password string: password for login
Username string: username for login

Name string: The parameter name
Password string: password for login
Username string: username for login

name String: The parameter name
password String: password for login
username String: username for login

name string: The parameter name
password string: password for login
username string: username for login

name str: The parameter name
password str: password for login
username str: username for login

name String: The parameter name
password String: password for login
username String: username for login

PSCredentialExecutionParameterResponse

Name string: The parameter name
Password string: password for login
Username string: username for login

Name string: The parameter name
Password string: password for login
Username string: username for login

name String: The parameter name
password String: password for login
username String: username for login

name string: The parameter name
password string: password for login
username string: username for login

name str: The parameter name
password str: password for login
username str: username for login

name String: The parameter name
password String: password for login
username String: username for login

ScriptSecureStringExecutionParameter

Name string: The parameter name
SecureValue string: A secure value for the passed parameter, not to be stored in logs

Name string: The parameter name
SecureValue string: A secure value for the passed parameter, not to be stored in logs

name String: The parameter name
secureValue String: A secure value for the passed parameter, not to be stored in logs

name string: The parameter name
secureValue string: A secure value for the passed parameter, not to be stored in logs

name str: The parameter name
secure_value str: A secure value for the passed parameter, not to be stored in logs

name String: The parameter name
secureValue String: A secure value for the passed parameter, not to be stored in logs

ScriptSecureStringExecutionParameterResponse

Name string: The parameter name
SecureValue string: A secure value for the passed parameter, not to be stored in logs

Name string: The parameter name
SecureValue string: A secure value for the passed parameter, not to be stored in logs

name String: The parameter name
secureValue String: A secure value for the passed parameter, not to be stored in logs

name string: The parameter name
secureValue string: A secure value for the passed parameter, not to be stored in logs

name str: The parameter name
secure_value str: A secure value for the passed parameter, not to be stored in logs

name String: The parameter name
secureValue String: A secure value for the passed parameter, not to be stored in logs

ScriptStringExecutionParameter

Name string: The parameter name
Value string: The value for the passed parameter

Name string: The parameter name
Value string: The value for the passed parameter

name String: The parameter name
value String: The value for the passed parameter

name string: The parameter name
value string: The value for the passed parameter

name str: The parameter name
value str: The value for the passed parameter

name String: The parameter name
value String: The value for the passed parameter

ScriptStringExecutionParameterResponse

Name string: The parameter name
Value string: The value for the passed parameter

Name string: The parameter name
Value string: The value for the passed parameter

name String: The parameter name
value String: The value for the passed parameter

name string: The parameter name
value string: The value for the passed parameter

name str: The parameter name
value str: The value for the passed parameter

name String: The parameter name
value String: The value for the passed parameter

Import

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

$ pulumi import azure-native:avs:ScriptExecution addSsoServer /subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0