Interface Snapshot

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Snapshot.Definition
    The entirety of the managed snapshot definition.
    static interface 
    Snapshot.DefinitionStages
    Grouping of managed snapshot definition stages.
    static interface 
    Snapshot.Update
    The template for an update operation, containing all the settings that can be modified.
    static interface 
    Snapshot.UpdateStages
    Grouping of managed snapshot update stages.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    awaitCopyStartCompletion()
    Await CopyStart completion indefinitely unless errors are encountered.
    Boolean
    awaitCopyStartCompletion(Duration maxWaitTime)
    Await CopyStart completion for a specified timeout.
    Mono<Void>
    awaitCopyStartCompletionAsync()
    Await CopyStart completion in async manner.
    CopyCompletionError
    copyCompletionError()
    Gets the error details if the background copy of a resource created via the CopyStart operation fails.
    Float
    copyCompletionPercent()
    Gets the percentage complete for the background copy when a resource is created via the CopyStart operation.
    DiskCreateOption
    creationMethod()
    Gets the snapshot creation method.
    String
    grantAccess(int accessDurationInSeconds)
    Grants access to the snapshot.
    Mono<String>
    grantAccessAsync(int accessDurationInSeconds)
    Grants access to the snapshot asynchronously.
    boolean
    incremental()
    Checks whether a snapshot id incremental.
    OperatingSystemTypes
    osType()
    Gets the type of operating system in the snapshot.
    PublicNetworkAccess
    publicNetworkAccess()
    Checks whether the snapshot can be accessed from public network.
    void
    revokeAccess()
    Revoke access granted to the snapshot.
    Mono<Void>
    revokeAccessAsync()
    Revoke access granted to the snapshot asynchronously.
    int
    sizeInGB()
    Gets disk size in GB.
    SnapshotSkuType
    skuType()
    Gets the snapshot SKU type.
    CreationSource
    source()
    Gets the details of the source from which snapshot is created.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • skuType

      SnapshotSkuType skuType()
      Gets the snapshot SKU type.
      Returns:
      the snapshot SKU type.

    • incremental

      boolean incremental()
      Checks whether a snapshot id incremental.
      Returns:
      whether a snapshot is incremental

    • creationMethod

      DiskCreateOption creationMethod()
      Gets the snapshot creation method.
      Returns:
      the snapshot creation method

    • sizeInGB

      int sizeInGB()
      Gets disk size in GB.
      Returns:
      disk size in GB

    • osType

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

    • source

      CreationSource source()
      Gets the details of the source from which snapshot is created.
      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()
      Checks 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