SnapshotInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. core. management. Resource - com.
azure. resourcemanager. compute. fluent. models. SnapshotInner
- com.
- com.
- com.
public final class SnapshotInner
extends Resource
Snapshot resource.
Constructor Summary
Constructor | Description |
---|---|
SnapshotInner() |
Creates an instance of Snapshot |
Method Summary
Modifier and Type | Method and Description |
---|---|
Float |
completionPercent()
Get the completion |
Copy |
copyCompletionError()
Get the copy |
Creation |
creationData()
Get the creation |
Data |
dataAccessAuthMode()
Get the data |
String |
diskAccessId()
Get the disk |
Long |
diskSizeBytes()
Get the disk |
Integer |
diskSizeGB()
Get the disk |
Disk |
diskState()
Get the disk |
Encryption |
encryption()
Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. |
Encryption |
encryptionSettingsCollection()
Get the encryption |
Extended |
extendedLocation()
Get the extended |
static
Snapshot |
fromJson(JsonReader jsonReader)
Reads an instance of Snapshot |
Hyper |
hyperVGeneration()
Get the hyper |
String |
id()
Get the id property: Fully qualified resource Id for the resource. |
Boolean |
incremental()
Get the incremental property: Whether a snapshot is incremental. |
String |
incrementalSnapshotFamilyId()
Get the incremental |
String |
managedBy()
Get the managed |
String |
name()
Get the name property: The name of the resource. |
Network |
networkAccessPolicy()
Get the network |
Operating |
osType()
Get the os |
String |
provisioningState()
Get the provisioning |
Public |
publicNetworkAccess()
Get the public |
Purchase |
purchasePlan()
Get the purchase |
Disk |
securityProfile()
Get the security |
Snapshot |
sku()
Get the sku property: The snapshots sku name. |
Supported |
supportedCapabilities()
Get the supported |
Boolean |
supportsHibernation()
Get the supports |
Offset |
timeCreated()
Get the time |
Json |
toJson(JsonWriter jsonWriter) |
String |
type()
Get the type property: The type of the resource. |
String |
uniqueId()
Get the unique |
void |
validate()
Validates the instance. |
Snapshot |
withCompletionPercent(Float completionPercent)
Set the completion |
Snapshot |
withCopyCompletionError(CopyCompletionError copyCompletionError)
Set the copy |
Snapshot |
withCreationData(CreationData creationData)
Set the creation |
Snapshot |
withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)
Set the data |
Snapshot |
withDiskAccessId(String diskAccessId)
Set the disk |
Snapshot |
withDiskSizeGB(Integer diskSizeGB)
Set the disk |
Snapshot |
withEncryption(Encryption encryption)
Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. |
Snapshot |
withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)
Set the encryption |
Snapshot |
withExtendedLocation(ExtendedLocation extendedLocation)
Set the extended |
Snapshot |
withHyperVGeneration(HyperVGeneration hyperVGeneration)
Set the hyper |
Snapshot |
withIncremental(Boolean incremental)
Set the incremental property: Whether a snapshot is incremental. |
Snapshot |
withLocation(String location) |
Snapshot |
withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)
Set the network |
Snapshot |
withOsType(OperatingSystemTypes osType)
Set the os |
Snapshot |
withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the public |
Snapshot |
withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)
Set the purchase |
Snapshot |
withSecurityProfile(DiskSecurityProfile securityProfile)
Set the security |
Snapshot |
withSku(SnapshotSku sku)
Set the sku property: The snapshots sku name. |
Snapshot |
withSupportedCapabilities(SupportedCapabilities supportedCapabilities)
Set the supported |
Snapshot |
withSupportsHibernation(Boolean supportsHibernation)
Set the supports |
Snapshot |
withTags(Map<String,String> tags) |
Methods inherited from ProxyResource
Methods inherited from Resource
Methods inherited from java.lang.Object
Constructor Details
SnapshotInner
public SnapshotInner()
Creates an instance of SnapshotInner class.
Method Details
completionPercent
public Float completionPercent()
Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
Returns:
copyCompletionError
public CopyCompletionError copyCompletionError()
Get the copyCompletionError property: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
Returns:
creationData
public CreationData creationData()
Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.
Returns:
dataAccessAuthMode
public DataAccessAuthMode dataAccessAuthMode()
Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
Returns:
diskAccessId
public String diskAccessId()
Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
Returns:
diskSizeBytes
public Long diskSizeBytes()
Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.
Returns:
diskSizeGB
public Integer diskSizeGB()
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:
diskState
public DiskState diskState()
Get the diskState property: The state of the snapshot.
Returns:
encryption
public Encryption encryption()
Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Returns:
encryptionSettingsCollection
public EncryptionSettingsCollection encryptionSettingsCollection()
Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
Returns:
extendedLocation
public ExtendedLocation extendedLocation()
Get the extendedLocation property: The extended location where the snapshot will be created. Extended location cannot be changed.
Returns:
fromJson
public static SnapshotInner fromJson(JsonReader jsonReader)
Reads an instance of SnapshotInner from the JsonReader.
Parameters:
Returns:
Throws:
hyperVGeneration
public HyperVGeneration hyperVGeneration()
Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
Returns:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
SnapshotInner.id()Returns:
incremental
public Boolean incremental()
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:
incrementalSnapshotFamilyId
public String incrementalSnapshotFamilyId()
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:
managedBy
public String managedBy()
Get the managedBy property: Unused. Always Null.
Returns:
name
public String name()
Get the name property: The name of the resource.
Overrides:
SnapshotInner.name()Returns:
networkAccessPolicy
public NetworkAccessPolicy networkAccessPolicy()
Get the networkAccessPolicy property: Policy for accessing the disk via network.
Returns:
osType
public OperatingSystemTypes osType()
Get the osType property: The Operating System type.
Returns:
provisioningState
public String provisioningState()
Get the provisioningState property: The disk provisioning state.
Returns:
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Policy for controlling export on the disk.
Returns:
purchasePlan
public PurchasePlanAutoGenerated purchasePlan()
Get the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created.
Returns:
securityProfile
public DiskSecurityProfile securityProfile()
Get the securityProfile property: Contains the security related information for the resource.
Returns:
sku
public SnapshotSku sku()
Get the sku property: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
Returns:
supportedCapabilities
public SupportedCapabilities supportedCapabilities()
Get the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
Returns:
supportsHibernation
public Boolean supportsHibernation()
Get the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
Returns:
timeCreated
public OffsetDateTime timeCreated()
Get the timeCreated property: The time when the snapshot was created.
Returns:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
SnapshotInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
SnapshotInner.type()Returns:
uniqueId
public String uniqueId()
Get the uniqueId property: Unique Guid identifying the resource.
Returns:
validate
public void validate()
Validates the instance.
withCompletionPercent
public SnapshotInner withCompletionPercent(Float completionPercent)
Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
Parameters:
Returns:
withCopyCompletionError
public SnapshotInner withCopyCompletionError(CopyCompletionError copyCompletionError)
Set the copyCompletionError property: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
Parameters:
Returns:
withCreationData
public SnapshotInner withCreationData(CreationData creationData)
Set the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.
Parameters:
Returns:
withDataAccessAuthMode
public SnapshotInner withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)
Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
Parameters:
Returns:
withDiskAccessId
public SnapshotInner withDiskAccessId(String diskAccessId)
Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
Parameters:
Returns:
withDiskSizeGB
public SnapshotInner withDiskSizeGB(Integer diskSizeGB)
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.
Parameters:
Returns:
withEncryption
public SnapshotInner withEncryption(Encryption encryption)
Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Parameters:
Returns:
withEncryptionSettingsCollection
public SnapshotInner withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)
Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
Parameters:
Returns:
withExtendedLocation
public SnapshotInner withExtendedLocation(ExtendedLocation extendedLocation)
Set the extendedLocation property: The extended location where the snapshot will be created. Extended location cannot be changed.
Parameters:
Returns:
withHyperVGeneration
public SnapshotInner withHyperVGeneration(HyperVGeneration hyperVGeneration)
Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
Parameters:
Returns:
withIncremental
public SnapshotInner withIncremental(Boolean incremental)
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.
Parameters:
Returns:
withLocation
public SnapshotInner withLocation(String location)
Overrides:
SnapshotInner.withLocation(String location)Parameters:
withNetworkAccessPolicy
public SnapshotInner withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)
Set the networkAccessPolicy property: Policy for accessing the disk via network.
Parameters:
Returns:
withOsType
public SnapshotInner withOsType(OperatingSystemTypes osType)
Set the osType property: The Operating System type.
Parameters:
Returns:
withPublicNetworkAccess
public SnapshotInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Policy for controlling export on the disk.
Parameters:
Returns:
withPurchasePlan
public SnapshotInner withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)
Set the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created.
Parameters:
Returns:
withSecurityProfile
public SnapshotInner withSecurityProfile(DiskSecurityProfile securityProfile)
Set the securityProfile property: Contains the security related information for the resource.
Parameters:
Returns:
withSku
public SnapshotInner withSku(SnapshotSku sku)
Set the sku property: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
Parameters:
Returns:
withSupportedCapabilities
public SnapshotInner withSupportedCapabilities(SupportedCapabilities supportedCapabilities)
Set the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
Parameters:
Returns:
withSupportsHibernation
public SnapshotInner withSupportsHibernation(Boolean supportsHibernation)
Set the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
Parameters:
Returns:
withTags
public SnapshotInner withTags(Map
Overrides:
SnapshotInner.withTags(Map<String,String> tags)Parameters: