AzureCliScriptProperties Class

Properties of the Azure CLI script object.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.resource.deploymentscripts.v2020_10_01.models._models_py3.DeploymentScriptPropertiesBase

AzureCliScriptProperties

azure.mgmt.resource.deploymentscripts.v2020_10_01.models._models_py3.ScriptConfigurationBase

AzureCliScriptProperties

Constructor

AzureCliScriptProperties(*, retention_interval: datetime.timedelta, az_cli_version: str, primary_script_uri: Optional[str] = None, supporting_script_uris: Optional[List[str]] = None, script_content: Optional[str] = None, arguments: Optional[str] = None, environment_variables: Optional[List[azure.mgmt.resource.deploymentscripts.v2020_10_01.models._models_py3.EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = 'P1D', container_settings: Optional[azure.mgmt.resource.deploymentscripts.v2020_10_01.models._models_py3.ContainerConfiguration] = None, storage_account_settings: Optional[azure.mgmt.resource.deploymentscripts.v2020_10_01.models._models_py3.StorageAccountConfiguration] = None, cleanup_preference: Optional[Union[str, azure.mgmt.resource.deploymentscripts.v2020_10_01.models._deployment_scripts_client_enums.CleanupOptions]] = 'Always', **kwargs)

Variables

primary_script_uri

str

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

supporting_script_uris

list[str]

Supporting files for the external script.

script_content

str

Script body.

arguments

str

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

environment_variables

list[EnvironmentVariable]

The environment variables to pass over to the script.

force_update_tag

str

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.

retention_interval

timedelta

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

timedelta

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

container_settings

ContainerConfiguration

Container settings.

storage_account_settings

StorageAccountConfiguration

Storage Account settings.

cleanup_preference

str or CleanupOptions

The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. Possible values include: "Always", "OnSuccess", "OnExpiration". Default value: "Always".

provisioning_state

str or ScriptProvisioningState

State of the script execution. This only appears in the response. Possible values include: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", "Canceled".

status

ScriptStatus

Contains the results of script execution.

outputs

dict[str, any]

List of script outputs.

az_cli_version

str

Required. Azure CLI module version to be used.