ArmResourcesModelFactory.AzurePowerShellScript Method

Definition

Namespace:

Azure.ResourceManager.Resources.Models

Assembly:

Azure.ResourceManager.Resources.dll

Package:

Azure.ResourceManager.Resources v1.7.3

Source:

ArmResourcesModelFactory.cs

Initializes a new instance of AzurePowerShellScript.

public static Azure.ResourceManager.Resources.Models.AzurePowerShellScript AzurePowerShellScript (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, Azure.ResourceManager.Resources.Models.ArmDeploymentScriptManagedIdentity identity = default, Azure.Core.AzureLocation location = default, System.Collections.Generic.IDictionary<string,string> tags = default, string containerGroupName = default, Azure.ResourceManager.Resources.Models.ScriptStorageConfiguration storageAccountSettings = default, Azure.ResourceManager.Resources.Models.ScriptCleanupOptions? cleanupPreference = default, Azure.ResourceManager.Resources.Models.ScriptProvisioningState? provisioningState = default, Azure.ResourceManager.Resources.Models.ScriptStatus status = default, BinaryData outputs = default, Uri primaryScriptUri = default, System.Collections.Generic.IEnumerable<Uri> supportingScriptUris = default, string scriptContent = default, string arguments = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Resources.Models.ScriptEnvironmentVariable> environmentVariables = default, string forceUpdateTag = default, TimeSpan retentionInterval = default, TimeSpan? timeout = default, string azPowerShellVersion = default);

static member AzurePowerShellScript : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * Azure.ResourceManager.Resources.Models.ArmDeploymentScriptManagedIdentity * Azure.Core.AzureLocation * System.Collections.Generic.IDictionary<string, string> * string * Azure.ResourceManager.Resources.Models.ScriptStorageConfiguration * Nullable<Azure.ResourceManager.Resources.Models.ScriptCleanupOptions> * Nullable<Azure.ResourceManager.Resources.Models.ScriptProvisioningState> * Azure.ResourceManager.Resources.Models.ScriptStatus * BinaryData * Uri * seq<Uri> * string * string * seq<Azure.ResourceManager.Resources.Models.ScriptEnvironmentVariable> * string * TimeSpan * Nullable<TimeSpan> * string -> Azure.ResourceManager.Resources.Models.AzurePowerShellScript

Public Shared Function AzurePowerShellScript (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional identity As ArmDeploymentScriptManagedIdentity = Nothing, Optional location As AzureLocation = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional containerGroupName As String = Nothing, Optional storageAccountSettings As ScriptStorageConfiguration = Nothing, Optional cleanupPreference As Nullable(Of ScriptCleanupOptions) = Nothing, Optional provisioningState As Nullable(Of ScriptProvisioningState) = Nothing, Optional status As ScriptStatus = Nothing, Optional outputs As BinaryData = Nothing, Optional primaryScriptUri As Uri = Nothing, Optional supportingScriptUris As IEnumerable(Of Uri) = Nothing, Optional scriptContent As String = Nothing, Optional arguments As String = Nothing, Optional environmentVariables As IEnumerable(Of ScriptEnvironmentVariable) = Nothing, Optional forceUpdateTag As String = Nothing, Optional retentionInterval As TimeSpan = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional azPowerShellVersion As String = Nothing) As AzurePowerShellScript

Parameters

id

ResourceIdentifier

The id.

name

String

The name.

resourceType

ResourceType

The resourceType.

systemData

SystemData

The systemData.

identity

ArmDeploymentScriptManagedIdentity

Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.

location

AzureLocation

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

tags

IDictionary<String,String>

Resource tags.

containerGroupName

String

Container settings.

storageAccountSettings

ScriptStorageConfiguration

Storage Account settings.

cleanupPreference

Nullable<ScriptCleanupOptions>

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

provisioningState

Nullable<ScriptProvisioningState>

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

status

ScriptStatus

Contains the results of script execution.

outputs

BinaryData

List of script outputs.

primaryScriptUri

Uri

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

supportingScriptUris

IEnumerable<Uri>

Supporting files for the external script.

scriptContent

String

Script body.

arguments

String

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

environmentVariables

IEnumerable<ScriptEnvironmentVariable>

The environment variables to pass over to the script.

forceUpdateTag

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.

retentionInterval

TimeSpan

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

timeout

Nullable<TimeSpan>

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

azPowerShellVersion

String

Azure PowerShell module version to be used.

Returns

AzurePowerShellScript

A new AzurePowerShellScript instance for mocking.