azure.mgmt.resource.deploymentscripts.v2020_10_01.models package¶
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.AzureCliScript(*, location: str, retention_interval: datetime.timedelta, az_cli_version: str, identity: Optional[ManagedServiceIdentity] = None, tags: Optional[Dict[str, str]] = None, container_settings: Optional[ContainerConfiguration] = None, storage_account_settings: Optional[StorageAccountConfiguration] = None, cleanup_preference: Union[str, CleanupOptions, None] = None, 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[EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, **kwargs)[source]¶ 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 Azure.
- Variables
name (str) – Name of this resource.
system_data (SystemData) – The system metadata related to this resource.
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.
- Parameters
identity (ManagedServiceIdentity) – Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
location (str) – Required. The location of the ACI and the storage account for the deployment script.
kind (str or ScriptType) – Required. Type of the script.Constant filled by server. Possible values include: “AzurePowerShell”, “AzureCLI”.
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”.
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 P7D means one week).
timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H.
az_cli_version (str) – Required. Azure CLI module version to be used.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.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[EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, container_settings: Optional[ContainerConfiguration] = None, storage_account_settings: Optional[StorageAccountConfiguration] = None, cleanup_preference: Union[str, CleanupOptions, None] = None, **kwargs)[source]¶ 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.
- Parameters
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 P7D means one week).
timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H.
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”.
az_cli_version (str) – 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.AzurePowerShellScript(*, location: str, retention_interval: datetime.timedelta, az_power_shell_version: str, identity: Optional[ManagedServiceIdentity] = None, tags: Optional[Dict[str, str]] = None, container_settings: Optional[ContainerConfiguration] = None, storage_account_settings: Optional[StorageAccountConfiguration] = None, cleanup_preference: Union[str, CleanupOptions, None] = None, 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[EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, **kwargs)[source]¶ 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 Azure.
- Variables
name (str) – Name of this resource.
system_data (SystemData) – The system metadata related to this resource.
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.
- Parameters
identity (ManagedServiceIdentity) – Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
location (str) – Required. The location of the ACI and the storage account for the deployment script.
kind (str or ScriptType) – Required. Type of the script.Constant filled by server. Possible values include: “AzurePowerShell”, “AzureCLI”.
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”.
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 P7D means one week).
timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H.
az_power_shell_version (str) – Required. Azure PowerShell module version to be used.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.AzurePowerShellScriptProperties(*, retention_interval: datetime.timedelta, az_power_shell_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[EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, container_settings: Optional[ContainerConfiguration] = None, storage_account_settings: Optional[StorageAccountConfiguration] = None, cleanup_preference: Union[str, CleanupOptions, None] = None, **kwargs)[source]¶ 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 Azure.
- Parameters
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 P7D means one week).
timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H.
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”.
az_power_shell_version (str) – Required. Azure PowerShell 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.AzureResourceBase(**kwargs)[source]¶ Common properties for all Azure resources.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ContainerConfiguration(*, container_group_name: Optional[str] = None, **kwargs)[source]¶ Settings to customize ACI container instance.
- Parameters
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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.DeploymentScript(*, location: str, identity: Optional[ManagedServiceIdentity] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ 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 Azure.
- Variables
- Parameters
identity (ManagedServiceIdentity) – Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
location (str) – Required. The location of the ACI and the storage account for the deployment script.
kind (str or ScriptType) – Required. Type of the script.Constant filled by server. Possible values include: “AzurePowerShell”, “AzureCLI”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.DeploymentScriptListResult(*, value: Optional[List[DeploymentScript]] = None, **kwargs)[source]¶ List of deployment scripts.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[DeploymentScript]) – An array of deployment scripts.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.DeploymentScriptPropertiesBase(*, container_settings: Optional[ContainerConfiguration] = None, storage_account_settings: Optional[StorageAccountConfiguration] = None, cleanup_preference: Union[str, CleanupOptions, None] = None, **kwargs)[source]¶ Common properties for the deployment script.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
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”.
- 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.DeploymentScriptUpdateParameter(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Deployment script parameters to be updated.
Variables are only populated by the server, and will be ignored when sending a request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.DeploymentScriptsError(*, error: Optional[ErrorResponse] = None, **kwargs)[source]¶ Deployment scripts error response.
- Parameters
error (ErrorResponse) – The resource management error response.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.EnvironmentVariable(*, name: str, value: Optional[str] = None, secure_value: Optional[str] = None, **kwargs)[source]¶ The environment variable to pass to the script in the container instance.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ErrorAdditionalInfo(**kwargs)[source]¶ The resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ErrorResponse(**kwargs)[source]¶ The resource management error response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
message (str) – The error message.
target (str) – The error target.
details (list[ErrorResponse]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ManagedServiceIdentity(*, type: Union[str, ManagedServiceIdentityType, None] = None, user_assigned_identities: Optional[Dict[str, UserAssignedIdentity]] = None, **kwargs)[source]¶ Managed identity generic object.
- Parameters
type (str or ManagedServiceIdentityType) – Type of the managed identity. Possible values include: “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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ScriptConfigurationBase(*, retention_interval: datetime.timedelta, 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[EnvironmentVariable]] = None, force_update_tag: Optional[str] = None, timeout: Optional[datetime.timedelta] = None, **kwargs)[source]¶ Common configuration settings for both Azure PowerShell and Azure CLI scripts.
All required parameters must be populated in order to send to Azure.
- Parameters
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 P7D means one week).
timeout (timedelta) – Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ScriptLog(**kwargs)[source]¶ Script execution log object.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ScriptLogsList(*, value: Optional[List[ScriptLog]] = None, **kwargs)[source]¶ Deployment script execution logs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ScriptStatus(*, error: Optional[ErrorResponse] = None, **kwargs)[source]¶ Generic object modeling results of script execution.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
error (ErrorResponse) – Error that is relayed from the script execution.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.StorageAccountConfiguration(*, storage_account_name: Optional[str] = None, storage_account_key: Optional[str] = None, **kwargs)[source]¶ Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Union[str, CreatedByType, None] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Union[str, CreatedByType, None] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Metadata pertaining to creation and last modification of the resource.
- Parameters
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “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. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
last_modified_at (datetime) – The type of identity that last modified the resource.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.UserAssignedIdentity(*, principal_id: Optional[str] = None, client_id: Optional[str] = None, **kwargs)[source]¶ User-assigned managed identity.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.CleanupOptions[source]¶ 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.v2020_10_01.models.CreatedByType[source]¶ The type of identity that created the resource.
-
APPLICATION= 'Application'¶
-
KEY= 'Key'¶
-
MANAGED_IDENTITY= 'ManagedIdentity'¶
-
USER= 'User'¶
-
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ManagedServiceIdentityType[source]¶ Type of the managed identity.
-
USER_ASSIGNED= 'UserAssigned'¶
-
-
class
azure.mgmt.resource.deploymentscripts.v2020_10_01.models.ScriptProvisioningState[source]¶ State of the script execution. This only appears in the response.
-
CANCELED= 'Canceled'¶
-
CREATING= 'Creating'¶
-
FAILED= 'Failed'¶
-
PROVISIONING_RESOURCES= 'ProvisioningResources'¶
-
RUNNING= 'Running'¶
-
SUCCEEDED= 'Succeeded'¶
-