Package com.azure.resourcemanager.compute.models

Class ImageReference

  • public final class ImageReference
extends com.azure.core.management.SubResource
    Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

    • Constructor Detail

      • ImageReference

        public ImageReference()

    • Method Detail

      • publisher

        public String publisher()
        Get the publisher property: The image publisher.
        Returns:
        the publisher value.

      • withPublisher

        public ImageReference withPublisher​(String publisher)
        Set the publisher property: The image publisher.
        Parameters:
        publisher - the publisher value to set.
        Returns:
        the ImageReference object itself.

      • offer

        public String offer()
        Get the offer property: Specifies the offer of the platform image or marketplace image used to create the virtual machine.
        Returns:
        the offer value.

      • withOffer

        public ImageReference withOffer​(String offer)
        Set the offer property: Specifies the offer of the platform image or marketplace image used to create the virtual machine.
        Parameters:
        offer - the offer value to set.
        Returns:
        the ImageReference object itself.

      • sku

        public String sku()
        Get the sku property: The image SKU.
        Returns:
        the sku value.

      • withSku

        public ImageReference withSku​(String sku)
        Set the sku property: The image SKU.
        Parameters:
        sku - the sku value to set.
        Returns:
        the ImageReference object itself.

      • version

        public String version()
        Get the version property: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input.
        Returns:
        the version value.

      • withVersion

        public ImageReference withVersion​(String version)
        Set the version property: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input.
        Parameters:
        version - the version value to set.
        Returns:
        the ImageReference object itself.

      • exactVersion

        public String exactVersion()
        Get the exactVersion property: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
        Returns:
        the exactVersion value.

      • sharedGalleryImageId

        public String sharedGalleryImageId()
        Get the sharedGalleryImageId property: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
        Returns:
        the sharedGalleryImageId value.

      • withSharedGalleryImageId

        public ImageReference withSharedGalleryImageId​(String sharedGalleryImageId)
        Set the sharedGalleryImageId property: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
        Parameters:
        sharedGalleryImageId - the sharedGalleryImageId value to set.
        Returns:
        the ImageReference object itself.

      • communityGalleryImageId

        public String communityGalleryImageId()
        Get the communityGalleryImageId property: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
        Returns:
        the communityGalleryImageId value.

      • withCommunityGalleryImageId

        public ImageReference withCommunityGalleryImageId​(String communityGalleryImageId)
        Set the communityGalleryImageId property: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
        Parameters:
        communityGalleryImageId - the communityGalleryImageId value to set.
        Returns:
        the ImageReference object itself.

      • withId

        public ImageReference withId​(String id)
        Overrides:
        withId in class com.azure.core.management.SubResource

      • validate

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