Class VMGalleryApplication

java.lang.Object
com.azure.resourcemanager.compute.models.VMGalleryApplication
All Implemented Interfaces:
com.azure.json.JsonSerializable<VMGalleryApplication>

public final class VMGalleryApplication extends Object implements com.azure.json.JsonSerializable<VMGalleryApplication>
Specifies the required information to reference a compute gallery application version.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of VMGalleryApplication class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the configurationReference property: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
    Get the enableAutomaticUpgrade property: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VMGalleryApplication from the JsonReader.
    Get the order property: Optional, Specifies the order in which the packages have to be installed.
    Get the packageReferenceId property: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}.
    Get the tags property: Optional, Specifies a passthrough value for more generic context.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    Get the treatFailureAsDeploymentFailure property: Optional, If true, any failure for any operation in the VmApplication will fail the deployment.
    void
    Validates the instance.
    withConfigurationReference(String configurationReference)
    Set the configurationReference property: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
    withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)
    Set the enableAutomaticUpgrade property: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.
    Set the order property: Optional, Specifies the order in which the packages have to be installed.
    withPackageReferenceId(String packageReferenceId)
    Set the packageReferenceId property: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}.
    Set the tags property: Optional, Specifies a passthrough value for more generic context.
    withTreatFailureAsDeploymentFailure(Boolean treatFailureAsDeploymentFailure)
    Set the treatFailureAsDeploymentFailure property: Optional, If true, any failure for any operation in the VmApplication will fail the deployment.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Constructor Details

    • VMGalleryApplication

      public VMGalleryApplication()
      Creates an instance of VMGalleryApplication class.
  • Method Details

    • tags

      public String tags()
      Get the tags property: Optional, Specifies a passthrough value for more generic context.
      Returns:
      the tags value.
    • withTags

      public VMGalleryApplication withTags(String tags)
      Set the tags property: Optional, Specifies a passthrough value for more generic context.
      Parameters:
      tags - the tags value to set.
      Returns:
      the VMGalleryApplication object itself.
    • order

      public Integer order()
      Get the order property: Optional, Specifies the order in which the packages have to be installed.
      Returns:
      the order value.
    • withOrder

      public VMGalleryApplication withOrder(Integer order)
      Set the order property: Optional, Specifies the order in which the packages have to be installed.
      Parameters:
      order - the order value to set.
      Returns:
      the VMGalleryApplication object itself.
    • packageReferenceId

      public String packageReferenceId()
      Get the packageReferenceId property: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}.
      Returns:
      the packageReferenceId value.
    • withPackageReferenceId

      public VMGalleryApplication withPackageReferenceId(String packageReferenceId)
      Set the packageReferenceId property: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}.
      Parameters:
      packageReferenceId - the packageReferenceId value to set.
      Returns:
      the VMGalleryApplication object itself.
    • configurationReference

      public String configurationReference()
      Get the configurationReference property: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
      Returns:
      the configurationReference value.
    • withConfigurationReference

      public VMGalleryApplication withConfigurationReference(String configurationReference)
      Set the configurationReference property: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
      Parameters:
      configurationReference - the configurationReference value to set.
      Returns:
      the VMGalleryApplication object itself.
    • treatFailureAsDeploymentFailure

      public Boolean treatFailureAsDeploymentFailure()
      Get the treatFailureAsDeploymentFailure property: Optional, If true, any failure for any operation in the VmApplication will fail the deployment.
      Returns:
      the treatFailureAsDeploymentFailure value.
    • withTreatFailureAsDeploymentFailure

      public VMGalleryApplication withTreatFailureAsDeploymentFailure(Boolean treatFailureAsDeploymentFailure)
      Set the treatFailureAsDeploymentFailure property: Optional, If true, any failure for any operation in the VmApplication will fail the deployment.
      Parameters:
      treatFailureAsDeploymentFailure - the treatFailureAsDeploymentFailure value to set.
      Returns:
      the VMGalleryApplication object itself.
    • enableAutomaticUpgrade

      public Boolean enableAutomaticUpgrade()
      Get the enableAutomaticUpgrade property: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.
      Returns:
      the enableAutomaticUpgrade value.
    • withEnableAutomaticUpgrade

      public VMGalleryApplication withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)
      Set the enableAutomaticUpgrade property: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.
      Parameters:
      enableAutomaticUpgrade - the enableAutomaticUpgrade value to set.
      Returns:
      the VMGalleryApplication object itself.
    • validate

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

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<VMGalleryApplication>
      Throws:
      IOException
    • fromJson

      public static VMGalleryApplication fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VMGalleryApplication from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VMGalleryApplication if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the VMGalleryApplication.