# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
import sys
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from .. import _serialization
if sys.version_info >= (3, 9):
from collections.abc import MutableMapping
else:
from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object
[docs]class CloudErrorBody(_serialization.Model):
"""An error response from the Azure VM Image Builder service.
:ivar code: An identifier for the error. Codes are invariant and are intended to be consumed
programmatically.
:vartype code: str
:ivar message: A message describing the error, intended to be suitable for display in a user
interface.
:vartype message: str
:ivar target: The target of the particular error. For example, the name of the property in
error.
:vartype target: str
:ivar details: A list of additional details about the error.
:vartype details: list[~azure.mgmt.imagebuilder.models.CloudErrorBody]
"""
_attribute_map = {
"code": {"key": "code", "type": "str"},
"message": {"key": "message", "type": "str"},
"target": {"key": "target", "type": "str"},
"details": {"key": "details", "type": "[CloudErrorBody]"},
}
def __init__(
self,
*,
code: Optional[str] = None,
message: Optional[str] = None,
target: Optional[str] = None,
details: Optional[List["_models.CloudErrorBody"]] = None,
**kwargs
):
"""
:keyword code: An identifier for the error. Codes are invariant and are intended to be consumed
programmatically.
:paramtype code: str
:keyword message: A message describing the error, intended to be suitable for display in a user
interface.
:paramtype message: str
:keyword target: The target of the particular error. For example, the name of the property in
error.
:paramtype target: str
:keyword details: A list of additional details about the error.
:paramtype details: list[~azure.mgmt.imagebuilder.models.CloudErrorBody]
"""
super().__init__(**kwargs)
self.code = code
self.message = message
self.target = target
self.details = details
[docs]class ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties(
_serialization.Model
):
"""ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of user assigned identity.
:vartype principal_id: str
:ivar client_id: The client id of user assigned identity.
:vartype client_id: str
"""
_validation = {
"principal_id": {"readonly": True},
"client_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"client_id": {"key": "clientId", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.principal_id = None
self.client_id = None
[docs]class Resource(_serialization.Model):
"""Common fields that are returned in the response for all Azure Resource Manager resources.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.imagebuilder.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.system_data = None
[docs]class TrackedResource(Resource):
"""The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.
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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.imagebuilder.models.SystemData
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar location: The geo-location where the resource lives. Required.
:vartype location: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"tags": {"key": "tags", "type": "{str}"},
"location": {"key": "location", "type": "str"},
}
def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs):
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword location: The geo-location where the resource lives. Required.
:paramtype location: str
"""
super().__init__(**kwargs)
self.tags = tags
self.location = location
[docs]class ImageTemplate(TrackedResource): # pylint: disable=too-many-instance-attributes
"""Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.
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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.imagebuilder.models.SystemData
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar location: The geo-location where the resource lives. Required.
:vartype location: str
:ivar identity: The identity of the image template, if configured. Required.
:vartype identity: ~azure.mgmt.imagebuilder.models.ImageTemplateIdentity
:ivar source: Specifies the properties used to describe the source image.
:vartype source: ~azure.mgmt.imagebuilder.models.ImageTemplateSource
:ivar customize: Specifies the properties used to describe the customization steps of the
image, like Image source etc.
:vartype customize: list[~azure.mgmt.imagebuilder.models.ImageTemplateCustomizer]
:ivar validate: Configuration options and list of validations to be performed on the resulting
image.
:vartype validate: ~azure.mgmt.imagebuilder.models.ImageTemplatePropertiesValidate
:ivar distribute: The distribution targets where the image output needs to go to.
:vartype distribute: list[~azure.mgmt.imagebuilder.models.ImageTemplateDistributor]
:ivar provisioning_state: Provisioning state of the resource. Known values are: "Creating",
"Updating", "Succeeded", "Failed", and "Deleting".
:vartype provisioning_state: str or ~azure.mgmt.imagebuilder.models.ProvisioningState
:ivar provisioning_error: Provisioning error, if any.
:vartype provisioning_error: ~azure.mgmt.imagebuilder.models.ProvisioningError
:ivar last_run_status: State of 'run' that is currently executing or was last executed.
:vartype last_run_status: ~azure.mgmt.imagebuilder.models.ImageTemplateLastRunStatus
:ivar build_timeout_in_minutes: Maximum duration to wait while building the image template
(includes all customizations, validations, and distributions). Omit or specify 0 to use the
default (4 hours).
:vartype build_timeout_in_minutes: int
:ivar vm_profile: Describes how virtual machine is set up to build images.
:vartype vm_profile: ~azure.mgmt.imagebuilder.models.ImageTemplateVmProfile
:ivar staging_resource_group: The staging resource group id in the same subscription as the
image template that will be used to build the image. If this field is empty, a resource group
with a random name will be created. If the resource group specified in this field doesn't
exist, it will be created with the same name. If the resource group specified exists, it must
be empty and in the same region as the image template. The resource group created will be
deleted during template deletion if this field is empty or the resource group specified doesn't
exist, but if the resource group specified exists the resources created in the resource group
will be deleted during template deletion and the resource group itself will remain.
:vartype staging_resource_group: str
:ivar exact_staging_resource_group: The staging resource group id in the same subscription as
the image template that will be used to build the image. This read-only field differs from
'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is
empty.
:vartype exact_staging_resource_group: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"location": {"required": True},
"identity": {"required": True},
"provisioning_state": {"readonly": True},
"provisioning_error": {"readonly": True},
"last_run_status": {"readonly": True},
"build_timeout_in_minutes": {"maximum": 960, "minimum": 0},
"exact_staging_resource_group": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"tags": {"key": "tags", "type": "{str}"},
"location": {"key": "location", "type": "str"},
"identity": {"key": "identity", "type": "ImageTemplateIdentity"},
"source": {"key": "properties.source", "type": "ImageTemplateSource"},
"customize": {"key": "properties.customize", "type": "[ImageTemplateCustomizer]"},
"validate": {"key": "properties.validate", "type": "ImageTemplatePropertiesValidate"},
"distribute": {"key": "properties.distribute", "type": "[ImageTemplateDistributor]"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"provisioning_error": {"key": "properties.provisioningError", "type": "ProvisioningError"},
"last_run_status": {"key": "properties.lastRunStatus", "type": "ImageTemplateLastRunStatus"},
"build_timeout_in_minutes": {"key": "properties.buildTimeoutInMinutes", "type": "int"},
"vm_profile": {"key": "properties.vmProfile", "type": "ImageTemplateVmProfile"},
"staging_resource_group": {"key": "properties.stagingResourceGroup", "type": "str"},
"exact_staging_resource_group": {"key": "properties.exactStagingResourceGroup", "type": "str"},
}
def __init__(
self,
*,
location: str,
identity: "_models.ImageTemplateIdentity",
tags: Optional[Dict[str, str]] = None,
source: Optional["_models.ImageTemplateSource"] = None,
customize: Optional[List["_models.ImageTemplateCustomizer"]] = None,
validate: Optional["_models.ImageTemplatePropertiesValidate"] = None,
distribute: Optional[List["_models.ImageTemplateDistributor"]] = None,
build_timeout_in_minutes: int = 0,
vm_profile: Optional["_models.ImageTemplateVmProfile"] = None,
staging_resource_group: Optional[str] = None,
**kwargs
):
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword location: The geo-location where the resource lives. Required.
:paramtype location: str
:keyword identity: The identity of the image template, if configured. Required.
:paramtype identity: ~azure.mgmt.imagebuilder.models.ImageTemplateIdentity
:keyword source: Specifies the properties used to describe the source image.
:paramtype source: ~azure.mgmt.imagebuilder.models.ImageTemplateSource
:keyword customize: Specifies the properties used to describe the customization steps of the
image, like Image source etc.
:paramtype customize: list[~azure.mgmt.imagebuilder.models.ImageTemplateCustomizer]
:keyword validate: Configuration options and list of validations to be performed on the
resulting image.
:paramtype validate: ~azure.mgmt.imagebuilder.models.ImageTemplatePropertiesValidate
:keyword distribute: The distribution targets where the image output needs to go to.
:paramtype distribute: list[~azure.mgmt.imagebuilder.models.ImageTemplateDistributor]
:keyword build_timeout_in_minutes: Maximum duration to wait while building the image template
(includes all customizations, validations, and distributions). Omit or specify 0 to use the
default (4 hours).
:paramtype build_timeout_in_minutes: int
:keyword vm_profile: Describes how virtual machine is set up to build images.
:paramtype vm_profile: ~azure.mgmt.imagebuilder.models.ImageTemplateVmProfile
:keyword staging_resource_group: The staging resource group id in the same subscription as the
image template that will be used to build the image. If this field is empty, a resource group
with a random name will be created. If the resource group specified in this field doesn't
exist, it will be created with the same name. If the resource group specified exists, it must
be empty and in the same region as the image template. The resource group created will be
deleted during template deletion if this field is empty or the resource group specified doesn't
exist, but if the resource group specified exists the resources created in the resource group
will be deleted during template deletion and the resource group itself will remain.
:paramtype staging_resource_group: str
"""
super().__init__(tags=tags, location=location, **kwargs)
self.identity = identity
self.source = source
self.customize = customize
self.validate = validate
self.distribute = distribute
self.provisioning_state = None
self.provisioning_error = None
self.last_run_status = None
self.build_timeout_in_minutes = build_timeout_in_minutes
self.vm_profile = vm_profile
self.staging_resource_group = staging_resource_group
self.exact_staging_resource_group = None
[docs]class ImageTemplateCustomizer(_serialization.Model):
"""Describes a unit of image customization.
You probably want to use the sub-classes and not this class directly. Known sub-classes are:
ImageTemplateFileCustomizer, ImageTemplatePowerShellCustomizer, ImageTemplateShellCustomizer,
ImageTemplateRestartCustomizer, ImageTemplateWindowsUpdateCustomizer
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
}
_subtype_map = {
"type": {
"File": "ImageTemplateFileCustomizer",
"PowerShell": "ImageTemplatePowerShellCustomizer",
"Shell": "ImageTemplateShellCustomizer",
"WindowsRestart": "ImageTemplateRestartCustomizer",
"WindowsUpdate": "ImageTemplateWindowsUpdateCustomizer",
}
}
def __init__(self, *, name: Optional[str] = None, **kwargs):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
"""
super().__init__(**kwargs)
self.type: Optional[str] = None
self.name = name
[docs]class ImageTemplateDistributor(_serialization.Model):
"""Generic distribution object.
You probably want to use the sub-classes and not this class directly. Known sub-classes are:
ImageTemplateManagedImageDistributor, ImageTemplateSharedImageDistributor,
ImageTemplateVhdDistributor
All required parameters must be populated in order to send to Azure.
:ivar type: Type of distribution. Required.
:vartype type: str
:ivar run_output_name: The name to be used for the associated RunOutput. Required.
:vartype run_output_name: str
:ivar artifact_tags: Tags that will be applied to the artifact once it has been created/updated
by the distributor.
:vartype artifact_tags: dict[str, str]
"""
_validation = {
"type": {"required": True},
"run_output_name": {"required": True, "pattern": r"^[A-Za-z0-9-_.]{1,64}$"},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"run_output_name": {"key": "runOutputName", "type": "str"},
"artifact_tags": {"key": "artifactTags", "type": "{str}"},
}
_subtype_map = {
"type": {
"ManagedImage": "ImageTemplateManagedImageDistributor",
"SharedImage": "ImageTemplateSharedImageDistributor",
"VHD": "ImageTemplateVhdDistributor",
}
}
def __init__(self, *, run_output_name: str, artifact_tags: Optional[Dict[str, str]] = None, **kwargs):
"""
:keyword run_output_name: The name to be used for the associated RunOutput. Required.
:paramtype run_output_name: str
:keyword artifact_tags: Tags that will be applied to the artifact once it has been
created/updated by the distributor.
:paramtype artifact_tags: dict[str, str]
"""
super().__init__(**kwargs)
self.type: Optional[str] = None
self.run_output_name = run_output_name
self.artifact_tags = artifact_tags
[docs]class ImageTemplateFileCustomizer(ImageTemplateCustomizer):
"""Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
:ivar source_uri: The URI of the file to be uploaded for customizing the VM. It can be a github
link, SAS URI for Azure Storage, etc.
:vartype source_uri: str
:ivar sha256_checksum: SHA256 checksum of the file provided in the sourceUri field above.
:vartype sha256_checksum: str
:ivar destination: The absolute path to a file (with nested directory structures already
created) where the file (from sourceUri) will be uploaded to in the VM.
:vartype destination: str
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"source_uri": {"key": "sourceUri", "type": "str"},
"sha256_checksum": {"key": "sha256Checksum", "type": "str"},
"destination": {"key": "destination", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
source_uri: Optional[str] = None,
sha256_checksum: str = "",
destination: Optional[str] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
:keyword source_uri: The URI of the file to be uploaded for customizing the VM. It can be a
github link, SAS URI for Azure Storage, etc.
:paramtype source_uri: str
:keyword sha256_checksum: SHA256 checksum of the file provided in the sourceUri field above.
:paramtype sha256_checksum: str
:keyword destination: The absolute path to a file (with nested directory structures already
created) where the file (from sourceUri) will be uploaded to in the VM.
:paramtype destination: str
"""
super().__init__(name=name, **kwargs)
self.type: str = "File"
self.source_uri = source_uri
self.sha256_checksum = sha256_checksum
self.destination = destination
[docs]class ImageTemplateIdentity(_serialization.Model):
"""Identity for the image template.
:ivar type: The type of identity used for the image template. The type 'None' will remove any
identities from the image template. Known values are: "UserAssigned" and "None".
:vartype type: str or ~azure.mgmt.imagebuilder.models.ResourceIdentityType
:ivar user_assigned_identities: The list of user identities associated with the image template.
The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:vartype user_assigned_identities: dict[str,
~azure.mgmt.imagebuilder.models.ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties]
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"user_assigned_identities": {
"key": "userAssignedIdentities",
"type": "{ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties}",
},
}
def __init__(
self,
*,
type: Optional[Union[str, "_models.ResourceIdentityType"]] = None,
user_assigned_identities: Optional[
Dict[
str,
"_models.ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties",
]
] = None,
**kwargs
):
"""
:keyword type: The type of identity used for the image template. The type 'None' will remove
any identities from the image template. Known values are: "UserAssigned" and "None".
:paramtype type: str or ~azure.mgmt.imagebuilder.models.ResourceIdentityType
:keyword user_assigned_identities: The list of user identities associated with the image
template. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:paramtype user_assigned_identities: dict[str,
~azure.mgmt.imagebuilder.models.ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties]
"""
super().__init__(**kwargs)
self.type = type
self.user_assigned_identities = user_assigned_identities
[docs]class ImageTemplateInVMValidator(_serialization.Model):
"""Describes a unit of in-VM validation of image.
You probably want to use the sub-classes and not this class directly. Known sub-classes are:
ImageTemplatePowerShellValidator, ImageTemplateShellValidator
All required parameters must be populated in order to send to Azure.
:ivar type: The type of validation you want to use on the Image. For example, "Shell" can be
shell validation. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this validation step does.
:vartype name: str
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
}
_subtype_map = {"type": {"PowerShell": "ImageTemplatePowerShellValidator", "Shell": "ImageTemplateShellValidator"}}
def __init__(self, *, name: Optional[str] = None, **kwargs):
"""
:keyword name: Friendly Name to provide context on what this validation step does.
:paramtype name: str
"""
super().__init__(**kwargs)
self.type: Optional[str] = None
self.name = name
[docs]class ImageTemplateLastRunStatus(_serialization.Model):
"""Describes the latest status of running an image template.
:ivar start_time: Start time of the last run (UTC).
:vartype start_time: ~datetime.datetime
:ivar end_time: End time of the last run (UTC).
:vartype end_time: ~datetime.datetime
:ivar run_state: State of the last run. Known values are: "Running", "Canceling", "Succeeded",
"PartiallySucceeded", "Failed", and "Canceled".
:vartype run_state: str or ~azure.mgmt.imagebuilder.models.RunState
:ivar run_sub_state: Sub-state of the last run. Known values are: "Queued", "Building",
"Customizing", "Validating", and "Distributing".
:vartype run_sub_state: str or ~azure.mgmt.imagebuilder.models.RunSubState
:ivar message: Verbose information about the last run state.
:vartype message: str
"""
_attribute_map = {
"start_time": {"key": "startTime", "type": "iso-8601"},
"end_time": {"key": "endTime", "type": "iso-8601"},
"run_state": {"key": "runState", "type": "str"},
"run_sub_state": {"key": "runSubState", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(
self,
*,
start_time: Optional[datetime.datetime] = None,
end_time: Optional[datetime.datetime] = None,
run_state: Optional[Union[str, "_models.RunState"]] = None,
run_sub_state: Optional[Union[str, "_models.RunSubState"]] = None,
message: Optional[str] = None,
**kwargs
):
"""
:keyword start_time: Start time of the last run (UTC).
:paramtype start_time: ~datetime.datetime
:keyword end_time: End time of the last run (UTC).
:paramtype end_time: ~datetime.datetime
:keyword run_state: State of the last run. Known values are: "Running", "Canceling",
"Succeeded", "PartiallySucceeded", "Failed", and "Canceled".
:paramtype run_state: str or ~azure.mgmt.imagebuilder.models.RunState
:keyword run_sub_state: Sub-state of the last run. Known values are: "Queued", "Building",
"Customizing", "Validating", and "Distributing".
:paramtype run_sub_state: str or ~azure.mgmt.imagebuilder.models.RunSubState
:keyword message: Verbose information about the last run state.
:paramtype message: str
"""
super().__init__(**kwargs)
self.start_time = start_time
self.end_time = end_time
self.run_state = run_state
self.run_sub_state = run_sub_state
self.message = message
[docs]class ImageTemplateListResult(_serialization.Model):
"""The result of List image templates operation.
:ivar value: An array of image templates.
:vartype value: list[~azure.mgmt.imagebuilder.models.ImageTemplate]
:ivar next_link: The continuation token.
:vartype next_link: str
"""
_attribute_map = {
"value": {"key": "value", "type": "[ImageTemplate]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: Optional[List["_models.ImageTemplate"]] = None, next_link: Optional[str] = None, **kwargs
):
"""
:keyword value: An array of image templates.
:paramtype value: list[~azure.mgmt.imagebuilder.models.ImageTemplate]
:keyword next_link: The continuation token.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ImageTemplateManagedImageDistributor(ImageTemplateDistributor):
"""Distribute as a Managed Disk Image.
All required parameters must be populated in order to send to Azure.
:ivar type: Type of distribution. Required.
:vartype type: str
:ivar run_output_name: The name to be used for the associated RunOutput. Required.
:vartype run_output_name: str
:ivar artifact_tags: Tags that will be applied to the artifact once it has been created/updated
by the distributor.
:vartype artifact_tags: dict[str, str]
:ivar image_id: Resource Id of the Managed Disk Image. Required.
:vartype image_id: str
:ivar location: Azure location for the image, should match if image already exists. Required.
:vartype location: str
"""
_validation = {
"type": {"required": True},
"run_output_name": {"required": True, "pattern": r"^[A-Za-z0-9-_.]{1,64}$"},
"image_id": {"required": True},
"location": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"run_output_name": {"key": "runOutputName", "type": "str"},
"artifact_tags": {"key": "artifactTags", "type": "{str}"},
"image_id": {"key": "imageId", "type": "str"},
"location": {"key": "location", "type": "str"},
}
def __init__(
self,
*,
run_output_name: str,
image_id: str,
location: str,
artifact_tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword run_output_name: The name to be used for the associated RunOutput. Required.
:paramtype run_output_name: str
:keyword artifact_tags: Tags that will be applied to the artifact once it has been
created/updated by the distributor.
:paramtype artifact_tags: dict[str, str]
:keyword image_id: Resource Id of the Managed Disk Image. Required.
:paramtype image_id: str
:keyword location: Azure location for the image, should match if image already exists.
Required.
:paramtype location: str
"""
super().__init__(run_output_name=run_output_name, artifact_tags=artifact_tags, **kwargs)
self.type: str = "ManagedImage"
self.image_id = image_id
self.location = location
[docs]class ImageTemplateSource(_serialization.Model):
"""Describes a virtual machine image source for building, customizing and distributing.
You probably want to use the sub-classes and not this class directly. Known sub-classes are:
ImageTemplateManagedImageSource, ImageTemplatePlatformImageSource,
ImageTemplateSharedImageVersionSource
All required parameters must be populated in order to send to Azure.
:ivar type: Specifies the type of source image you want to start with. Required.
:vartype type: str
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
}
_subtype_map = {
"type": {
"ManagedImage": "ImageTemplateManagedImageSource",
"PlatformImage": "ImageTemplatePlatformImageSource",
"SharedImageVersion": "ImageTemplateSharedImageVersionSource",
}
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.type: Optional[str] = None
[docs]class ImageTemplateManagedImageSource(ImageTemplateSource):
"""Describes an image source that is a managed image in customer subscription. This image must reside in the same subscription and region as the Image Builder template.
All required parameters must be populated in order to send to Azure.
:ivar type: Specifies the type of source image you want to start with. Required.
:vartype type: str
:ivar image_id: ARM resource id of the managed image in customer subscription. Required.
:vartype image_id: str
"""
_validation = {
"type": {"required": True},
"image_id": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"image_id": {"key": "imageId", "type": "str"},
}
def __init__(self, *, image_id: str, **kwargs):
"""
:keyword image_id: ARM resource id of the managed image in customer subscription. Required.
:paramtype image_id: str
"""
super().__init__(**kwargs)
self.type: str = "ManagedImage"
self.image_id = image_id
[docs]class ImageTemplatePowerShellCustomizer(ImageTemplateCustomizer):
"""Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
:ivar script_uri: URI of the PowerShell script to be run for customizing. It can be a github
link, SAS URI for Azure Storage, etc.
:vartype script_uri: str
:ivar sha256_checksum: SHA256 checksum of the power shell script provided in the scriptUri
field above.
:vartype sha256_checksum: str
:ivar inline: Array of PowerShell commands to execute.
:vartype inline: list[str]
:ivar run_elevated: If specified, the PowerShell script will be run with elevated privileges.
:vartype run_elevated: bool
:ivar run_as_system: If specified, the PowerShell script will be run with elevated privileges
using the Local System user. Can only be true when the runElevated field above is set to true.
:vartype run_as_system: bool
:ivar valid_exit_codes: Valid exit codes for the PowerShell script. [Default: 0].
:vartype valid_exit_codes: list[int]
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"script_uri": {"key": "scriptUri", "type": "str"},
"sha256_checksum": {"key": "sha256Checksum", "type": "str"},
"inline": {"key": "inline", "type": "[str]"},
"run_elevated": {"key": "runElevated", "type": "bool"},
"run_as_system": {"key": "runAsSystem", "type": "bool"},
"valid_exit_codes": {"key": "validExitCodes", "type": "[int]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
script_uri: Optional[str] = None,
sha256_checksum: str = "",
inline: Optional[List[str]] = None,
run_elevated: bool = False,
run_as_system: bool = False,
valid_exit_codes: Optional[List[int]] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
:keyword script_uri: URI of the PowerShell script to be run for customizing. It can be a github
link, SAS URI for Azure Storage, etc.
:paramtype script_uri: str
:keyword sha256_checksum: SHA256 checksum of the power shell script provided in the scriptUri
field above.
:paramtype sha256_checksum: str
:keyword inline: Array of PowerShell commands to execute.
:paramtype inline: list[str]
:keyword run_elevated: If specified, the PowerShell script will be run with elevated
privileges.
:paramtype run_elevated: bool
:keyword run_as_system: If specified, the PowerShell script will be run with elevated
privileges using the Local System user. Can only be true when the runElevated field above is
set to true.
:paramtype run_as_system: bool
:keyword valid_exit_codes: Valid exit codes for the PowerShell script. [Default: 0].
:paramtype valid_exit_codes: list[int]
"""
super().__init__(name=name, **kwargs)
self.type: str = "PowerShell"
self.script_uri = script_uri
self.sha256_checksum = sha256_checksum
self.inline = inline
self.run_elevated = run_elevated
self.run_as_system = run_as_system
self.valid_exit_codes = valid_exit_codes
[docs]class ImageTemplatePowerShellValidator(ImageTemplateInVMValidator):
"""Runs the specified PowerShell script during the validation phase (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of validation you want to use on the Image. For example, "Shell" can be
shell validation. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this validation step does.
:vartype name: str
:ivar script_uri: URI of the PowerShell script to be run for validation. It can be a github
link, Azure Storage URI, etc.
:vartype script_uri: str
:ivar sha256_checksum: SHA256 checksum of the power shell script provided in the scriptUri
field above.
:vartype sha256_checksum: str
:ivar inline: Array of PowerShell commands to execute.
:vartype inline: list[str]
:ivar run_elevated: If specified, the PowerShell script will be run with elevated privileges.
:vartype run_elevated: bool
:ivar run_as_system: If specified, the PowerShell script will be run with elevated privileges
using the Local System user. Can only be true when the runElevated field above is set to true.
:vartype run_as_system: bool
:ivar valid_exit_codes: Valid exit codes for the PowerShell script. [Default: 0].
:vartype valid_exit_codes: list[int]
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"script_uri": {"key": "scriptUri", "type": "str"},
"sha256_checksum": {"key": "sha256Checksum", "type": "str"},
"inline": {"key": "inline", "type": "[str]"},
"run_elevated": {"key": "runElevated", "type": "bool"},
"run_as_system": {"key": "runAsSystem", "type": "bool"},
"valid_exit_codes": {"key": "validExitCodes", "type": "[int]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
script_uri: Optional[str] = None,
sha256_checksum: str = "",
inline: Optional[List[str]] = None,
run_elevated: bool = False,
run_as_system: bool = False,
valid_exit_codes: Optional[List[int]] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this validation step does.
:paramtype name: str
:keyword script_uri: URI of the PowerShell script to be run for validation. It can be a github
link, Azure Storage URI, etc.
:paramtype script_uri: str
:keyword sha256_checksum: SHA256 checksum of the power shell script provided in the scriptUri
field above.
:paramtype sha256_checksum: str
:keyword inline: Array of PowerShell commands to execute.
:paramtype inline: list[str]
:keyword run_elevated: If specified, the PowerShell script will be run with elevated
privileges.
:paramtype run_elevated: bool
:keyword run_as_system: If specified, the PowerShell script will be run with elevated
privileges using the Local System user. Can only be true when the runElevated field above is
set to true.
:paramtype run_as_system: bool
:keyword valid_exit_codes: Valid exit codes for the PowerShell script. [Default: 0].
:paramtype valid_exit_codes: list[int]
"""
super().__init__(name=name, **kwargs)
self.type: str = "PowerShell"
self.script_uri = script_uri
self.sha256_checksum = sha256_checksum
self.inline = inline
self.run_elevated = run_elevated
self.run_as_system = run_as_system
self.valid_exit_codes = valid_exit_codes
[docs]class ImageTemplatePropertiesValidate(_serialization.Model):
"""Configuration options and list of validations to be performed on the resulting image.
:ivar continue_distribute_on_failure: If validation fails and this field is set to false,
output image(s) will not be distributed. This is the default behavior. If validation fails and
this field is set to true, output image(s) will still be distributed. Please use this option
with caution as it may result in bad images being distributed for use. In either case (true or
false), the end to end image run will be reported as having failed in case of a validation
failure. [Note: This field has no effect if validation succeeds.].
:vartype continue_distribute_on_failure: bool
:ivar source_validation_only: If this field is set to true, the image specified in the 'source'
section will directly be validated. No separate build will be run to generate and then validate
a customized image.
:vartype source_validation_only: bool
:ivar in_vm_validations: List of validations to be performed.
:vartype in_vm_validations: list[~azure.mgmt.imagebuilder.models.ImageTemplateInVMValidator]
"""
_attribute_map = {
"continue_distribute_on_failure": {"key": "continueDistributeOnFailure", "type": "bool"},
"source_validation_only": {"key": "sourceValidationOnly", "type": "bool"},
"in_vm_validations": {"key": "inVMValidations", "type": "[ImageTemplateInVMValidator]"},
}
def __init__(
self,
*,
continue_distribute_on_failure: bool = False,
source_validation_only: bool = False,
in_vm_validations: Optional[List["_models.ImageTemplateInVMValidator"]] = None,
**kwargs
):
"""
:keyword continue_distribute_on_failure: If validation fails and this field is set to false,
output image(s) will not be distributed. This is the default behavior. If validation fails and
this field is set to true, output image(s) will still be distributed. Please use this option
with caution as it may result in bad images being distributed for use. In either case (true or
false), the end to end image run will be reported as having failed in case of a validation
failure. [Note: This field has no effect if validation succeeds.].
:paramtype continue_distribute_on_failure: bool
:keyword source_validation_only: If this field is set to true, the image specified in the
'source' section will directly be validated. No separate build will be run to generate and then
validate a customized image.
:paramtype source_validation_only: bool
:keyword in_vm_validations: List of validations to be performed.
:paramtype in_vm_validations: list[~azure.mgmt.imagebuilder.models.ImageTemplateInVMValidator]
"""
super().__init__(**kwargs)
self.continue_distribute_on_failure = continue_distribute_on_failure
self.source_validation_only = source_validation_only
self.in_vm_validations = in_vm_validations
[docs]class ImageTemplateRestartCustomizer(ImageTemplateCustomizer):
"""Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
:ivar restart_command: Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer
restart"'].
:vartype restart_command: str
:ivar restart_check_command: Command to check if restart succeeded [Default: ''].
:vartype restart_check_command: str
:ivar restart_timeout: Restart timeout specified as a string of magnitude and unit, e.g. '5m'
(5 minutes) or '2h' (2 hours) [Default: '5m'].
:vartype restart_timeout: str
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"restart_command": {"key": "restartCommand", "type": "str"},
"restart_check_command": {"key": "restartCheckCommand", "type": "str"},
"restart_timeout": {"key": "restartTimeout", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
restart_command: Optional[str] = None,
restart_check_command: Optional[str] = None,
restart_timeout: Optional[str] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
:keyword restart_command: Command to execute the restart [Default: 'shutdown /r /f /t 0 /c
"packer restart"'].
:paramtype restart_command: str
:keyword restart_check_command: Command to check if restart succeeded [Default: ''].
:paramtype restart_check_command: str
:keyword restart_timeout: Restart timeout specified as a string of magnitude and unit, e.g.
'5m' (5 minutes) or '2h' (2 hours) [Default: '5m'].
:paramtype restart_timeout: str
"""
super().__init__(name=name, **kwargs)
self.type: str = "WindowsRestart"
self.restart_command = restart_command
self.restart_check_command = restart_check_command
self.restart_timeout = restart_timeout
[docs]class ImageTemplateSharedImageDistributor(ImageTemplateDistributor):
"""Distribute via Shared Image Gallery.
All required parameters must be populated in order to send to Azure.
:ivar type: Type of distribution. Required.
:vartype type: str
:ivar run_output_name: The name to be used for the associated RunOutput. Required.
:vartype run_output_name: str
:ivar artifact_tags: Tags that will be applied to the artifact once it has been created/updated
by the distributor.
:vartype artifact_tags: dict[str, str]
:ivar gallery_image_id: Resource Id of the Shared Image Gallery image. Required.
:vartype gallery_image_id: str
:ivar replication_regions: A list of regions that the image will be replicated to. Required.
:vartype replication_regions: list[str]
:ivar exclude_from_latest: Flag that indicates whether created image version should be excluded
from latest. Omit to use the default (false).
:vartype exclude_from_latest: bool
:ivar storage_account_type: Storage account type to be used to store the shared image. Omit to
use the default (Standard_LRS). Known values are: "Standard_LRS" and "Standard_ZRS".
:vartype storage_account_type: str or
~azure.mgmt.imagebuilder.models.SharedImageStorageAccountType
"""
_validation = {
"type": {"required": True},
"run_output_name": {"required": True, "pattern": r"^[A-Za-z0-9-_.]{1,64}$"},
"gallery_image_id": {"required": True},
"replication_regions": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"run_output_name": {"key": "runOutputName", "type": "str"},
"artifact_tags": {"key": "artifactTags", "type": "{str}"},
"gallery_image_id": {"key": "galleryImageId", "type": "str"},
"replication_regions": {"key": "replicationRegions", "type": "[str]"},
"exclude_from_latest": {"key": "excludeFromLatest", "type": "bool"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
run_output_name: str,
gallery_image_id: str,
replication_regions: List[str],
artifact_tags: Optional[Dict[str, str]] = None,
exclude_from_latest: bool = False,
storage_account_type: Optional[Union[str, "_models.SharedImageStorageAccountType"]] = None,
**kwargs
):
"""
:keyword run_output_name: The name to be used for the associated RunOutput. Required.
:paramtype run_output_name: str
:keyword artifact_tags: Tags that will be applied to the artifact once it has been
created/updated by the distributor.
:paramtype artifact_tags: dict[str, str]
:keyword gallery_image_id: Resource Id of the Shared Image Gallery image. Required.
:paramtype gallery_image_id: str
:keyword replication_regions: A list of regions that the image will be replicated to. Required.
:paramtype replication_regions: list[str]
:keyword exclude_from_latest: Flag that indicates whether created image version should be
excluded from latest. Omit to use the default (false).
:paramtype exclude_from_latest: bool
:keyword storage_account_type: Storage account type to be used to store the shared image. Omit
to use the default (Standard_LRS). Known values are: "Standard_LRS" and "Standard_ZRS".
:paramtype storage_account_type: str or
~azure.mgmt.imagebuilder.models.SharedImageStorageAccountType
"""
super().__init__(run_output_name=run_output_name, artifact_tags=artifact_tags, **kwargs)
self.type: str = "SharedImage"
self.gallery_image_id = gallery_image_id
self.replication_regions = replication_regions
self.exclude_from_latest = exclude_from_latest
self.storage_account_type = storage_account_type
[docs]class ImageTemplateSharedImageVersionSource(ImageTemplateSource):
"""Describes an image source that is an image version in a shared image gallery.
All required parameters must be populated in order to send to Azure.
:ivar type: Specifies the type of source image you want to start with. Required.
:vartype type: str
:ivar image_version_id: ARM resource id of the image version in the shared image gallery.
Required.
:vartype image_version_id: str
"""
_validation = {
"type": {"required": True},
"image_version_id": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"image_version_id": {"key": "imageVersionId", "type": "str"},
}
def __init__(self, *, image_version_id: str, **kwargs):
"""
:keyword image_version_id: ARM resource id of the image version in the shared image gallery.
Required.
:paramtype image_version_id: str
"""
super().__init__(**kwargs)
self.type: str = "SharedImageVersion"
self.image_version_id = image_version_id
[docs]class ImageTemplateShellCustomizer(ImageTemplateCustomizer):
"""Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
:ivar script_uri: URI of the shell script to be run for customizing. It can be a github link,
SAS URI for Azure Storage, etc.
:vartype script_uri: str
:ivar sha256_checksum: SHA256 checksum of the shell script provided in the scriptUri field.
:vartype sha256_checksum: str
:ivar inline: Array of shell commands to execute.
:vartype inline: list[str]
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"script_uri": {"key": "scriptUri", "type": "str"},
"sha256_checksum": {"key": "sha256Checksum", "type": "str"},
"inline": {"key": "inline", "type": "[str]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
script_uri: Optional[str] = None,
sha256_checksum: str = "",
inline: Optional[List[str]] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
:keyword script_uri: URI of the shell script to be run for customizing. It can be a github
link, SAS URI for Azure Storage, etc.
:paramtype script_uri: str
:keyword sha256_checksum: SHA256 checksum of the shell script provided in the scriptUri field.
:paramtype sha256_checksum: str
:keyword inline: Array of shell commands to execute.
:paramtype inline: list[str]
"""
super().__init__(name=name, **kwargs)
self.type: str = "Shell"
self.script_uri = script_uri
self.sha256_checksum = sha256_checksum
self.inline = inline
[docs]class ImageTemplateShellValidator(ImageTemplateInVMValidator):
"""Runs the specified shell script during the validation phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of validation you want to use on the Image. For example, "Shell" can be
shell validation. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this validation step does.
:vartype name: str
:ivar script_uri: URI of the shell script to be run for validation. It can be a github link,
Azure Storage URI, etc.
:vartype script_uri: str
:ivar sha256_checksum: SHA256 checksum of the shell script provided in the scriptUri field.
:vartype sha256_checksum: str
:ivar inline: Array of shell commands to execute.
:vartype inline: list[str]
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"script_uri": {"key": "scriptUri", "type": "str"},
"sha256_checksum": {"key": "sha256Checksum", "type": "str"},
"inline": {"key": "inline", "type": "[str]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
script_uri: Optional[str] = None,
sha256_checksum: str = "",
inline: Optional[List[str]] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this validation step does.
:paramtype name: str
:keyword script_uri: URI of the shell script to be run for validation. It can be a github link,
Azure Storage URI, etc.
:paramtype script_uri: str
:keyword sha256_checksum: SHA256 checksum of the shell script provided in the scriptUri field.
:paramtype sha256_checksum: str
:keyword inline: Array of shell commands to execute.
:paramtype inline: list[str]
"""
super().__init__(name=name, **kwargs)
self.type: str = "Shell"
self.script_uri = script_uri
self.sha256_checksum = sha256_checksum
self.inline = inline
[docs]class ImageTemplateUpdateParameters(_serialization.Model):
"""Parameters for updating an image template.
:ivar identity: The identity of the image template, if configured.
:vartype identity: ~azure.mgmt.imagebuilder.models.ImageTemplateIdentity
:ivar tags: The user-specified tags associated with the image template.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"identity": {"key": "identity", "type": "ImageTemplateIdentity"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
identity: Optional["_models.ImageTemplateIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword identity: The identity of the image template, if configured.
:paramtype identity: ~azure.mgmt.imagebuilder.models.ImageTemplateIdentity
:keyword tags: The user-specified tags associated with the image template.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.identity = identity
self.tags = tags
[docs]class ImageTemplateVhdDistributor(ImageTemplateDistributor):
"""Distribute via VHD in a storage account.
All required parameters must be populated in order to send to Azure.
:ivar type: Type of distribution. Required.
:vartype type: str
:ivar run_output_name: The name to be used for the associated RunOutput. Required.
:vartype run_output_name: str
:ivar artifact_tags: Tags that will be applied to the artifact once it has been created/updated
by the distributor.
:vartype artifact_tags: dict[str, str]
"""
_validation = {
"type": {"required": True},
"run_output_name": {"required": True, "pattern": r"^[A-Za-z0-9-_.]{1,64}$"},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"run_output_name": {"key": "runOutputName", "type": "str"},
"artifact_tags": {"key": "artifactTags", "type": "{str}"},
}
def __init__(self, *, run_output_name: str, artifact_tags: Optional[Dict[str, str]] = None, **kwargs):
"""
:keyword run_output_name: The name to be used for the associated RunOutput. Required.
:paramtype run_output_name: str
:keyword artifact_tags: Tags that will be applied to the artifact once it has been
created/updated by the distributor.
:paramtype artifact_tags: dict[str, str]
"""
super().__init__(run_output_name=run_output_name, artifact_tags=artifact_tags, **kwargs)
self.type: str = "VHD"
[docs]class ImageTemplateVmProfile(_serialization.Model):
"""Describes the virtual machines used to build and validate images.
:ivar vm_size: Size of the virtual machine used to build, customize and capture images. Omit or
specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4
for Gen2 images).
:vartype vm_size: str
:ivar os_disk_size_gb: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS
disk size.
:vartype os_disk_size_gb: int
:ivar user_assigned_identities: Optional array of resource IDs of user assigned managed
identities to be configured on the build VM and validation VM. This may include the identity of
the image template.
:vartype user_assigned_identities: list[str]
:ivar vnet_config: Optional configuration of the virtual network to use to deploy the build VM
and validation VM in. Omit if no specific virtual network needs to be used.
:vartype vnet_config: ~azure.mgmt.imagebuilder.models.VirtualNetworkConfig
"""
_validation = {
"os_disk_size_gb": {"minimum": 0},
}
_attribute_map = {
"vm_size": {"key": "vmSize", "type": "str"},
"os_disk_size_gb": {"key": "osDiskSizeGB", "type": "int"},
"user_assigned_identities": {"key": "userAssignedIdentities", "type": "[str]"},
"vnet_config": {"key": "vnetConfig", "type": "VirtualNetworkConfig"},
}
def __init__(
self,
*,
vm_size: str = "",
os_disk_size_gb: int = 0,
user_assigned_identities: Optional[List[str]] = None,
vnet_config: Optional["_models.VirtualNetworkConfig"] = None,
**kwargs
):
"""
:keyword vm_size: Size of the virtual machine used to build, customize and capture images. Omit
or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4
for Gen2 images).
:paramtype vm_size: str
:keyword os_disk_size_gb: Size of the OS disk in GB. Omit or specify 0 to use Azure's default
OS disk size.
:paramtype os_disk_size_gb: int
:keyword user_assigned_identities: Optional array of resource IDs of user assigned managed
identities to be configured on the build VM and validation VM. This may include the identity of
the image template.
:paramtype user_assigned_identities: list[str]
:keyword vnet_config: Optional configuration of the virtual network to use to deploy the build
VM and validation VM in. Omit if no specific virtual network needs to be used.
:paramtype vnet_config: ~azure.mgmt.imagebuilder.models.VirtualNetworkConfig
"""
super().__init__(**kwargs)
self.vm_size = vm_size
self.os_disk_size_gb = os_disk_size_gb
self.user_assigned_identities = user_assigned_identities
self.vnet_config = vnet_config
[docs]class ImageTemplateWindowsUpdateCustomizer(ImageTemplateCustomizer):
"""Installs Windows Updates. Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update).
All required parameters must be populated in order to send to Azure.
:ivar type: The type of customization tool you want to use on the Image. For example, "Shell"
can be shell customizer. Required.
:vartype type: str
:ivar name: Friendly Name to provide context on what this customization step does.
:vartype name: str
:ivar search_criteria: Criteria to search updates. Omit or specify empty string to use the
default (search all). Refer to above link for examples and detailed description of this field.
:vartype search_criteria: str
:ivar filters: Array of filters to select updates to apply. Omit or specify empty array to use
the default (no filter). Refer to above link for examples and detailed description of this
field.
:vartype filters: list[str]
:ivar update_limit: Maximum number of updates to apply at a time. Omit or specify 0 to use the
default (1000).
:vartype update_limit: int
"""
_validation = {
"type": {"required": True},
"update_limit": {"minimum": 0},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"name": {"key": "name", "type": "str"},
"search_criteria": {"key": "searchCriteria", "type": "str"},
"filters": {"key": "filters", "type": "[str]"},
"update_limit": {"key": "updateLimit", "type": "int"},
}
def __init__(
self,
*,
name: Optional[str] = None,
search_criteria: Optional[str] = None,
filters: Optional[List[str]] = None,
update_limit: Optional[int] = None,
**kwargs
):
"""
:keyword name: Friendly Name to provide context on what this customization step does.
:paramtype name: str
:keyword search_criteria: Criteria to search updates. Omit or specify empty string to use the
default (search all). Refer to above link for examples and detailed description of this field.
:paramtype search_criteria: str
:keyword filters: Array of filters to select updates to apply. Omit or specify empty array to
use the default (no filter). Refer to above link for examples and detailed description of this
field.
:paramtype filters: list[str]
:keyword update_limit: Maximum number of updates to apply at a time. Omit or specify 0 to use
the default (1000).
:paramtype update_limit: int
"""
super().__init__(name=name, **kwargs)
self.type: str = "WindowsUpdate"
self.search_criteria = search_criteria
self.filters = filters
self.update_limit = update_limit
[docs]class Operation(_serialization.Model):
"""A REST API operation.
:ivar name: This is of the format {provider}/{resource}/{operation}.
:vartype name: str
:ivar display: The object that describes the operation.
:vartype display: ~azure.mgmt.imagebuilder.models.OperationDisplay
:ivar origin: The intended executor of the operation.
:vartype origin: str
:ivar properties: Properties of the operation.
:vartype properties: JSON
:ivar is_data_action: The flag that indicates whether the operation applies to data plane.
:vartype is_data_action: bool
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display": {"key": "display", "type": "OperationDisplay"},
"origin": {"key": "origin", "type": "str"},
"properties": {"key": "properties", "type": "object"},
"is_data_action": {"key": "isDataAction", "type": "bool"},
}
def __init__(
self,
*,
name: Optional[str] = None,
display: Optional["_models.OperationDisplay"] = None,
origin: Optional[str] = None,
properties: Optional[JSON] = None,
is_data_action: Optional[bool] = None,
**kwargs
):
"""
:keyword name: This is of the format {provider}/{resource}/{operation}.
:paramtype name: str
:keyword display: The object that describes the operation.
:paramtype display: ~azure.mgmt.imagebuilder.models.OperationDisplay
:keyword origin: The intended executor of the operation.
:paramtype origin: str
:keyword properties: Properties of the operation.
:paramtype properties: JSON
:keyword is_data_action: The flag that indicates whether the operation applies to data plane.
:paramtype is_data_action: bool
"""
super().__init__(**kwargs)
self.name = name
self.display = display
self.origin = origin
self.properties = properties
self.is_data_action = is_data_action
[docs]class OperationDisplay(_serialization.Model):
"""The object that describes the operation.
:ivar provider: Friendly name of the resource provider.
:vartype provider: str
:ivar operation: For example: read, write, delete, or listKeys/action.
:vartype operation: str
:ivar resource: The resource type on which the operation is performed.
:vartype resource: str
:ivar description: The friendly name of the operation.
:vartype description: str
"""
_attribute_map = {
"provider": {"key": "provider", "type": "str"},
"operation": {"key": "operation", "type": "str"},
"resource": {"key": "resource", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(
self,
*,
provider: Optional[str] = None,
operation: Optional[str] = None,
resource: Optional[str] = None,
description: Optional[str] = None,
**kwargs
):
"""
:keyword provider: Friendly name of the resource provider.
:paramtype provider: str
:keyword operation: For example: read, write, delete, or listKeys/action.
:paramtype operation: str
:keyword resource: The resource type on which the operation is performed.
:paramtype resource: str
:keyword description: The friendly name of the operation.
:paramtype description: str
"""
super().__init__(**kwargs)
self.provider = provider
self.operation = operation
self.resource = resource
self.description = description
[docs]class OperationListResult(_serialization.Model):
"""Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
:ivar value: The list of operations supported by the resource provider.
:vartype value: list[~azure.mgmt.imagebuilder.models.Operation]
:ivar next_link: The URL to get the next set of operation list results if there are any.
:vartype next_link: str
"""
_attribute_map = {
"value": {"key": "value", "type": "[Operation]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: Optional[List["_models.Operation"]] = None, next_link: Optional[str] = None, **kwargs):
"""
:keyword value: The list of operations supported by the resource provider.
:paramtype value: list[~azure.mgmt.imagebuilder.models.Operation]
:keyword next_link: The URL to get the next set of operation list results if there are any.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ProvisioningError(_serialization.Model):
"""Describes the error happened when create or update an image template.
:ivar provisioning_error_code: Error code of the provisioning failure. Known values are:
"BadSourceType", "BadPIRSource", "BadManagedImageSource", "BadSharedImageVersionSource",
"BadCustomizerType", "UnsupportedCustomizerType", "NoCustomizerScript", "BadValidatorType",
"UnsupportedValidatorType", "NoValidatorScript", "BadDistributeType",
"BadSharedImageDistribute", "BadStagingResourceGroup", "ServerError", and "Other".
:vartype provisioning_error_code: str or ~azure.mgmt.imagebuilder.models.ProvisioningErrorCode
:ivar message: Verbose error message about the provisioning failure.
:vartype message: str
"""
_attribute_map = {
"provisioning_error_code": {"key": "provisioningErrorCode", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(
self,
*,
provisioning_error_code: Optional[Union[str, "_models.ProvisioningErrorCode"]] = None,
message: Optional[str] = None,
**kwargs
):
"""
:keyword provisioning_error_code: Error code of the provisioning failure. Known values are:
"BadSourceType", "BadPIRSource", "BadManagedImageSource", "BadSharedImageVersionSource",
"BadCustomizerType", "UnsupportedCustomizerType", "NoCustomizerScript", "BadValidatorType",
"UnsupportedValidatorType", "NoValidatorScript", "BadDistributeType",
"BadSharedImageDistribute", "BadStagingResourceGroup", "ServerError", and "Other".
:paramtype provisioning_error_code: str or
~azure.mgmt.imagebuilder.models.ProvisioningErrorCode
:keyword message: Verbose error message about the provisioning failure.
:paramtype message: str
"""
super().__init__(**kwargs)
self.provisioning_error_code = provisioning_error_code
self.message = message
[docs]class ProxyResource(Resource):
"""The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.imagebuilder.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
[docs]class RunOutput(ProxyResource):
"""Represents an output that was created by running an image template.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.imagebuilder.models.SystemData
:ivar artifact_id: The resource id of the artifact.
:vartype artifact_id: str
:ivar artifact_uri: The location URI of the artifact.
:vartype artifact_uri: str
:ivar provisioning_state: Provisioning state of the resource. Known values are: "Creating",
"Updating", "Succeeded", "Failed", and "Deleting".
:vartype provisioning_state: str or ~azure.mgmt.imagebuilder.models.ProvisioningState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"artifact_id": {"key": "properties.artifactId", "type": "str"},
"artifact_uri": {"key": "properties.artifactUri", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
}
def __init__(self, *, artifact_id: Optional[str] = None, artifact_uri: Optional[str] = None, **kwargs):
"""
:keyword artifact_id: The resource id of the artifact.
:paramtype artifact_id: str
:keyword artifact_uri: The location URI of the artifact.
:paramtype artifact_uri: str
"""
super().__init__(**kwargs)
self.artifact_id = artifact_id
self.artifact_uri = artifact_uri
self.provisioning_state = None
[docs]class RunOutputCollection(_serialization.Model):
"""The result of List run outputs operation.
:ivar value: An array of run outputs.
:vartype value: list[~azure.mgmt.imagebuilder.models.RunOutput]
:ivar next_link: The continuation token.
:vartype next_link: str
"""
_attribute_map = {
"value": {"key": "value", "type": "[RunOutput]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: Optional[List["_models.RunOutput"]] = None, next_link: Optional[str] = None, **kwargs):
"""
:keyword value: An array of run outputs.
:paramtype value: list[~azure.mgmt.imagebuilder.models.RunOutput]
:keyword next_link: The continuation token.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class SystemData(_serialization.Model):
"""Metadata pertaining to creation and last modification of the resource.
:ivar created_by: The identity that created the resource.
:vartype created_by: str
:ivar created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:vartype created_by_type: str or ~azure.mgmt.imagebuilder.models.CreatedByType
:ivar created_at: The timestamp of resource creation (UTC).
:vartype created_at: ~datetime.datetime
:ivar last_modified_by: The identity that last modified the resource.
:vartype last_modified_by: str
:ivar last_modified_by_type: The type of identity that last modified the resource. Known values
are: "User", "Application", "ManagedIdentity", and "Key".
:vartype last_modified_by_type: str or ~azure.mgmt.imagebuilder.models.CreatedByType
:ivar last_modified_at: The timestamp of resource last modification (UTC).
:vartype last_modified_at: ~datetime.datetime
"""
_attribute_map = {
"created_by": {"key": "createdBy", "type": "str"},
"created_by_type": {"key": "createdByType", "type": "str"},
"created_at": {"key": "createdAt", "type": "iso-8601"},
"last_modified_by": {"key": "lastModifiedBy", "type": "str"},
"last_modified_by_type": {"key": "lastModifiedByType", "type": "str"},
"last_modified_at": {"key": "lastModifiedAt", "type": "iso-8601"},
}
def __init__(
self,
*,
created_by: Optional[str] = None,
created_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
created_at: Optional[datetime.datetime] = None,
last_modified_by: Optional[str] = None,
last_modified_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
last_modified_at: Optional[datetime.datetime] = None,
**kwargs
):
"""
:keyword created_by: The identity that created the resource.
:paramtype created_by: str
:keyword created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:paramtype created_by_type: str or ~azure.mgmt.imagebuilder.models.CreatedByType
:keyword created_at: The timestamp of resource creation (UTC).
:paramtype created_at: ~datetime.datetime
:keyword last_modified_by: The identity that last modified the resource.
:paramtype last_modified_by: str
:keyword last_modified_by_type: The type of identity that last modified the resource. Known
values are: "User", "Application", "ManagedIdentity", and "Key".
:paramtype last_modified_by_type: str or ~azure.mgmt.imagebuilder.models.CreatedByType
:keyword last_modified_at: The timestamp of resource last modification (UTC).
:paramtype last_modified_at: ~datetime.datetime
"""
super().__init__(**kwargs)
self.created_by = created_by
self.created_by_type = created_by_type
self.created_at = created_at
self.last_modified_by = last_modified_by
self.last_modified_by_type = last_modified_by_type
self.last_modified_at = last_modified_at
[docs]class VirtualNetworkConfig(_serialization.Model):
"""Virtual Network configuration.
:ivar subnet_id: Resource id of a pre-existing subnet.
:vartype subnet_id: str
:ivar proxy_vm_size: Size of the proxy virtual machine used to pass traffic to the build VM and
validation VM. Omit or specify empty string to use the default (Standard_A1_v2).
:vartype proxy_vm_size: str
"""
_attribute_map = {
"subnet_id": {"key": "subnetId", "type": "str"},
"proxy_vm_size": {"key": "proxyVmSize", "type": "str"},
}
def __init__(self, *, subnet_id: Optional[str] = None, proxy_vm_size: str = "", **kwargs):
"""
:keyword subnet_id: Resource id of a pre-existing subnet.
:paramtype subnet_id: str
:keyword proxy_vm_size: Size of the proxy virtual machine used to pass traffic to the build VM
and validation VM. Omit or specify empty string to use the default (Standard_A1_v2).
:paramtype proxy_vm_size: str
"""
super().__init__(**kwargs)
self.subnet_id = subnet_id
self.proxy_vm_size = proxy_vm_size