Share via


BatchImageReference Class

Definition

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.

public class BatchImageReference : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Batch.Models.BatchImageReference>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Batch.Models.BatchImageReference>
public class BatchImageReference
type BatchImageReference = class
    interface IJsonModel<BatchImageReference>
    interface IPersistableModel<BatchImageReference>
type BatchImageReference = class
Public Class BatchImageReference
Implements IJsonModel(Of BatchImageReference), IPersistableModel(Of BatchImageReference)
Public Class BatchImageReference
Inheritance
BatchImageReference
Implements

Constructors

BatchImageReference()

Initializes a new instance of BatchImageReference.

Properties

CommunityGalleryImageId

This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.

Id

This property is mutually exclusive with other properties. The Azure Compute 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.

Offer

For example, UbuntuServer or WindowsServer.

Publisher

For example, Canonical or MicrosoftWindowsServer.

SharedGalleryImageId

This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.

Sku

For example, 18.04-LTS or 2022-datacenter.

Version

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Explicit Interface Implementations

IJsonModel<BatchImageReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchImageReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchImageReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchImageReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchImageReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to