204 строки
15 KiB
YAML
204 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.compute.models.Snapshot"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot"
|
|
name: "Snapshot"
|
|
nameWithType: "Snapshot"
|
|
summary: "An immutable client-side representation of an Azure managed snapshot."
|
|
syntax: "public interface **Snapshot**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.ComputeManager?alt=com.azure.resourcemanager.compute.ComputeManager&text=ComputeManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotInner?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotInner&text=SnapshotInner\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Refreshable?alt=com.azure.resourcemanager.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.Snapshot?alt=com.azure.resourcemanager.compute.models.Snapshot&text=Snapshot\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.Snapshot.Update?alt=com.azure.resourcemanager.compute.models.Snapshot.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletion()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletion()"
|
|
name: "awaitCopyStartCompletion()"
|
|
nameWithType: "Snapshot.awaitCopyStartCompletion()"
|
|
summary: "Await Copy<wbr>Start completion indefinitely unless errors are encountered."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract void awaitCopyStartCompletion()"
|
|
desc: "Await CopyStart completion indefinitely unless errors are encountered."
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletion(java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletion(Duration maxWaitTime)"
|
|
name: "awaitCopyStartCompletion(Duration maxWaitTime)"
|
|
nameWithType: "Snapshot.awaitCopyStartCompletion(Duration maxWaitTime)"
|
|
summary: "Await Copy<wbr>Start completion for a specified timeout."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "max timeout to wait for completion"
|
|
name: "maxWaitTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public abstract Boolean awaitCopyStartCompletion(Duration maxWaitTime)"
|
|
desc: "Await CopyStart completion for a specified timeout."
|
|
returns:
|
|
description: "true if CopyStart complete successfully, false if timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletionAsync()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.awaitCopyStartCompletionAsync()"
|
|
name: "awaitCopyStartCompletionAsync()"
|
|
nameWithType: "Snapshot.awaitCopyStartCompletionAsync()"
|
|
summary: "Await Copy<wbr>Start completion in async manner."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Mono<Void> awaitCopyStartCompletionAsync()"
|
|
desc: "Await CopyStart completion in async manner."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.copyCompletionError()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.copyCompletionError()"
|
|
name: "copyCompletionError()"
|
|
nameWithType: "Snapshot.copyCompletionError()"
|
|
summary: "Gets the error details if the background copy of a resource created via the Copy<wbr>Start operation fails."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract CopyCompletionError copyCompletionError()"
|
|
desc: "Gets the error details if the background copy of a resource created via the CopyStart operation fails.\n\nFor latest progress,<xref uid=\"com.azure.resourcemanager.compute.models.Snapshot.refresh*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Snapshot#refresh()\"></xref> or <xref uid=\"com.azure.resourcemanager.compute.models.Snapshot.refreshAsync*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Snapshot#refreshAsync()\"></xref> should be called prior to this method."
|
|
returns:
|
|
description: "the error details"
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.CopyCompletionError?alt=com.azure.resourcemanager.compute.models.CopyCompletionError&text=CopyCompletionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.copyCompletionPercent()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.copyCompletionPercent()"
|
|
name: "copyCompletionPercent()"
|
|
nameWithType: "Snapshot.copyCompletionPercent()"
|
|
summary: "Gets the percentage complete for the background copy when a resource is created via the Copy<wbr>Start operation."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Float copyCompletionPercent()"
|
|
desc: "Gets the percentage complete for the background copy when a resource is created via the CopyStart operation.\n\nFor latest progress,<xref uid=\"com.azure.resourcemanager.compute.models.Snapshot.refresh*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Snapshot#refresh()\"></xref> or <xref uid=\"com.azure.resourcemanager.compute.models.Snapshot.refreshAsync*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Snapshot#refreshAsync()\"></xref> should be called prior to this method."
|
|
returns:
|
|
description: "the percentage complete, ranging from 0 to 100, or null if <xref uid=\"com.azure.resourcemanager.compute.models.Snapshot.creationMethod()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Snapshot#creationMethod()\"></xref> is not <xref uid=\"com.azure.resourcemanager.compute.models.DiskCreateOption.COPY_START\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DiskCreateOption#COPY_START\"></xref>"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.creationMethod()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.creationMethod()"
|
|
name: "creationMethod()"
|
|
nameWithType: "Snapshot.creationMethod()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract DiskCreateOption creationMethod()"
|
|
returns:
|
|
description: "the snapshot creation method"
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskCreateOption?alt=com.azure.resourcemanager.compute.models.DiskCreateOption&text=DiskCreateOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.grantAccess(int)"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.grantAccess(int accessDurationInSeconds)"
|
|
name: "grantAccess(int accessDurationInSeconds)"
|
|
nameWithType: "Snapshot.grantAccess(int accessDurationInSeconds)"
|
|
summary: "Grants access to the snapshot."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the access duration in seconds"
|
|
name: "accessDurationInSeconds"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract String grantAccess(int accessDurationInSeconds)"
|
|
desc: "Grants access to the snapshot."
|
|
returns:
|
|
description: "the read-only SAS URI to the snapshot"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.grantAccessAsync(int)"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.grantAccessAsync(int accessDurationInSeconds)"
|
|
name: "grantAccessAsync(int accessDurationInSeconds)"
|
|
nameWithType: "Snapshot.grantAccessAsync(int accessDurationInSeconds)"
|
|
summary: "Grants access to the snapshot asynchronously."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the access duration in seconds"
|
|
name: "accessDurationInSeconds"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Mono<String> grantAccessAsync(int accessDurationInSeconds)"
|
|
desc: "Grants access to the snapshot asynchronously."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call returning a read-only SAS URI to the disk"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.incremental()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.incremental()"
|
|
name: "incremental()"
|
|
nameWithType: "Snapshot.incremental()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean incremental()"
|
|
returns:
|
|
description: "whether a snapshot is incremental"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.osType()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.osType()"
|
|
name: "osType()"
|
|
nameWithType: "Snapshot.osType()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract OperatingSystemTypes osType()"
|
|
returns:
|
|
description: "the type of operating system in the snapshot"
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.OperatingSystemTypes?alt=com.azure.resourcemanager.compute.models.OperatingSystemTypes&text=OperatingSystemTypes\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.publicNetworkAccess()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.publicNetworkAccess()"
|
|
name: "publicNetworkAccess()"
|
|
nameWithType: "Snapshot.publicNetworkAccess()"
|
|
summary: "Whether the snapshot can be accessed from public network."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract PublicNetworkAccess publicNetworkAccess()"
|
|
desc: "Whether the snapshot can be accessed from public network."
|
|
returns:
|
|
description: "whether the snapshot can be accessed from public network."
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.PublicNetworkAccess?alt=com.azure.resourcemanager.compute.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.revokeAccess()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.revokeAccess()"
|
|
name: "revokeAccess()"
|
|
nameWithType: "Snapshot.revokeAccess()"
|
|
summary: "Revoke access granted to the snapshot."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract void revokeAccess()"
|
|
desc: "Revoke access granted to the snapshot."
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.revokeAccessAsync()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.revokeAccessAsync()"
|
|
name: "revokeAccessAsync()"
|
|
nameWithType: "Snapshot.revokeAccessAsync()"
|
|
summary: "Revoke access granted to the snapshot asynchronously."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Mono<Void> revokeAccessAsync()"
|
|
desc: "Revoke access granted to the snapshot asynchronously."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.sizeInGB()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.sizeInGB()"
|
|
name: "sizeInGB()"
|
|
nameWithType: "Snapshot.sizeInGB()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int sizeInGB()"
|
|
returns:
|
|
description: "disk size in GB"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.skuType()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.skuType()"
|
|
name: "skuType()"
|
|
nameWithType: "Snapshot.skuType()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract SnapshotSkuType skuType()"
|
|
returns:
|
|
description: "the snapshot SKU type."
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.SnapshotSkuType?alt=com.azure.resourcemanager.compute.models.SnapshotSkuType&text=SnapshotSkuType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.Snapshot.source()"
|
|
fullName: "com.azure.resourcemanager.compute.models.Snapshot.source()"
|
|
name: "source()"
|
|
nameWithType: "Snapshot.source()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract CreationSource source()"
|
|
returns:
|
|
description: "the details of the source from which snapshot is created"
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.CreationSource?alt=com.azure.resourcemanager.compute.models.CreationSource&text=CreationSource\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "An immutable client-side representation of an Azure managed snapshot."
|
|
implements:
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.ComputeManager?alt=com.azure.resourcemanager.compute.ComputeManager&text=ComputeManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.compute.fluent.models.SnapshotInner?alt=com.azure.resourcemanager.compute.fluent.models.SnapshotInner&text=SnapshotInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Refreshable?alt=com.azure.resourcemanager.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.Snapshot?alt=com.azure.resourcemanager.compute.models.Snapshot&text=Snapshot\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.Snapshot.Update?alt=com.azure.resourcemanager.compute.models.Snapshot.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.compute.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.42.0
|