azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

546 строки
47 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties"
name: "SnapshotProperties"
nameWithType: "SnapshotProperties"
summary: "Snapshot resource properties."
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 **SnapshotProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.SnapshotProperties()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.SnapshotProperties()"
name: "SnapshotProperties()"
nameWithType: "SnapshotProperties.SnapshotProperties()"
summary: "Creates an instance of Snapshot<wbr>Properties class."
syntax: "public SnapshotProperties()"
desc: "Creates an instance of SnapshotProperties class."
methods:
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.completionPercent()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.completionPercent()"
name: "completionPercent()"
nameWithType: "SnapshotProperties.completionPercent()"
summary: "Get the completion<wbr>Percent property: Percentage complete for the background copy when a resource is created via the Copy<wbr>Start operation."
syntax: "public Float completionPercent()"
desc: "Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation."
returns:
description: "the completionPercent value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.copyCompletionError()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.copyCompletionError()"
name: "copyCompletionError()"
nameWithType: "SnapshotProperties.copyCompletionError()"
summary: "Get the copy<wbr>Completion<wbr>Error property: Indicates the error details if the background copy of a resource created via the Copy<wbr>Start operation fails."
syntax: "public CopyCompletionError copyCompletionError()"
desc: "Get the copyCompletionError property: Indicates the error details if the background copy of a resource created via the CopyStart operation fails."
returns:
description: "the copyCompletionError value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.CopyCompletionError?alt=com.azure.resourcemanager.compute.models.CopyCompletionError&text=CopyCompletionError\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.creationData()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.creationData()"
name: "creationData()"
nameWithType: "SnapshotProperties.creationData()"
summary: "Get the creation<wbr>Data property: Disk source information."
syntax: "public CreationData creationData()"
desc: "Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created."
returns:
description: "the creationData value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.CreationData?alt=com.azure.resourcemanager.compute.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.dataAccessAuthMode()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.dataAccessAuthMode()"
name: "dataAccessAuthMode()"
nameWithType: "SnapshotProperties.dataAccessAuthMode()"
summary: "Get the data<wbr>Access<wbr>Auth<wbr>Mode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
syntax: "public DataAccessAuthMode dataAccessAuthMode()"
desc: "Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
returns:
description: "the dataAccessAuthMode value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DataAccessAuthMode?alt=com.azure.resourcemanager.compute.models.DataAccessAuthMode&text=DataAccessAuthMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskAccessId()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskAccessId()"
name: "diskAccessId()"
nameWithType: "SnapshotProperties.diskAccessId()"
summary: "Get the disk<wbr>Access<wbr>Id property: ARM id of the Disk<wbr>Access resource for using private endpoints on disks."
syntax: "public String diskAccessId()"
desc: "Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks."
returns:
description: "the diskAccessId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskSizeBytes()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskSizeBytes()"
name: "diskSizeBytes()"
nameWithType: "SnapshotProperties.diskSizeBytes()"
summary: "Get the disk<wbr>Size<wbr>Bytes property: The size of the disk in bytes."
syntax: "public Long diskSizeBytes()"
desc: "Get the diskSizeBytes property: The size of the disk in bytes. This field is read only."
returns:
description: "the diskSizeBytes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskSizeGB()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskSizeGB()"
name: "diskSizeGB()"
nameWithType: "SnapshotProperties.diskSizeGB()"
summary: "Get the disk<wbr>SizeGB property: If creation<wbr>Data.<wbr>create<wbr>Option is Empty, this field is mandatory and it indicates the size of the disk to create."
syntax: "public Integer diskSizeGB()"
desc: "Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size."
returns:
description: "the diskSizeGB value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskState()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.diskState()"
name: "diskState()"
nameWithType: "SnapshotProperties.diskState()"
summary: "Get the disk<wbr>State property: The state of the snapshot."
syntax: "public DiskState diskState()"
desc: "Get the diskState property: The state of the snapshot."
returns:
description: "the diskState value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskState?alt=com.azure.resourcemanager.compute.models.DiskState&text=DiskState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.encryption()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.encryption()"
name: "encryption()"
nameWithType: "SnapshotProperties.encryption()"
summary: "Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
syntax: "public Encryption encryption()"
desc: "Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
returns:
description: "the encryption value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.Encryption?alt=com.azure.resourcemanager.compute.models.Encryption&text=Encryption\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.encryptionSettingsCollection()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.encryptionSettingsCollection()"
name: "encryptionSettingsCollection()"
nameWithType: "SnapshotProperties.encryptionSettingsCollection()"
summary: "Get the encryption<wbr>Settings<wbr>Collection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
syntax: "public EncryptionSettingsCollection encryptionSettingsCollection()"
desc: "Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
returns:
description: "the encryptionSettingsCollection value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.EncryptionSettingsCollection?alt=com.azure.resourcemanager.compute.models.EncryptionSettingsCollection&text=EncryptionSettingsCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "SnapshotProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Snapshot<wbr>Properties from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SnapshotProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of SnapshotProperties from the JsonReader."
returns:
description: "An instance of SnapshotProperties if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.hyperVGeneration()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.hyperVGeneration()"
name: "hyperVGeneration()"
nameWithType: "SnapshotProperties.hyperVGeneration()"
summary: "Get the hyper<wbr>VGeneration property: The hypervisor generation of the Virtual Machine."
syntax: "public HyperVGeneration hyperVGeneration()"
desc: "Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only."
returns:
description: "the hyperVGeneration value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.HyperVGeneration?alt=com.azure.resourcemanager.compute.models.HyperVGeneration&text=HyperVGeneration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.incremental()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.incremental()"
name: "incremental()"
nameWithType: "SnapshotProperties.incremental()"
summary: "Get the incremental property: Whether a snapshot is incremental."
syntax: "public Boolean incremental()"
desc: "Get the incremental property: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed."
returns:
description: "the incremental value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.incrementalSnapshotFamilyId()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.incrementalSnapshotFamilyId()"
name: "incrementalSnapshotFamilyId()"
nameWithType: "SnapshotProperties.incrementalSnapshotFamilyId()"
summary: "Get the incremental<wbr>Snapshot<wbr>Family<wbr>Id property: Incremental snapshots for a disk share an incremental snapshot family id."
syntax: "public String incrementalSnapshotFamilyId()"
desc: "Get the incrementalSnapshotFamilyId property: Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id."
returns:
description: "the incrementalSnapshotFamilyId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.networkAccessPolicy()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.networkAccessPolicy()"
name: "networkAccessPolicy()"
nameWithType: "SnapshotProperties.networkAccessPolicy()"
summary: "Get the network<wbr>Access<wbr>Policy property: Policy for accessing the disk via network."
syntax: "public NetworkAccessPolicy networkAccessPolicy()"
desc: "Get the networkAccessPolicy property: Policy for accessing the disk via network."
returns:
description: "the networkAccessPolicy value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.NetworkAccessPolicy?alt=com.azure.resourcemanager.compute.models.NetworkAccessPolicy&text=NetworkAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.osType()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.osType()"
name: "osType()"
nameWithType: "SnapshotProperties.osType()"
summary: "Get the os<wbr>Type property: The Operating System type."
syntax: "public OperatingSystemTypes osType()"
desc: "Get the osType property: The Operating System type."
returns:
description: "the osType value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.OperatingSystemTypes?alt=com.azure.resourcemanager.compute.models.OperatingSystemTypes&text=OperatingSystemTypes\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.provisioningState()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "SnapshotProperties.provisioningState()"
summary: "Get the provisioning<wbr>State property: The disk provisioning state."
syntax: "public String provisioningState()"
desc: "Get the provisioningState property: The disk provisioning state."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.publicNetworkAccess()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.publicNetworkAccess()"
name: "publicNetworkAccess()"
nameWithType: "SnapshotProperties.publicNetworkAccess()"
summary: "Get the public<wbr>Network<wbr>Access property: Policy for controlling export on the disk."
syntax: "public PublicNetworkAccess publicNetworkAccess()"
desc: "Get the publicNetworkAccess property: Policy for controlling export on the disk."
returns:
description: "the publicNetworkAccess value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PublicNetworkAccess?alt=com.azure.resourcemanager.compute.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.purchasePlan()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.purchasePlan()"
name: "purchasePlan()"
nameWithType: "SnapshotProperties.purchasePlan()"
summary: "Get the purchase<wbr>Plan property: Purchase plan information for the image from which the source disk for the snapshot was originally created."
syntax: "public PurchasePlanAutoGenerated purchasePlan()"
desc: "Get the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created."
returns:
description: "the purchasePlan value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated?alt=com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated&text=PurchasePlanAutoGenerated\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.securityProfile()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.securityProfile()"
name: "securityProfile()"
nameWithType: "SnapshotProperties.securityProfile()"
summary: "Get the security<wbr>Profile property: Contains the security related information for the resource."
syntax: "public DiskSecurityProfile securityProfile()"
desc: "Get the securityProfile property: Contains the security related information for the resource."
returns:
description: "the securityProfile value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskSecurityProfile?alt=com.azure.resourcemanager.compute.models.DiskSecurityProfile&text=DiskSecurityProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.supportedCapabilities()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.supportedCapabilities()"
name: "supportedCapabilities()"
nameWithType: "SnapshotProperties.supportedCapabilities()"
summary: "Get the supported<wbr>Capabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created."
syntax: "public SupportedCapabilities supportedCapabilities()"
desc: "Get the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created."
returns:
description: "the supportedCapabilities value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.SupportedCapabilities?alt=com.azure.resourcemanager.compute.models.SupportedCapabilities&text=SupportedCapabilities\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.supportsHibernation()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.supportsHibernation()"
name: "supportsHibernation()"
nameWithType: "SnapshotProperties.supportsHibernation()"
summary: "Get the supports<wbr>Hibernation property: Indicates the OS on a snapshot supports hibernation."
syntax: "public Boolean supportsHibernation()"
desc: "Get the supportsHibernation property: Indicates the OS on a snapshot supports hibernation."
returns:
description: "the supportsHibernation value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.timeCreated()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.timeCreated()"
name: "timeCreated()"
nameWithType: "SnapshotProperties.timeCreated()"
summary: "Get the time<wbr>Created property: The time when the snapshot was created."
syntax: "public OffsetDateTime timeCreated()"
desc: "Get the timeCreated property: The time when the snapshot was created."
returns:
description: "the timeCreated value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "SnapshotProperties.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.uniqueId()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.uniqueId()"
name: "uniqueId()"
nameWithType: "SnapshotProperties.uniqueId()"
summary: "Get the unique<wbr>Id property: Unique Guid identifying the resource."
syntax: "public String uniqueId()"
desc: "Get the uniqueId property: Unique Guid identifying the resource."
returns:
description: "the uniqueId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.validate()"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.validate()"
name: "validate()"
nameWithType: "SnapshotProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCompletionPercent(java.lang.Float)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCompletionPercent(Float completionPercent)"
name: "withCompletionPercent(Float completionPercent)"
nameWithType: "SnapshotProperties.withCompletionPercent(Float completionPercent)"
summary: "Set the completion<wbr>Percent property: Percentage complete for the background copy when a resource is created via the Copy<wbr>Start operation."
parameters:
- description: "the completionPercent value to set."
name: "completionPercent"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
syntax: "public SnapshotProperties withCompletionPercent(Float completionPercent)"
desc: "Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCopyCompletionError(com.azure.resourcemanager.compute.models.CopyCompletionError)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCopyCompletionError(CopyCompletionError copyCompletionError)"
name: "withCopyCompletionError(CopyCompletionError copyCompletionError)"
nameWithType: "SnapshotProperties.withCopyCompletionError(CopyCompletionError copyCompletionError)"
summary: "Set the copy<wbr>Completion<wbr>Error property: Indicates the error details if the background copy of a resource created via the Copy<wbr>Start operation fails."
parameters:
- description: "the copyCompletionError value to set."
name: "copyCompletionError"
type: "<xref href=\"com.azure.resourcemanager.compute.models.CopyCompletionError?alt=com.azure.resourcemanager.compute.models.CopyCompletionError&text=CopyCompletionError\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withCopyCompletionError(CopyCompletionError copyCompletionError)"
desc: "Set the copyCompletionError property: Indicates the error details if the background copy of a resource created via the CopyStart operation fails."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCreationData(com.azure.resourcemanager.compute.models.CreationData)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withCreationData(CreationData creationData)"
name: "withCreationData(CreationData creationData)"
nameWithType: "SnapshotProperties.withCreationData(CreationData creationData)"
summary: "Set the creation<wbr>Data property: Disk source information."
parameters:
- description: "the creationData value to set."
name: "creationData"
type: "<xref href=\"com.azure.resourcemanager.compute.models.CreationData?alt=com.azure.resourcemanager.compute.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withCreationData(CreationData creationData)"
desc: "Set the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDataAccessAuthMode(com.azure.resourcemanager.compute.models.DataAccessAuthMode)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
name: "withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
nameWithType: "SnapshotProperties.withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
summary: "Set the data<wbr>Access<wbr>Auth<wbr>Mode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
parameters:
- description: "the dataAccessAuthMode value to set."
name: "dataAccessAuthMode"
type: "<xref href=\"com.azure.resourcemanager.compute.models.DataAccessAuthMode?alt=com.azure.resourcemanager.compute.models.DataAccessAuthMode&text=DataAccessAuthMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
desc: "Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDiskAccessId(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDiskAccessId(String diskAccessId)"
name: "withDiskAccessId(String diskAccessId)"
nameWithType: "SnapshotProperties.withDiskAccessId(String diskAccessId)"
summary: "Set the disk<wbr>Access<wbr>Id property: ARM id of the Disk<wbr>Access resource for using private endpoints on disks."
parameters:
- description: "the diskAccessId value to set."
name: "diskAccessId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SnapshotProperties withDiskAccessId(String diskAccessId)"
desc: "Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDiskSizeGB(java.lang.Integer)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withDiskSizeGB(Integer diskSizeGB)"
name: "withDiskSizeGB(Integer diskSizeGB)"
nameWithType: "SnapshotProperties.withDiskSizeGB(Integer diskSizeGB)"
summary: "Set the disk<wbr>SizeGB property: If creation<wbr>Data.<wbr>create<wbr>Option is Empty, this field is mandatory and it indicates the size of the disk to create."
parameters:
- description: "the diskSizeGB value to set."
name: "diskSizeGB"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SnapshotProperties withDiskSizeGB(Integer diskSizeGB)"
desc: "Set the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withEncryption(com.azure.resourcemanager.compute.models.Encryption)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withEncryption(Encryption encryption)"
name: "withEncryption(Encryption encryption)"
nameWithType: "SnapshotProperties.withEncryption(Encryption encryption)"
summary: "Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
parameters:
- description: "the encryption value to set."
name: "encryption"
type: "<xref href=\"com.azure.resourcemanager.compute.models.Encryption?alt=com.azure.resourcemanager.compute.models.Encryption&text=Encryption\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withEncryption(Encryption encryption)"
desc: "Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withEncryptionSettingsCollection(com.azure.resourcemanager.compute.models.EncryptionSettingsCollection)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
name: "withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
nameWithType: "SnapshotProperties.withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
summary: "Set the encryption<wbr>Settings<wbr>Collection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
parameters:
- description: "the encryptionSettingsCollection value to set."
name: "encryptionSettingsCollection"
type: "<xref href=\"com.azure.resourcemanager.compute.models.EncryptionSettingsCollection?alt=com.azure.resourcemanager.compute.models.EncryptionSettingsCollection&text=EncryptionSettingsCollection\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
desc: "Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withHyperVGeneration(com.azure.resourcemanager.compute.models.HyperVGeneration)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withHyperVGeneration(HyperVGeneration hyperVGeneration)"
name: "withHyperVGeneration(HyperVGeneration hyperVGeneration)"
nameWithType: "SnapshotProperties.withHyperVGeneration(HyperVGeneration hyperVGeneration)"
summary: "Set the hyper<wbr>VGeneration property: The hypervisor generation of the Virtual Machine."
parameters:
- description: "the hyperVGeneration value to set."
name: "hyperVGeneration"
type: "<xref href=\"com.azure.resourcemanager.compute.models.HyperVGeneration?alt=com.azure.resourcemanager.compute.models.HyperVGeneration&text=HyperVGeneration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withHyperVGeneration(HyperVGeneration hyperVGeneration)"
desc: "Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withIncremental(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withIncremental(Boolean incremental)"
name: "withIncremental(Boolean incremental)"
nameWithType: "SnapshotProperties.withIncremental(Boolean incremental)"
summary: "Set the incremental property: Whether a snapshot is incremental."
parameters:
- description: "the incremental value to set."
name: "incremental"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public SnapshotProperties withIncremental(Boolean incremental)"
desc: "Set the incremental property: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withNetworkAccessPolicy(com.azure.resourcemanager.compute.models.NetworkAccessPolicy)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
name: "withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
nameWithType: "SnapshotProperties.withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
summary: "Set the network<wbr>Access<wbr>Policy property: Policy for accessing the disk via network."
parameters:
- description: "the networkAccessPolicy value to set."
name: "networkAccessPolicy"
type: "<xref href=\"com.azure.resourcemanager.compute.models.NetworkAccessPolicy?alt=com.azure.resourcemanager.compute.models.NetworkAccessPolicy&text=NetworkAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
desc: "Set the networkAccessPolicy property: Policy for accessing the disk via network."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withOsType(com.azure.resourcemanager.compute.models.OperatingSystemTypes)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withOsType(OperatingSystemTypes osType)"
name: "withOsType(OperatingSystemTypes osType)"
nameWithType: "SnapshotProperties.withOsType(OperatingSystemTypes osType)"
summary: "Set the os<wbr>Type property: The Operating System type."
parameters:
- description: "the osType value to set."
name: "osType"
type: "<xref href=\"com.azure.resourcemanager.compute.models.OperatingSystemTypes?alt=com.azure.resourcemanager.compute.models.OperatingSystemTypes&text=OperatingSystemTypes\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withOsType(OperatingSystemTypes osType)"
desc: "Set the osType property: The Operating System type."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withPublicNetworkAccess(com.azure.resourcemanager.compute.models.PublicNetworkAccess)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
name: "withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
nameWithType: "SnapshotProperties.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
summary: "Set the public<wbr>Network<wbr>Access property: Policy for controlling export on the disk."
parameters:
- description: "the publicNetworkAccess value to set."
name: "publicNetworkAccess"
type: "<xref href=\"com.azure.resourcemanager.compute.models.PublicNetworkAccess?alt=com.azure.resourcemanager.compute.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
desc: "Set the publicNetworkAccess property: Policy for controlling export on the disk."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withPurchasePlan(com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
name: "withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
nameWithType: "SnapshotProperties.withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
summary: "Set the purchase<wbr>Plan property: Purchase plan information for the image from which the source disk for the snapshot was originally created."
parameters:
- description: "the purchasePlan value to set."
name: "purchasePlan"
type: "<xref href=\"com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated?alt=com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated&text=PurchasePlanAutoGenerated\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
desc: "Set the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSecurityProfile(com.azure.resourcemanager.compute.models.DiskSecurityProfile)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSecurityProfile(DiskSecurityProfile securityProfile)"
name: "withSecurityProfile(DiskSecurityProfile securityProfile)"
nameWithType: "SnapshotProperties.withSecurityProfile(DiskSecurityProfile securityProfile)"
summary: "Set the security<wbr>Profile property: Contains the security related information for the resource."
parameters:
- description: "the securityProfile value to set."
name: "securityProfile"
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskSecurityProfile?alt=com.azure.resourcemanager.compute.models.DiskSecurityProfile&text=DiskSecurityProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withSecurityProfile(DiskSecurityProfile securityProfile)"
desc: "Set the securityProfile property: Contains the security related information for the resource."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSupportedCapabilities(com.azure.resourcemanager.compute.models.SupportedCapabilities)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
name: "withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
nameWithType: "SnapshotProperties.withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
summary: "Set the supported<wbr>Capabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created."
parameters:
- description: "the supportedCapabilities value to set."
name: "supportedCapabilities"
type: "<xref href=\"com.azure.resourcemanager.compute.models.SupportedCapabilities?alt=com.azure.resourcemanager.compute.models.SupportedCapabilities&text=SupportedCapabilities\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SnapshotProperties withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
desc: "Set the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSupportsHibernation(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.fluent.models.SnapshotProperties.withSupportsHibernation(Boolean supportsHibernation)"
name: "withSupportsHibernation(Boolean supportsHibernation)"
nameWithType: "SnapshotProperties.withSupportsHibernation(Boolean supportsHibernation)"
summary: "Set the supports<wbr>Hibernation property: Indicates the OS on a snapshot supports hibernation."
parameters:
- description: "the supportsHibernation value to set."
name: "supportsHibernation"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public SnapshotProperties withSupportsHibernation(Boolean supportsHibernation)"
desc: "Set the supportsHibernation property: Indicates the OS on a snapshot supports hibernation."
returns:
description: "the SnapshotProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Snapshot resource properties."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotProperties?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotProperties&text=SnapshotProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.compute.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0