Package com.azure.resourcemanager.compute.models

Interface Snapshot

All Superinterfaces:
GroupableResource<ComputeManager,SnapshotInner>, HasId, HasInnerModel<SnapshotInner>, HasManager<ComputeManager>, HasName, HasResourceGroup, Indexable, Refreshable<Snapshot>, Resource, Updatable<Snapshot.Update>
public interface Snapshot extends GroupableResource<ComputeManager,SnapshotInner>, Refreshable<Snapshot>, Updatable<Snapshot.Update>
An immutable client-side representation of an Azure managed snapshot.

  • Method Details

    • skuType

      SnapshotSkuType skuType()
      Returns:
      the snapshot SKU type.

    • incremental

      boolean incremental()
      Returns:
      whether a snapshot is incremental

    • creationMethod

      DiskCreateOption creationMethod()
      Returns:
      the snapshot creation method

    • sizeInGB

      int sizeInGB()
      Returns:
      disk size in GB

    • osType

      OperatingSystemTypes osType()
      Returns:
      the type of operating system in the snapshot

    • source

      CreationSource source()
      Returns:
      the details of the source from which snapshot is created

    • copyCompletionPercent

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

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

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

    • copyCompletionError

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

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

      Returns:
      the error details

    • grantAccess

      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

      Mono<String> 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

    • revokeAccess

      void revokeAccess()
      Revoke access granted to the snapshot.

    • revokeAccessAsync

      Mono<Void> revokeAccessAsync()
      Revoke access granted to the snapshot asynchronously.
      Returns:
      a representation of the deferred computation of this call

    • awaitCopyStartCompletion

      void awaitCopyStartCompletion()
      Await CopyStart completion indefinitely unless errors are encountered.

    • awaitCopyStartCompletion

      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
      Throws:
      com.azure.core.management.exception.ManagementException - if exceptions are encountered

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the snapshot can be accessed from public network.
      Returns:
      whether the snapshot can be accessed from public network.

    • awaitCopyStartCompletionAsync

      Mono<Void> awaitCopyStartCompletionAsync()
      Await CopyStart completion in async manner.
      Returns:
      a representation of the deferred computation of this call