azure.mgmt.resource.deploymentscripts.v2023_08_01.models module

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.AzureCliScript(*, location: str, retention_interval: timedelta, az_cli_version: str, identity: _models.ManagedServiceIdentity | None = None, tags: Dict[str, str] | None = None, container_settings: _models.ContainerConfiguration | None = None, storage_account_settings: _models.StorageAccountConfiguration | None = None, cleanup_preference: str | _models.CleanupOptions = 'Always', primary_script_uri: str | None = None, supporting_script_uris: List[str] | None = None, script_content: str | None = None, arguments: str | None = None, environment_variables: List[_models.EnvironmentVariable] | None = None, force_update_tag: str | None = None, timeout: timedelta = 'P1D', **kwargs: Any)[source]

Bases: DeploymentScript

Object model for the Azure CLI script.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

  • kind (str or ScriptType) – Type of the script. Required. Known values are: “AzurePowerShell” and “AzureCLI”.

  • system_data (SystemData) – The system metadata related to this resource.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • provisioning_state (str or ScriptProvisioningState) – State of the script execution. This only appears in the response. Known values are: “Creating”, “ProvisioningResources”, “Running”, “Succeeded”, “Failed”, and “Canceled”.

  • status (ScriptStatus) – Contains the results of script execution.

  • outputs (dict[str, JSON]) – List of script outputs.

  • 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) – 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). Required.

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

  • az_cli_version (str) – Azure CLI module version to be used. Required.

Keyword Arguments:

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • 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) – 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). Required.

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

  • az_cli_version (str) – Azure CLI module version to be used. Required.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.AzureCliScriptProperties(*, retention_interval: timedelta, az_cli_version: str, primary_script_uri: str | None = None, supporting_script_uris: List[str] | None = None, script_content: str | None = None, arguments: str | None = None, environment_variables: List[_models.EnvironmentVariable] | None = None, force_update_tag: str | None = None, timeout: timedelta = 'P1D', container_settings: _models.ContainerConfiguration | None = None, storage_account_settings: _models.StorageAccountConfiguration | None = None, cleanup_preference: str | _models.CleanupOptions = 'Always', **kwargs: Any)[source]

Bases: DeploymentScriptPropertiesBase, ScriptConfigurationBase

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

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

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • provisioning_state (str or ScriptProvisioningState) – State of the script execution. This only appears in the response. Known values are: “Creating”, “ProvisioningResources”, “Running”, “Succeeded”, “Failed”, and “Canceled”.

  • status (ScriptStatus) – Contains the results of script execution.

  • outputs (dict[str, JSON]) – List of script outputs.

  • az_cli_version (str) – Azure CLI module version to be used. Required.

Keyword Arguments:

  • 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) – 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). Required.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • az_cli_version (str) – Azure CLI module version to be used. Required.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.AzurePowerShellScript(*, location: str, retention_interval: timedelta, az_power_shell_version: str, identity: _models.ManagedServiceIdentity | None = None, tags: Dict[str, str] | None = None, container_settings: _models.ContainerConfiguration | None = None, storage_account_settings: _models.StorageAccountConfiguration | None = None, cleanup_preference: str | _models.CleanupOptions = 'Always', primary_script_uri: str | None = None, supporting_script_uris: List[str] | None = None, script_content: str | None = None, arguments: str | None = None, environment_variables: List[_models.EnvironmentVariable] | None = None, force_update_tag: str | None = None, timeout: timedelta = 'P1D', **kwargs: Any)[source]

Bases: DeploymentScript

Object model for the Azure PowerShell script.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

  • kind (str or ScriptType) – Type of the script. Required. Known values are: “AzurePowerShell” and “AzureCLI”.

  • system_data (SystemData) – The system metadata related to this resource.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • provisioning_state (str or ScriptProvisioningState) – State of the script execution. This only appears in the response. Known values are: “Creating”, “ProvisioningResources”, “Running”, “Succeeded”, “Failed”, and “Canceled”.

  • status (ScriptStatus) – Contains the results of script execution.

  • outputs (dict[str, JSON]) – List of script outputs.

  • 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) – 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). Required.

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

  • az_power_shell_version (str) – Azure PowerShell module version to be used. Required.

Keyword Arguments:

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • 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) – 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). Required.

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

  • az_power_shell_version (str) – Azure PowerShell module version to be used. Required.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.AzurePowerShellScriptProperties(*, retention_interval: timedelta, az_power_shell_version: str, primary_script_uri: str | None = None, supporting_script_uris: List[str] | None = None, script_content: str | None = None, arguments: str | None = None, environment_variables: List[_models.EnvironmentVariable] | None = None, force_update_tag: str | None = None, timeout: timedelta = 'P1D', container_settings: _models.ContainerConfiguration | None = None, storage_account_settings: _models.StorageAccountConfiguration | None = None, cleanup_preference: str | _models.CleanupOptions = 'Always', **kwargs: Any)[source]

Bases: DeploymentScriptPropertiesBase, ScriptConfigurationBase

Properties of the Azure PowerShell 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 server.

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

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • provisioning_state (str or ScriptProvisioningState) – State of the script execution. This only appears in the response. Known values are: “Creating”, “ProvisioningResources”, “Running”, “Succeeded”, “Failed”, and “Canceled”.

  • status (ScriptStatus) – Contains the results of script execution.

  • outputs (dict[str, JSON]) – List of script outputs.

  • az_power_shell_version (str) – Azure PowerShell module version to be used. Required.

Keyword Arguments:

  • 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) – 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). Required.

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • az_power_shell_version (str) – Azure PowerShell module version to be used. Required.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.AzureResourceBase(**kwargs: Any)[source]

Bases: Model

Common properties for all Azure resources.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.CleanupOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

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

ALWAYS = 'Always'
ON_EXPIRATION = 'OnExpiration'
ON_SUCCESS = 'OnSuccess'
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ContainerConfiguration(*, container_group_name: str | None = None, subnet_ids: List[_models.ContainerGroupSubnetId] | None = None, **kwargs: Any)[source]

Bases: Model

Settings to customize ACI container instance.

Variables:

  • container_group_name (str) – Container group name, if not specified then the name will get auto-generated. Not specifying a ‘containerGroupName’ indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use ‘containerGroupName’ when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. ‘containerGroupName’ property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a ‘containerGroupName’, add the following object to properties: { “containerSettings”: { “containerGroupName”: “contoso-container” } }. If you do not want to specify a ‘containerGroupName’ then do not add ‘containerSettings’ property.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

Keyword Arguments:

  • container_group_name (str) – Container group name, if not specified then the name will get auto-generated. Not specifying a ‘containerGroupName’ indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use ‘containerGroupName’ when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. ‘containerGroupName’ property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a ‘containerGroupName’, add the following object to properties: { “containerSettings”: { “containerGroupName”: “contoso-container” } }. If you do not want to specify a ‘containerGroupName’ then do not add ‘containerSettings’ property.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ContainerGroupSubnetId(*, id: str, name: str | None = None, **kwargs: Any)[source]

Bases: Model

Container group subnet information.

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

Variables:

  • id (str) – Resource ID of subnet. Required.

  • name (str) – Friendly name for the subnet.

Keyword Arguments:

  • id (str) – Resource ID of subnet. Required.

  • name (str) – Friendly name for the subnet.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.DeploymentScript(*, location: str, identity: _models.ManagedServiceIdentity | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Deployment script object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureCliScript, AzurePowerShellScript

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

  • kind (str or ScriptType) – Type of the script. Required. Known values are: “AzurePowerShell” and “AzureCLI”.

  • system_data (SystemData) – The system metadata related to this resource.

Keyword Arguments:

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

  • location (str) – The location of the ACI and the storage account for the deployment script. Required.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.DeploymentScriptListResult(*, value: List[_models.DeploymentScript] | None = None, **kwargs: Any)[source]

Bases: Model

List of deployment scripts.

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

Variables:

  • value (list[DeploymentScript]) – An array of deployment scripts.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[DeploymentScript]) – An array of deployment scripts.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.DeploymentScriptPropertiesBase(*, container_settings: _models.ContainerConfiguration | None = None, storage_account_settings: _models.StorageAccountConfiguration | None = None, cleanup_preference: str | _models.CleanupOptions = 'Always', **kwargs: Any)[source]

Bases: Model

Common properties for the deployment script.

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

Variables:

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

  • provisioning_state (str or ScriptProvisioningState) – State of the script execution. This only appears in the response. Known values are: “Creating”, “ProvisioningResources”, “Running”, “Succeeded”, “Failed”, and “Canceled”.

  • status (ScriptStatus) – Contains the results of script execution.

  • outputs (dict[str, JSON]) – List of script outputs.

Keyword Arguments:

  • 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’. Known values are: “Always”, “OnSuccess”, and “OnExpiration”.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.DeploymentScriptUpdateParameter(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Deployment script parameters to be updated.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • tags (dict[str, str]) – Resource tags to be updated.

Keyword Arguments:

tags (dict[str, str]) – Resource tags to be updated.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.DeploymentScriptsError(*, error: _models.ErrorResponse | None = None, **kwargs: Any)[source]

Bases: Model

Deployment scripts error response.

Variables:

error (ErrorResponse) – Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Keyword Arguments:

error (ErrorResponse) – Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.EnvironmentVariable(*, name: str, value: str | None = None, secure_value: str | None = None, **kwargs: Any)[source]

Bases: Model

The environment variable to pass to the script in the container instance.

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

Variables:

  • name (str) – The name of the environment variable. Required.

  • value (str) – The value of the environment variable.

  • secure_value (str) – The value of the secure environment variable.

Keyword Arguments:

  • name (str) – The name of the environment variable. Required.

  • value (str) – The value of the environment variable.

  • secure_value (str) – The value of the secure environment variable.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

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

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ErrorResponse(**kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

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

Variables:
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ManagedServiceIdentity(*, type: str | _models.ManagedServiceIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

Managed identity generic object.

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

Variables:

  • type (str or ManagedServiceIdentityType) – Type of the managed identity. “UserAssigned”

  • tenant_id (str) – ID of the Azure Active Directory.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.

Keyword Arguments:

  • type (str or ManagedServiceIdentityType) – Type of the managed identity. “UserAssigned”

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of the managed identity.

USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptConfigurationBase(*, retention_interval: timedelta, primary_script_uri: str | None = None, supporting_script_uris: List[str] | None = None, script_content: str | None = None, arguments: str | None = None, environment_variables: List[_models.EnvironmentVariable] | None = None, force_update_tag: str | None = None, timeout: timedelta = 'P1D', **kwargs: Any)[source]

Bases: Model

Common configuration settings for both Azure PowerShell and Azure CLI scripts.

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

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

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

Keyword Arguments:

  • 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) – 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). Required.

  • timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptLog(**kwargs: Any)[source]

Bases: AzureResourceBase

Script execution log object.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • log (str) – Script execution logs in text format.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptLogsList(*, value: List[_models.ScriptLog] | None = None, **kwargs: Any)[source]

Bases: Model

Deployment script execution logs.

Variables:

value (list[ScriptLog]) – Deployment scripts logs.

Keyword Arguments:

value (list[ScriptLog]) – Deployment scripts logs.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

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

CANCELED = 'Canceled'
CREATING = 'Creating'
FAILED = 'Failed'
PROVISIONING_RESOURCES = 'ProvisioningResources'
RUNNING = 'Running'
SUCCEEDED = 'Succeeded'
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptStatus(*, error: _models.ErrorResponse | None = None, **kwargs: Any)[source]

Bases: Model

Generic object modeling results of script execution.

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

Variables:

  • container_instance_id (str) – ACI resource Id.

  • storage_account_id (str) – Storage account resource Id.

  • start_time (datetime) – Start time of the script execution.

  • end_time (datetime) – End time of the script execution.

  • expiration_time (datetime) – Time the deployment script resource will expire.

  • error (ErrorResponse) – Error that is relayed from the script execution.

Keyword Arguments:

error (ErrorResponse) – Error that is relayed from the script execution.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.ScriptType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of the script.

AZURE_CLI = 'AzureCLI'
AZURE_POWER_SHELL = 'AzurePowerShell'
class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.StorageAccountConfiguration(*, storage_account_name: str | None = None, storage_account_key: str | None = None, **kwargs: Any)[source]

Bases: Model

Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage.

Variables:

  • storage_account_name (str) – The storage account name.

  • storage_account_key (str) – The storage account access key.

Keyword Arguments:

  • storage_account_name (str) – The storage account name.

  • storage_account_key (str) – The storage account access key.

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.resource.deploymentscripts.v2023_08_01.models.UserAssignedIdentity(**kwargs: Any)[source]

Bases: Model

User-assigned managed identity.

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

Variables:

  • principal_id (str) – Azure Active Directory principal ID associated with this identity.

  • client_id (str) – Client App Id associated with this identity.