azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.batch.models.ImageReference.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.ImageReference"
fullName: "com.azure.resourcemanager.batch.models.ImageReference"
name: "ImageReference"
nameWithType: "ImageReference"
summary: "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ImageReference**"
constructors:
- uid: "com.azure.resourcemanager.batch.models.ImageReference.ImageReference()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.ImageReference()"
  name: "ImageReference()"
  nameWithType: "ImageReference.ImageReference()"
  syntax: "public ImageReference()"
methods:
- uid: "com.azure.resourcemanager.batch.models.ImageReference.id()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.id()"
  name: "id()"
  nameWithType: "ImageReference.id()"
  summary: "Get the id property: The ARM resource identifier of the Shared Image Gallery Image."
  syntax: "public String id()"
  desc: "Get the id property: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroup\\}/providers/Microsoft.Compute/galleries/\\{galleryName\\}/images/\\{imageDefinitionName\\}/versions/\\{versionId\\}. This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics\\#virtual-network-vnet-and-firewall-configuration."
  returns:
    description: "the id value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.offer()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.offer()"
  name: "offer()"
  nameWithType: "ImageReference.offer()"
  summary: "Get the offer property: The offer type of the Azure Virtual Machines Marketplace image."
  syntax: "public String offer()"
  desc: "Get the offer property: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer."
  returns:
    description: "the offer value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.publisher()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.publisher()"
  name: "publisher()"
  nameWithType: "ImageReference.publisher()"
  summary: "Get the publisher property: The publisher of the Azure Virtual Machines Marketplace image."
  syntax: "public String publisher()"
  desc: "Get the publisher property: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer."
  returns:
    description: "the publisher value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.sku()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.sku()"
  name: "sku()"
  nameWithType: "ImageReference.sku()"
  summary: "Get the sku property: The SKU of the Azure Virtual Machines Marketplace image."
  syntax: "public String sku()"
  desc: "Get the sku property: The SKU of the Azure Virtual Machines Marketplace image. For example, 18.04-LTS or 2022-datacenter."
  returns:
    description: "the sku value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.validate()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.validate()"
  name: "validate()"
  nameWithType: "ImageReference.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.models.ImageReference.version()"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.version()"
  name: "version()"
  nameWithType: "ImageReference.version()"
  summary: "Get the version property: The version of the Azure Virtual Machines Marketplace image."
  syntax: "public String version()"
  desc: "Get the version property: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'."
  returns:
    description: "the version value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.withId(java.lang.String)"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.withId(String id)"
  name: "withId(String id)"
  nameWithType: "ImageReference.withId(String id)"
  summary: "Set the id property: The ARM resource identifier of the Shared Image Gallery Image."
  parameters:
  - description: "the id value to set."
    name: "id"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ImageReference withId(String id)"
  desc: "Set the id property: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroup\\}/providers/Microsoft.Compute/galleries/\\{galleryName\\}/images/\\{imageDefinitionName\\}/versions/\\{versionId\\}. This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics\\#virtual-network-vnet-and-firewall-configuration."
  returns:
    description: "the ImageReference object itself."
    type: "<xref href=\"com.azure.resourcemanager.batch.models.ImageReference?alt=com.azure.resourcemanager.batch.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.withOffer(java.lang.String)"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.withOffer(String offer)"
  name: "withOffer(String offer)"
  nameWithType: "ImageReference.withOffer(String offer)"
  summary: "Set the offer property: The offer type of the Azure Virtual Machines Marketplace image."
  parameters:
  - description: "the offer value to set."
    name: "offer"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ImageReference withOffer(String offer)"
  desc: "Set the offer property: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer."
  returns:
    description: "the ImageReference object itself."
    type: "<xref href=\"com.azure.resourcemanager.batch.models.ImageReference?alt=com.azure.resourcemanager.batch.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.withPublisher(java.lang.String)"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.withPublisher(String publisher)"
  name: "withPublisher(String publisher)"
  nameWithType: "ImageReference.withPublisher(String publisher)"
  summary: "Set the publisher property: The publisher of the Azure Virtual Machines Marketplace image."
  parameters:
  - description: "the publisher value to set."
    name: "publisher"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ImageReference withPublisher(String publisher)"
  desc: "Set the publisher property: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer."
  returns:
    description: "the ImageReference object itself."
    type: "<xref href=\"com.azure.resourcemanager.batch.models.ImageReference?alt=com.azure.resourcemanager.batch.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.withSku(java.lang.String)"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.withSku(String sku)"
  name: "withSku(String sku)"
  nameWithType: "ImageReference.withSku(String sku)"
  summary: "Set the sku property: The SKU of the Azure Virtual Machines Marketplace image."
  parameters:
  - description: "the sku value to set."
    name: "sku"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ImageReference withSku(String sku)"
  desc: "Set the sku property: The SKU of the Azure Virtual Machines Marketplace image. For example, 18.04-LTS or 2022-datacenter."
  returns:
    description: "the ImageReference object itself."
    type: "<xref href=\"com.azure.resourcemanager.batch.models.ImageReference?alt=com.azure.resourcemanager.batch.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ImageReference.withVersion(java.lang.String)"
  fullName: "com.azure.resourcemanager.batch.models.ImageReference.withVersion(String version)"
  name: "withVersion(String version)"
  nameWithType: "ImageReference.withVersion(String version)"
  summary: "Set the version property: The version of the Azure Virtual Machines Marketplace image."
  parameters:
  - description: "the version value to set."
    name: "version"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ImageReference withVersion(String version)"
  desc: "Set the version property: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'."
  returns:
    description: "the ImageReference object itself."
    type: "<xref href=\"com.azure.resourcemanager.batch.models.ImageReference?alt=com.azure.resourcemanager.batch.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0