214 строки
16 KiB
YAML
214 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.ImageReference"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference"
|
|
name: "ImageReference"
|
|
nameWithType: "ImageReference"
|
|
summary: "A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image."
|
|
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 class **ImageReference**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.ImageReference()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.ImageReference()"
|
|
name: "ImageReference()"
|
|
nameWithType: "ImageReference.ImageReference()"
|
|
syntax: "public ImageReference()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.communityGalleryImageId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.communityGalleryImageId()"
|
|
name: "communityGalleryImageId()"
|
|
nameWithType: "ImageReference.communityGalleryImageId()"
|
|
summary: "Get this property is mutually exclusive with other properties and can be fetched from community gallery image GET call."
|
|
syntax: "public String communityGalleryImageId()"
|
|
desc: "Get this property is mutually exclusive with other properties and can be fetched from community gallery image GET call."
|
|
returns:
|
|
description: "the communityGalleryImageId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.exactVersion()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.exactVersion()"
|
|
name: "exactVersion()"
|
|
nameWithType: "ImageReference.exactVersion()"
|
|
summary: "Get the specific version of the platform image or marketplace image used to create the node."
|
|
syntax: "public String exactVersion()"
|
|
desc: "Get the specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'."
|
|
returns:
|
|
description: "the exactVersion value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.offer()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.offer()"
|
|
name: "offer()"
|
|
nameWithType: "ImageReference.offer()"
|
|
summary: "Get for example, Ubuntu<wbr>Server or Windows<wbr>Server."
|
|
syntax: "public String offer()"
|
|
desc: "Get 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.microsoft.azure.batch.protocol.models.ImageReference.publisher()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.publisher()"
|
|
name: "publisher()"
|
|
nameWithType: "ImageReference.publisher()"
|
|
summary: "Get for example, Canonical or Microsoft<wbr>Windows<wbr>Server."
|
|
syntax: "public String publisher()"
|
|
desc: "Get 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.microsoft.azure.batch.protocol.models.ImageReference.sharedGalleryImageId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.sharedGalleryImageId()"
|
|
name: "sharedGalleryImageId()"
|
|
nameWithType: "ImageReference.sharedGalleryImageId()"
|
|
summary: "Get this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call."
|
|
syntax: "public String sharedGalleryImageId()"
|
|
desc: "Get this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call."
|
|
returns:
|
|
description: "the sharedGalleryImageId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.sku()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.sku()"
|
|
name: "sku()"
|
|
nameWithType: "ImageReference.sku()"
|
|
summary: "Get for example, 18.04-LTS or 2019-Datacenter."
|
|
syntax: "public String sku()"
|
|
desc: "Get for example, 18.04-LTS or 2019-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.microsoft.azure.batch.protocol.models.ImageReference.version()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.version()"
|
|
name: "version()"
|
|
nameWithType: "ImageReference.version()"
|
|
summary: "Get a value of 'latest' can be specified to select the latest version of an Image."
|
|
syntax: "public String version()"
|
|
desc: "Get 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.microsoft.azure.batch.protocol.models.ImageReference.virtualMachineImageId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.virtualMachineImageId()"
|
|
name: "virtualMachineImageId()"
|
|
nameWithType: "ImageReference.virtualMachineImageId()"
|
|
summary: "Get this property is mutually exclusive with other Image<wbr>Reference properties."
|
|
syntax: "public String virtualMachineImageId()"
|
|
desc: "Get this property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/azure/batch/batch-api-basics\\#virtual-network-vnet-and-firewall-configuration."
|
|
returns:
|
|
description: "the virtualMachineImageId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withCommunityGalleryImageId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withCommunityGalleryImageId(String communityGalleryImageId)"
|
|
name: "withCommunityGalleryImageId(String communityGalleryImageId)"
|
|
nameWithType: "ImageReference.withCommunityGalleryImageId(String communityGalleryImageId)"
|
|
summary: "Set this property is mutually exclusive with other properties and can be fetched from community gallery image GET call."
|
|
parameters:
|
|
- description: "the communityGalleryImageId value to set"
|
|
name: "communityGalleryImageId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ImageReference withCommunityGalleryImageId(String communityGalleryImageId)"
|
|
desc: "Set this property is mutually exclusive with other properties and can be fetched from community gallery image GET call."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withOffer(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withOffer(String offer)"
|
|
name: "withOffer(String offer)"
|
|
nameWithType: "ImageReference.withOffer(String offer)"
|
|
summary: "Set for example, Ubuntu<wbr>Server or Windows<wbr>Server."
|
|
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 for example, UbuntuServer or WindowsServer."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withPublisher(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withPublisher(String publisher)"
|
|
name: "withPublisher(String publisher)"
|
|
nameWithType: "ImageReference.withPublisher(String publisher)"
|
|
summary: "Set for example, Canonical or Microsoft<wbr>Windows<wbr>Server."
|
|
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 for example, Canonical or MicrosoftWindowsServer."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withSharedGalleryImageId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withSharedGalleryImageId(String sharedGalleryImageId)"
|
|
name: "withSharedGalleryImageId(String sharedGalleryImageId)"
|
|
nameWithType: "ImageReference.withSharedGalleryImageId(String sharedGalleryImageId)"
|
|
summary: "Set this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call."
|
|
parameters:
|
|
- description: "the sharedGalleryImageId value to set"
|
|
name: "sharedGalleryImageId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ImageReference withSharedGalleryImageId(String sharedGalleryImageId)"
|
|
desc: "Set this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withSku(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withSku(String sku)"
|
|
name: "withSku(String sku)"
|
|
nameWithType: "ImageReference.withSku(String sku)"
|
|
summary: "Set for example, 18.04-LTS or 2019-Datacenter."
|
|
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 for example, 18.04-LTS or 2019-Datacenter."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withVersion(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withVersion(String version)"
|
|
name: "withVersion(String version)"
|
|
nameWithType: "ImageReference.withVersion(String version)"
|
|
summary: "Set a value of 'latest' can be specified to select the latest version of an 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 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.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ImageReference.withVirtualMachineImageId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ImageReference.withVirtualMachineImageId(String virtualMachineImageId)"
|
|
name: "withVirtualMachineImageId(String virtualMachineImageId)"
|
|
nameWithType: "ImageReference.withVirtualMachineImageId(String virtualMachineImageId)"
|
|
summary: "Set this property is mutually exclusive with other Image<wbr>Reference properties."
|
|
parameters:
|
|
- description: "the virtualMachineImageId value to set"
|
|
name: "virtualMachineImageId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ImageReference withVirtualMachineImageId(String virtualMachineImageId)"
|
|
desc: "Set this property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/azure/batch/batch-api-basics\\#virtual-network-vnet-and-firewall-configuration."
|
|
returns:
|
|
description: "the ImageReference object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ImageReference?alt=com.microsoft.azure.batch.protocol.models.ImageReference&text=ImageReference\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|