Share via

Snapshot Interface

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

Implements

GroupableResource<ComputeManager,SnapshotInner> Refreshable<Snapshot> Updatable<Update>

public interface Snapshot
extends GroupableResource<ComputeManager,SnapshotInner>, Refreshable<Snapshot>, Updatable<Update>

An immutable client-side representation of an Azure managed snapshot.

Method Summary

Modifier and Type Method and Description
abstract void awaitCopyStartCompletion()

Await CopyStart completion indefinitely unless errors are encountered.
abstract Boolean awaitCopyStartCompletion(Duration maxWaitTime)

Await CopyStart completion for a specified timeout.
abstract Mono<Void> awaitCopyStartCompletionAsync()

Await CopyStart completion in async manner.
abstract CopyCompletionError copyCompletionError()

Gets the error details if the background copy of a resource created via the CopyStart operation fails.
abstract Float copyCompletionPercent()

Gets the percentage complete for the background copy when a resource is created via the CopyStart operation.
abstract DiskCreateOption creationMethod()
abstract String grantAccess(int accessDurationInSeconds)

Grants access to the snapshot.
abstract Mono<String> grantAccessAsync(int accessDurationInSeconds)

Grants access to the snapshot asynchronously.
abstract boolean incremental()
abstract OperatingSystemTypes osType()
abstract PublicNetworkAccess publicNetworkAccess()

Whether the snapshot can be accessed from public network.
abstract void revokeAccess()

Revoke access granted to the snapshot.
abstract Mono<Void> revokeAccessAsync()

Revoke access granted to the snapshot asynchronously.
abstract int sizeInGB()
abstract SnapshotSkuType skuType()
abstract CreationSource source()

Method Details

awaitCopyStartCompletion

public abstract void awaitCopyStartCompletion()

Await CopyStart completion indefinitely unless errors are encountered.

awaitCopyStartCompletion

public abstract Boolean awaitCopyStartCompletion(Duration maxWaitTime)

Await CopyStart completion for a specified timeout.

Parameters:

maxWaitTime - max timeout to wait for completion

Returns:

true if CopyStart complete successfully, false if timeout

awaitCopyStartCompletionAsync

public abstract Mono awaitCopyStartCompletionAsync()

Await CopyStart completion in async manner.

Returns:

a representation of the deferred computation of this call

copyCompletionError

public abstract CopyCompletionError copyCompletionError()

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

For latest progress,Snapshot#refresh() or Snapshot#refreshAsync() should be called prior to this method.

Returns:

the error details

copyCompletionPercent

public abstract Float copyCompletionPercent()

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

For latest progress,Snapshot#refresh() or Snapshot#refreshAsync() should be called prior to this method.

Returns:

the percentage complete, ranging from 0 to 100, or null if creationMethod() is not COPY_START

creationMethod

public abstract DiskCreateOption creationMethod()

Returns:

the snapshot creation method

grantAccess

public abstract String grantAccess(int accessDurationInSeconds)

Grants access to the snapshot.

Parameters:

accessDurationInSeconds - the access duration in seconds

Returns:

the read-only SAS URI to the snapshot

grantAccessAsync

public abstract Mono grantAccessAsync(int accessDurationInSeconds)

Grants access to the snapshot asynchronously.

Parameters:

accessDurationInSeconds - the access duration in seconds

Returns:

a representation of the deferred computation of this call returning a read-only SAS URI to the disk

incremental

public abstract boolean incremental()

Returns:

whether a snapshot is incremental

osType

public abstract OperatingSystemTypes osType()

Returns:

the type of operating system in the snapshot

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the snapshot can be accessed from public network.

Returns:

whether the snapshot can be accessed from public network.

revokeAccess

public abstract void revokeAccess()

Revoke access granted to the snapshot.

revokeAccessAsync

public abstract Mono revokeAccessAsync()

Revoke access granted to the snapshot asynchronously.

Returns:

a representation of the deferred computation of this call

sizeInGB

public abstract int sizeInGB()

Returns:

disk size in GB

skuType

public abstract SnapshotSkuType skuType()

Returns:

the snapshot SKU type.

source

public abstract CreationSource source()

Returns:

the details of the source from which snapshot is created

Applies to