Package com.azure.resourcemanager.compute.models

Interface GalleryImage

All Superinterfaces:

HasInnerModel<GalleryImageInner>, HasManager<ComputeManager>, Indexable, Refreshable<GalleryImage>, Updatable<GalleryImage.Update>

public interface GalleryImage
extends HasInnerModel<GalleryImageInner>, Indexable, Refreshable<GalleryImage>, Updatable<GalleryImage.Update>, HasManager<ComputeManager>

An immutable client-side representation of an Azure gallery image. A gallery image resource is a container for multiple versions of the same image.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GalleryImage.Definition	The entirety of the gallery image definition.
static interface	GalleryImage.DefinitionStages	Grouping of gallery image definition stages.
static interface	GalleryImage.Update	The template for a gallery image update operation, containing all the settings that can be modified.
static interface	GalleryImage.UpdateStages	Grouping of gallery image update stages.

Method Summary

Modifier and Type	Method	Description
String	description()
Disallowed	disallowed()
OffsetDateTime	endOfLifeDate()
String	eula()
GalleryImageVersion	getVersion(String versionName)	Retrieves information about an image version.
Mono<GalleryImageVersion>	getVersionAsync(String versionName)	Retrieves information about an image version.
String	id()
GalleryImageIdentifier	identifier()
com.azure.core.http.rest.PagedIterable<GalleryImageVersion>	listVersions()	List image versions.
com.azure.core.http.rest.PagedFlux<GalleryImageVersion>	listVersionsAsync()	List image versions.
String	location()
String	name()
OperatingSystemStateTypes	osState()
OperatingSystemTypes	osType()
String	privacyStatementUri()
String	provisioningState()
ImagePurchasePlan	purchasePlan()
RecommendedMachineConfiguration	recommendedVirtualMachineConfiguration()
String	releaseNoteUri()
Map<String,String>	tags()
String	type()
List<DiskSkuTypes>	unsupportedDiskTypes()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Method Detail

description

String description()

Returns:

the description of the image.

unsupportedDiskTypes

List<DiskSkuTypes> unsupportedDiskTypes()

Returns:

the disk types not supported by the image.

disallowed

Disallowed disallowed()

Returns:

a description of features not supported by the image.

endOfLifeDate

OffsetDateTime endOfLifeDate()

Returns:

the date indicating image's end of life.

eula

String eula()

Returns:

the image eula.

id

String id()

Returns:

the ARM id of the image.

identifier

GalleryImageIdentifier identifier()

Returns:

an identifier describing publisher, offer and sku of the image.

location

String location()

Returns:

the location of the image.

name

String name()

Returns:

the image name.

osState

OperatingSystemStateTypes osState()

Returns:

the OS state of the image.

osType

OperatingSystemTypes osType()

Returns:

the image OS type.

privacyStatementUri

String privacyStatementUri()

Returns:

the uri to image privacy statement.

provisioningState

String provisioningState()

Returns:

the provisioningState of image resource.

purchasePlan

ImagePurchasePlan purchasePlan()

Returns:

the purchasePlan of the image.

recommendedVirtualMachineConfiguration

RecommendedMachineConfiguration recommendedVirtualMachineConfiguration()

Returns:

the value describing recommended configuration for a virtual machine based on this image.

releaseNoteUri

String releaseNoteUri()

Returns:

the uri to the image release note.

tags

Map<String,String> tags()

Returns:

the tags associated with the image.

type

String type()

Returns:

the type value.

getVersionAsync

Mono<GalleryImageVersion> getVersionAsync(String versionName)

Retrieves information about an image version.

Parameters:

versionName - The name of the image.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getVersion

GalleryImageVersion getVersion(String versionName)

Retrieves information about an image version.

Parameters:

versionName - The name of the image version.

Returns:

the image version

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listVersionsAsync

com.azure.core.http.rest.PagedFlux<GalleryImageVersion> listVersionsAsync()

List image versions.

Returns:

the observable for the request

listVersions

com.azure.core.http.rest.PagedIterable<GalleryImageVersion> listVersions()

List image versions.

Returns:

the list of image versions