Class AzureCliScript

Object model for the Azure CLI script.

Inheritance
Azure.ResourceManager.Models.Resource
DeploymentScriptData
AzureCliScript
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Resources.dll
Syntax
public class AzureCliScript : Azure.ResourceManager.Resources.DeploymentScriptData

Constructors

AzureCliScript(String, TimeSpan, String)

Initializes a new instance of AzureCliScript.

Declaration
public AzureCliScript (string location, TimeSpan retentionInterval, string azCliVersion);
Parameters
System.String location

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

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).
System.String azCliVersion

Azure CLI module version to be used.
Exceptions
System.ArgumentNullException

location or azCliVersion is null.

Properties

Arguments

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

Declaration
public string Arguments { get; set; }
Property Value
System.String

AzCliVersion

Azure CLI module version to be used.

Declaration
public string AzCliVersion { get; set; }
Property Value
System.String

CleanupPreference

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

Declaration
public Nullable<Azure.ResourceManager.Resources.Models.CleanupOptions> CleanupPreference { get; set; }
Property Value
System.Nullable<CleanupOptions>

ContainerSettings

Container settings.

Declaration
public Azure.ResourceManager.Resources.Models.ContainerConfiguration ContainerSettings { get; set; }
Property Value
ContainerConfiguration

EnvironmentVariables

The environment variables to pass over to the script.

Declaration
public System.Collections.Generic.IList<Azure.ResourceManager.Resources.Models.EnvironmentVariable> EnvironmentVariables { get; }
Property Value
System.Collections.Generic.IList<EnvironmentVariable>

ForceUpdateTag

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.

Declaration
public string ForceUpdateTag { get; set; }
Property Value
System.String

Outputs

List of script outputs.

Declaration
public System.Collections.Generic.IReadOnlyDictionary<string,object> Outputs { get; }
Property Value
System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object>

PrimaryScriptUri

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

Declaration
public string PrimaryScriptUri { get; set; }
Property Value
System.String

ProvisioningState

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

Declaration
public Nullable<Azure.ResourceManager.Resources.Models.ScriptProvisioningState> ProvisioningState { get; }
Property Value
System.Nullable<ScriptProvisioningState>

RetentionInterval

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).

Declaration
public TimeSpan RetentionInterval { get; set; }
Property Value
System.TimeSpan

ScriptContent

Script body.

Declaration
public string ScriptContent { get; set; }
Property Value
System.String

Status

Contains the results of script execution.

Declaration
public Azure.ResourceManager.Resources.Models.ScriptStatus Status { get; }
Property Value
ScriptStatus

StorageAccountSettings

Storage Account settings.

Declaration
public Azure.ResourceManager.Resources.Models.StorageAccountConfiguration StorageAccountSettings { get; set; }
Property Value
StorageAccountConfiguration

SupportingScriptUris

Supporting files for the external script.

Declaration
public System.Collections.Generic.IList<string> SupportingScriptUris { get; }
Property Value
System.Collections.Generic.IList<System.String>

Timeout

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

Declaration
public Nullable<TimeSpan> Timeout { get; set; }
Property Value
System.Nullable<System.TimeSpan>