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.v2019_10_01_preview.models._models_py3.DeploymentScriptPropertiesBase
AzureCliScriptProperties
azure.mgmt.resource.deploymentscripts.v2019_10_01_preview.models._models_py3.ScriptConfigurationBase
AzureCliScriptProperties

Constructor

AzureCliScriptProperties(*, retention_interval: datetime.timedelta, az_cli_version: str, primary_script_uri: typing.Union[str, NoneType] = None, supporting_script_uris: typing.Union[typing.List[str], NoneType] = None, script_content: typing.Union[str, NoneType] = None, arguments: typing.Union[str, NoneType] = None, environment_variables: typing.Union[typing.List[_ForwardRef('EnvironmentVariable')], NoneType] = None, force_update_tag: typing.Union[str, NoneType] = None, timeout: typing.Union[datetime.timedelta, NoneType] = 'P1D', container_settings: typing.Union[_ForwardRef('ContainerConfiguration'), NoneType] = None, storage_account_settings: typing.Union[_ForwardRef('StorageAccountConfiguration'), NoneType] = None, cleanup_preference: typing.Union[str, _ForwardRef('CleanupOptions'), NoneType] = 'Always', **kwargs)

Parameters

primary_script_uri
str
Required

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

supporting_script_uris
list[str]
Required

Supporting files for the external script.

script_content
str
Required

Script body.

arguments
str
Required

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

environment_variables
list[EnvironmentVariable]
Required

The environment variables to pass over to the script.

force_update_tag
str
Required

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

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
Required

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

container_settings
ContainerConfiguration
Required

Container settings.

storage_account_settings
StorageAccountConfiguration
Required

Storage Account settings.

cleanup_preference
str or CleanupOptions
Required

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

az_cli_version
str
Required

Required. Azure CLI module version to be used.

Variables

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.