ImageTemplate Interface
public interface ImageTemplate
An immutable client-side representation of ImageTemplate.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract Integer |
buildTimeoutInMinutes()
Gets the build |
| abstract void |
cancel()
Cancel the long running image build based on the image template. |
| abstract void |
cancel(Context context)
Cancel the long running image build based on the image template. |
|
abstract
List<Image |
customize()
Gets the customize property: Specifies the properties used to describe the customization steps of the image, like Image source etc. |
|
abstract
List<Image |
distribute()
Gets the distribute property: The distribution targets where the image output needs to go to. |
| abstract String |
exactStagingResourceGroup()
Gets the exact |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Image |
identity()
Gets the identity property: The identity of the image template, if configured. |
|
abstract
Image |
innerModel()
Gets the inner com. |
|
abstract
Image |
lastRunStatus()
Gets the last |
| abstract String |
location()
Gets the location property: The geo-location where the resource lives. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Image |
optimize()
Gets the optimize property: Specifies optimization to be performed on image. |
|
abstract
Provisioning |
provisioningError()
Gets the provisioning |
|
abstract
Provisioning |
provisioningState()
Gets the provisioning |
|
abstract
Image |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Image |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract void |
run()
Create artifacts from a existing image template. |
| abstract void |
run(Context context)
Create artifacts from a existing image template. |
|
abstract
Image |
source()
Gets the source property: Specifies the properties used to describe the source image. |
| abstract String |
stagingResourceGroup()
Gets the staging |
|
abstract
System |
systemData()
Gets the system |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Image |
|
abstract
Image |
validation()
Gets the validation property: Configuration options and list of validations to be performed on the resulting image. |
|
abstract
Image |
vmProfile()
Gets the vm |
Method Details
buildTimeoutInMinutes
public abstract Integer buildTimeoutInMinutes()
Gets the buildTimeoutInMinutes property: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours).
Returns:
cancel
public abstract void cancel()
Cancel the long running image build based on the image template.
cancel
public abstract void cancel(Context context)
Cancel the long running image build based on the image template.
Parameters:
customize
public abstract List<ImageTemplateCustomizer> customize()
Gets the customize property: Specifies the properties used to describe the customization steps of the image, like Image source etc.
Returns:
distribute
public abstract List<ImageTemplateDistributor> distribute()
Gets the distribute property: The distribution targets where the image output needs to go to.
Returns:
exactStagingResourceGroup
public abstract 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:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
identity
public abstract ImageTemplateIdentity identity()
Gets the identity property: The identity of the image template, if configured.
Returns:
innerModel
public abstract ImageTemplateInner innerModel()
Gets the inner com.azure.resourcemanager.imagebuilder.fluent.models.ImageTemplateInner object.
Returns:
lastRunStatus
public abstract ImageTemplateLastRunStatus lastRunStatus()
Gets the lastRunStatus property: State of 'run' that is currently executing or was last executed.
Returns:
location
public abstract String location()
Gets the location property: The geo-location where the resource lives.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
optimize
public abstract ImageTemplatePropertiesOptimize optimize()
Gets the optimize property: Specifies optimization to be performed on image.
Returns:
provisioningError
public abstract ProvisioningError provisioningError()
Gets the provisioningError property: Provisioning error, if any.
Returns:
provisioningState
public abstract ProvisioningState provisioningState()
Gets the provisioningState property: Provisioning state of the resource.
Returns:
refresh
public abstract ImageTemplate refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract ImageTemplate refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
run
public abstract void run()
Create artifacts from a existing image template.
run
public abstract void run(Context context)
Create artifacts from a existing image template.
Parameters:
source
public abstract ImageTemplateSource source()
Gets the source property: Specifies the properties used to describe the source image.
Returns:
stagingResourceGroup
public abstract 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:
systemData
public abstract SystemData systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Returns:
tags
public abstract Map<String,String> tags()
Gets the tags property: Resource tags.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract ImageTemplate.Update update()
Begins update for the ImageTemplate resource.
Returns:
validation
public abstract ImageTemplatePropertiesValidate validation()
Gets the validation property: Configuration options and list of validations to be performed on the resulting image.
Returns:
vmProfile
public abstract ImageTemplateVmProfile vmProfile()
Gets the vmProfile property: Describes how virtual machine is set up to build images.
Returns:
