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.
Create ScriptExecution Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScriptExecution(name: string, args: ScriptExecutionArgs, opts?: CustomResourceOptions);
@overload
def ScriptExecution(resource_name: str,
args: ScriptExecutionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScriptExecution(resource_name: str,
opts: Optional[ResourceOptions] = None,
private_cloud_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
timeout: Optional[str] = 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,
retention: Optional[str] = None,
script_cmdlet_id: Optional[str] = None,
script_execution_name: Optional[str] = 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.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ScriptExecutionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ScriptExecutionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ScriptExecutionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ScriptExecutionArgs - 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 scriptExecutionResource = new AzureNative.Avs.ScriptExecution("scriptExecutionResource", new()
{
PrivateCloudName = "string",
ResourceGroupName = "string",
Timeout = "string",
FailureReason = "string",
HiddenParameters = new[]
{
{
{ "name", "string" },
{ "type", "Credential" },
{ "password", "string" },
{ "username", "string" },
},
},
NamedOutputs =
{
{ "string", "any" },
},
Output = new[]
{
"string",
},
Parameters = new[]
{
{
{ "name", "string" },
{ "type", "Credential" },
{ "password", "string" },
{ "username", "string" },
},
},
Retention = "string",
ScriptCmdletId = "string",
ScriptExecutionName = "string",
});
example, err := avs.NewScriptExecution(ctx, "scriptExecutionResource", &avs.ScriptExecutionArgs{
PrivateCloudName: "string",
ResourceGroupName: "string",
Timeout: "string",
FailureReason: "string",
HiddenParameters: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"type": "Credential",
"password": "string",
"username": "string",
},
},
NamedOutputs: map[string]interface{}{
"string": "any",
},
Output: []string{
"string",
},
Parameters: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"type": "Credential",
"password": "string",
"username": "string",
},
},
Retention: "string",
ScriptCmdletId: "string",
ScriptExecutionName: "string",
})
var scriptExecutionResource = new ScriptExecution("scriptExecutionResource", ScriptExecutionArgs.builder()
.privateCloudName("string")
.resourceGroupName("string")
.timeout("string")
.failureReason("string")
.hiddenParameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.namedOutputs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.output("string")
.parameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.retention("string")
.scriptCmdletId("string")
.scriptExecutionName("string")
.build());
script_execution_resource = azure_native.avs.ScriptExecution("scriptExecutionResource",
private_cloud_name=string,
resource_group_name=string,
timeout=string,
failure_reason=string,
hidden_parameters=[{
name: string,
type: Credential,
password: string,
username: string,
}],
named_outputs={
string: any,
},
output=[string],
parameters=[{
name: string,
type: Credential,
password: string,
username: string,
}],
retention=string,
script_cmdlet_id=string,
script_execution_name=string)
const scriptExecutionResource = new azure_native.avs.ScriptExecution("scriptExecutionResource", {
privateCloudName: "string",
resourceGroupName: "string",
timeout: "string",
failureReason: "string",
hiddenParameters: [{
name: "string",
type: "Credential",
password: "string",
username: "string",
}],
namedOutputs: {
string: "any",
},
output: ["string"],
parameters: [{
name: "string",
type: "Credential",
password: "string",
username: "string",
}],
retention: "string",
scriptCmdletId: "string",
scriptExecutionName: "string",
});
type: azure-native:avs:ScriptExecution
properties:
failureReason: string
hiddenParameters:
- name: string
password: string
type: Credential
username: string
namedOutputs:
string: any
output:
- string
parameters:
- name: string
password: string
type: Credential
username: string
privateCloudName: string
resourceGroupName: string
retention: string
scriptCmdletId: string
scriptExecutionName: string
timeout: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScriptExecution resource accepts the following input properties:
- Private
Cloud Name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Timeout
This property is required. string - Time limit for execution
- Failure
Reason string - Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
- List<object>
- Parameters that will be hidden/not visible to ARM, such as passwords and credentials
- Named
Outputs 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
- Script
Cmdlet stringId - A reference to the script cmdlet resource if user is running a AVS script
- Script
Execution Name Changes to this property will trigger replacement.
- Name of the user-invoked script execution resource
- Private
Cloud Name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Timeout
This property is required. string - Time limit for execution
- Failure
Reason string - Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
- []interface{}
- Parameters that will be hidden/not visible to ARM, such as passwords and credentials
- Named
Outputs 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
- Script
Cmdlet stringId - A reference to the script cmdlet resource if user is running a AVS script
- Script
Execution Name Changes to this property will trigger replacement.
- Name of the user-invoked script execution resource
- private
Cloud Name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- timeout
This property is required. String - Time limit for execution
- failure
Reason String - Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
- List<Object>
- Parameters that will be hidden/not visible to ARM, such as passwords and credentials
- named
Outputs 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
- script
Cmdlet StringId - A reference to the script cmdlet resource if user is running a AVS script
- script
Execution Name Changes to this property will trigger replacement.
- Name of the user-invoked script execution resource
- private
Cloud Name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- timeout
This property is required. string - Time limit for execution
- failure
Reason string - Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
- (PSCredential
Execution Parameter | Script Secure String Execution Parameter Args | Script String Execution Parameter Args)[] - Parameters that will be hidden/not visible to ARM, such as passwords and credentials
- named
Outputs {[key: string]: any} - User-defined dictionary.
- output string[]
- Standard output stream from the powershell execution
- parameters
(PSCredential
Execution Parameter | Script Secure String Execution Parameter Args | Script String Execution Parameter Args)[] - Parameters the script will accept
- retention string
- Time to live for the resource. If not provided, will be available for 60 days
- script
Cmdlet stringId - A reference to the script cmdlet resource if user is running a AVS script
- script
Execution Name Changes to this property will trigger replacement.
- Name of the user-invoked script execution resource
- private_
cloud_ name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- timeout
This property is required. 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
- Sequence[Union[PSCredential
Execution Parameter Args, Script Secure String Execution Parameter Args, Script String Execution Parameter Args]] - 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[PSCredential
Execution Parameter Args, Script Secure String Execution Parameter Args, Script String Execution Parameter Args]] - Parameters the script will accept
- retention str
- Time to live for the resource. If not provided, will be available for 60 days
- script_
cmdlet_ strid - A reference to the script cmdlet resource if user is running a AVS script
- script_
execution_ name Changes to this property will trigger replacement.
- Name of the user-invoked script execution resource
- private
Cloud Name This property is required. Changes to this property will trigger replacement.
- The name of the private cloud.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- timeout
This property is required. String - Time limit for execution
- failure
Reason String - Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
- List<Property Map | Property Map | Property Map>
- Parameters that will be hidden/not visible to ARM, such as passwords and credentials
- named
Outputs 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
- script
Cmdlet StringId - A reference to the script cmdlet resource if user is running a AVS script
- script
Execution Name Changes to this property will trigger replacement.
- 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
- Finished
At 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.
- Provisioning
State string - The state of the script execution resource
- Started
At string - Time the script execution was started
- Submitted
At 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
- Finished
At 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.
- Provisioning
State string - The state of the script execution resource
- Started
At string - Time the script execution was started
- Submitted
At 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
- finished
At 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.
- provisioning
State String - The state of the script execution resource
- started
At String - Time the script execution was started
- submitted
At 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
- finished
At 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.
- provisioning
State string - The state of the script execution resource
- started
At string - Time the script execution was started
- submitted
At 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
- finished
At 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.
- provisioning
State String - The state of the script execution resource
- started
At String - Time the script execution was started
- submitted
At 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, PSCredentialExecutionParameterArgs
PSCredentialExecutionParameterResponse, PSCredentialExecutionParameterResponseArgs
ScriptSecureStringExecutionParameter, ScriptSecureStringExecutionParameterArgs
- Name
This property is required. string - The parameter name
- Secure
Value string - A secure value for the passed parameter, not to be stored in logs
- Name
This property is required. string - The parameter name
- Secure
Value string - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. String - The parameter name
- secure
Value String - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. string - The parameter name
- secure
Value string - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. str - The parameter name
- secure_
value str - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. String - The parameter name
- secure
Value String - A secure value for the passed parameter, not to be stored in logs
ScriptSecureStringExecutionParameterResponse, ScriptSecureStringExecutionParameterResponseArgs
- Name
This property is required. string - The parameter name
- Secure
Value string - A secure value for the passed parameter, not to be stored in logs
- Name
This property is required. string - The parameter name
- Secure
Value string - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. String - The parameter name
- secure
Value String - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. string - The parameter name
- secure
Value string - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. str - The parameter name
- secure_
value str - A secure value for the passed parameter, not to be stored in logs
- name
This property is required. String - The parameter name
- secure
Value String - A secure value for the passed parameter, not to be stored in logs
ScriptStringExecutionParameter, ScriptStringExecutionParameterArgs
ScriptStringExecutionParameterResponse, ScriptStringExecutionParameterResponseArgs
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0