Class ImageTemplateProperties


  • public final class ImageTemplateProperties
    extends Object
    Describes the properties of an image template.
    • Constructor Detail

      • ImageTemplateProperties

        public ImageTemplateProperties()
    • Method Detail

      • source

        public ImageTemplateSource source()
        Get the source property: Specifies the properties used to describe the source image.
        Returns:
        the source value.
      • withSource

        public ImageTemplateProperties withSource​(ImageTemplateSource source)
        Set the source property: Specifies the properties used to describe the source image.
        Parameters:
        source - the source value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • customize

        public List<ImageTemplateCustomizer> customize()
        Get the customize property: Specifies the properties used to describe the customization steps of the image, like Image source etc.
        Returns:
        the customize value.
      • withCustomize

        public ImageTemplateProperties withCustomize​(List<ImageTemplateCustomizer> customize)
        Set the customize property: Specifies the properties used to describe the customization steps of the image, like Image source etc.
        Parameters:
        customize - the customize value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • validation

        public ImageTemplatePropertiesValidate validation()
        Get the validation property: Configuration options and list of validations to be performed on the resulting image.
        Returns:
        the validation value.
      • withValidation

        public ImageTemplateProperties withValidation​(ImageTemplatePropertiesValidate validation)
        Set the validation property: Configuration options and list of validations to be performed on the resulting image.
        Parameters:
        validation - the validation value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • distribute

        public List<ImageTemplateDistributor> distribute()
        Get the distribute property: The distribution targets where the image output needs to go to.
        Returns:
        the distribute value.
      • withDistribute

        public ImageTemplateProperties withDistribute​(List<ImageTemplateDistributor> distribute)
        Set the distribute property: The distribution targets where the image output needs to go to.
        Parameters:
        distribute - the distribute value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: Provisioning state of the resource.
        Returns:
        the provisioningState value.
      • provisioningError

        public ProvisioningError provisioningError()
        Get the provisioningError property: Provisioning error, if any.
        Returns:
        the provisioningError value.
      • lastRunStatus

        public ImageTemplateLastRunStatus lastRunStatus()
        Get the lastRunStatus property: State of 'run' that is currently executing or was last executed.
        Returns:
        the lastRunStatus value.
      • buildTimeoutInMinutes

        public Integer buildTimeoutInMinutes()
        Get the buildTimeoutInMinutes property: 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).
        Returns:
        the buildTimeoutInMinutes value.
      • withBuildTimeoutInMinutes

        public ImageTemplateProperties withBuildTimeoutInMinutes​(Integer buildTimeoutInMinutes)
        Set the buildTimeoutInMinutes property: 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).
        Parameters:
        buildTimeoutInMinutes - the buildTimeoutInMinutes value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • vmProfile

        public ImageTemplateVmProfile vmProfile()
        Get the vmProfile property: Describes how virtual machine is set up to build images.
        Returns:
        the vmProfile value.
      • withVmProfile

        public ImageTemplateProperties withVmProfile​(ImageTemplateVmProfile vmProfile)
        Set the vmProfile property: Describes how virtual machine is set up to build images.
        Parameters:
        vmProfile - the vmProfile value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • stagingResourceGroup

        public String stagingResourceGroup()
        Get the stagingResourceGroup property: 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.
        Returns:
        the stagingResourceGroup value.
      • withStagingResourceGroup

        public ImageTemplateProperties withStagingResourceGroup​(String stagingResourceGroup)
        Set the stagingResourceGroup property: 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.
        Parameters:
        stagingResourceGroup - the stagingResourceGroup value to set.
        Returns:
        the ImageTemplateProperties object itself.
      • exactStagingResourceGroup

        public String exactStagingResourceGroup()
        Get the exactStagingResourceGroup property: 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.
        Returns:
        the exactStagingResourceGroup value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.