Package com.azure.resourcemanager.imagebuilder.models

Interface ImageTemplate

  • public interface ImageTemplate
    An immutable client-side representation of ImageTemplate.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • identity

        ImageTemplateIdentity identity()
        Gets the identity property: The identity of the image template, if configured.
        Returns:
        the identity value.

      • source

        ImageTemplateSource source()
        Gets the source property: Specifies the properties used to describe the source image.
        Returns:
        the source value.

      • customize

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

      • validation

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

      • distribute

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

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state of the resource.
        Returns:
        the provisioningState value.

      • provisioningError

        ProvisioningError provisioningError()
        Gets the provisioningError property: Provisioning error, if any.
        Returns:
        the provisioningError value.

      • lastRunStatus

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

      • buildTimeoutInMinutes

        Integer buildTimeoutInMinutes()
        Gets 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.

      • vmProfile

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

      • stagingResourceGroup

        String stagingResourceGroup()
        Gets 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.

      • exactStagingResourceGroup

        String exactStagingResourceGroup()
        Gets 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.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • resourceGroupName

        String resourceGroupName()
        Gets the name of the resource group.
        Returns:
        the name of the resource group.

      • innerModel

        ImageTemplateInner innerModel()
        Gets the inner com.azure.resourcemanager.imagebuilder.fluent.models.ImageTemplateInner object.
        Returns:
        the inner object.

      • update

        ImageTemplate.Update update()
        Begins update for the ImageTemplate resource.
        Returns:
        the stage of resource update.

      • refresh

        ImageTemplate refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        ImageTemplate refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • run

        void run()
        Create artifacts from a existing image template.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • run

        void run​(com.azure.core.util.Context context)
        Create artifacts from a existing image template.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • cancel

        void cancel()
        Cancel the long running image build based on the image template.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • cancel

        void cancel​(com.azure.core.util.Context context)
        Cancel the long running image build based on the image template.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.