AzurePowerShellScript Class

Definition

Namespace:

Microsoft.Azure.Management.ResourceManager.Models

Assembly:

Microsoft.Azure.Management.ResourceManager.dll

Package:

Microsoft.Azure.Management.ResourceManager v3.17.4-preview

Object model for the Azure PowerShell script.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("AzurePowerShell")]
public class AzurePowerShellScript : Microsoft.Azure.Management.ResourceManager.Models.DeploymentScript

[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("AzurePowerShell")>]
type AzurePowerShellScript = class
    inherit DeploymentScript

Public Class AzurePowerShellScript
Inherits DeploymentScript

Inheritance

Object

AzureResourceBase

DeploymentScript

AzurePowerShellScript

Attributes

JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

AzurePowerShellScript()	Initializes a new instance of the AzurePowerShellScript class.
AzurePowerShellScript(String, TimeSpan, String, String, String, String, ManagedServiceIdentity, IDictionary<String,String>, SystemData, ContainerConfiguration, StorageAccountConfiguration, String, String, ScriptStatus, IDictionary<String,Object>, String, IList<String>, String, String, IList<EnvironmentVariable>, String, Nullable<TimeSpan>)	Initializes a new instance of the AzurePowerShellScript class.

Properties

Arguments	Gets or sets command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
AzPowerShellVersion	Gets or sets azure PowerShell module version to be used.
CleanupPreference	Gets or sets the clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. Possible values include: 'Always', 'OnSuccess', 'OnExpiration'
ContainerSettings	Gets or sets container settings.
EnvironmentVariables	Gets or sets the environment variables to pass over to the script.
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.
Id	Gets string Id used to locate any resource on Azure. (Inherited from AzureResourceBase)
Identity	Gets or sets optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. (Inherited from DeploymentScript)
Location	Gets or sets the location of the ACI and the storage account for the deployment script. (Inherited from DeploymentScript)
Name	Gets name of this resource. (Inherited from AzureResourceBase)
Outputs	Gets list of script outputs.
PrimaryScriptUri	Gets or sets uri for the script. This is the entry point for the external script.
ProvisioningState	Gets state of the script execution. This only appears in the response. Possible values include: 'Creating', 'ProvisioningResources', 'Running', 'Succeeded', 'Failed', 'Canceled'
RetentionInterval	Gets or sets 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 P7D means one week).
ScriptContent	Gets or sets script body.
Status	Gets contains the results of script execution.
StorageAccountSettings	Gets or sets storage Account settings.
SupportingScriptUris	Gets or sets supporting files for the external script.
SystemData	Gets the system metadata related to this resource. (Inherited from DeploymentScript)
Tags	Gets or sets resource tags. (Inherited from DeploymentScript)
Timeout	Gets or sets maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H
Type	Gets type of this resource. (Inherited from AzureResourceBase)

Methods

Validate()

Validate the object.