Share via


ComputeExtensions.GetSnapshot Method

Definition

Gets information about a snapshot.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
  • Operation Id: Snapshots_Get
  • Default Api Version: 2024-03-02
  • Resource: SnapshotResource
public static Azure.Response<Azure.ResourceManager.Compute.SnapshotResource> GetSnapshot (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string snapshotName, System.Threading.CancellationToken cancellationToken = default);
static member GetSnapshot : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.SnapshotResource>
<Extension()>
Public Function GetSnapshot (resourceGroupResource As ResourceGroupResource, snapshotName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SnapshotResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

snapshotName
String

The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or snapshotName is null.

snapshotName is an empty string, and was expected to be non-empty.

Applies to