pulumi-azure-native-kotlin/com.pulumi.azurenative.compute.kotlin.outputs/GetSnapshotResult

GetSnapshotResult

data class GetSnapshotResult(val completionPercent: Double? = null, val copyCompletionError: CopyCompletionErrorResponse? = null, val creationData: CreationDataResponse, val dataAccessAuthMode: String? = null, val diskAccessId: String? = null, val diskSizeBytes: Double, val diskSizeGB: Int? = null, val diskState: String, val encryption: EncryptionResponse? = null, val encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val incremental: Boolean? = null, val incrementalSnapshotFamilyId: String, val location: String, val managedBy: String, val name: String, val networkAccessPolicy: String? = null, val osType: String? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val purchasePlan: PurchasePlanResponse? = null, val securityProfile: DiskSecurityProfileResponse? = null, val sku: SnapshotSkuResponse? = null, val supportedCapabilities: SupportedCapabilitiesResponse? = null, val supportsHibernation: Boolean? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String)

Snapshot resource.

Constructors

GetSnapshotResult

constructor(completionPercent: Double? = null, copyCompletionError: CopyCompletionErrorResponse? = null, creationData: CreationDataResponse, dataAccessAuthMode: String? = null, diskAccessId: String? = null, diskSizeBytes: Double, diskSizeGB: Int? = null, diskState: String, encryption: EncryptionResponse? = null, encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, extendedLocation: ExtendedLocationResponse? = null, hyperVGeneration: String? = null, id: String, incremental: Boolean? = null, incrementalSnapshotFamilyId: String, location: String, managedBy: String, name: String, networkAccessPolicy: String? = null, osType: String? = null, provisioningState: String, publicNetworkAccess: String? = null, purchasePlan: PurchasePlanResponse? = null, securityProfile: DiskSecurityProfileResponse? = null, sku: SnapshotSkuResponse? = null, supportedCapabilities: SupportedCapabilitiesResponse? = null, supportsHibernation: Boolean? = null, tags: Map<String, String>? = null, timeCreated: String, type: String, uniqueId: String)

Types

Companion

object Companion

Properties

completionPercent

val completionPercent: Double? = null

Percentage complete for the background copy when a resource is created via the CopyStart operation.

copyCompletionError

val copyCompletionError: CopyCompletionErrorResponse? = null

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

creationData

val creationData: CreationDataResponse

Disk source information. CreationData information cannot be changed after the disk has been created.

dataAccessAuthMode

val dataAccessAuthMode: String? = null

Additional authentication requirements when exporting or uploading to a disk or snapshot.

diskAccessId

val diskAccessId: String? = null

ARM id of the DiskAccess resource for using private endpoints on disks.

diskSizeBytes

val diskSizeBytes: Double

The size of the disk in bytes. This field is read only.

diskSizeGB

val diskSizeGB: Int? = null

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.

diskState

val diskState: String

The state of the snapshot.

encryption

val encryption: EncryptionResponse? = null

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

encryptionSettingsCollection

val encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null

Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

extendedLocation

val extendedLocation: ExtendedLocationResponse? = null

The extended location where the snapshot will be created. Extended location cannot be changed.

hyperVGeneration

val hyperVGeneration: String? = null

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

val id: String

Resource Id

incremental

val incremental: Boolean? = null

Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.

incrementalSnapshotFamilyId

val incrementalSnapshotFamilyId: String

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.

location

val location: String

Resource location

managedBy

val managedBy: String

Unused. Always Null.

name

val name: String

Resource name

networkAccessPolicy

val networkAccessPolicy: String? = null

Policy for accessing the disk via network.

osType

val osType: String? = null

The Operating System type.

provisioningState

val provisioningState: String

The disk provisioning state.

publicNetworkAccess

val publicNetworkAccess: String? = null

Policy for controlling export on the disk.

purchasePlan

val purchasePlan: PurchasePlanResponse? = null

Purchase plan information for the image from which the source disk for the snapshot was originally created.

securityProfile

val securityProfile: DiskSecurityProfileResponse? = null

Contains the security related information for the resource.

sku

val sku: SnapshotSkuResponse? = null

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

supportedCapabilities

val supportedCapabilities: SupportedCapabilitiesResponse? = null

List of supported capabilities for the image from which the source disk from the snapshot was originally created.

supportsHibernation

val supportsHibernation: Boolean? = null

Indicates the OS on a snapshot supports hibernation.