Snapshots interface
Interface representing a Snapshots.
Methods
Method Details
beginCreateOrUpdate(string, string, Snapshot, SnapshotsCreateOrUpdateOptionalParams)
Creates or updates a snapshot.
function beginCreateOrUpdate(resourceGroupName: string, snapshotName: string, snapshot: Snapshot, options?: SnapshotsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- snapshot
- Snapshot
Snapshot object supplied in the body of the Put disk operation.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>
beginCreateOrUpdateAndWait(string, string, Snapshot, SnapshotsCreateOrUpdateOptionalParams)
Creates or updates a snapshot.
function beginCreateOrUpdateAndWait(resourceGroupName: string, snapshotName: string, snapshot: Snapshot, options?: SnapshotsCreateOrUpdateOptionalParams): Promise<Snapshot>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- snapshot
- Snapshot
Snapshot object supplied in the body of the Put disk operation.
The options parameters.
Returns
Promise<Snapshot>
beginDelete(string, string, SnapshotsDeleteOptionalParams)
Deletes a snapshot.
function beginDelete(resourceGroupName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- options
- SnapshotsDeleteOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, SnapshotsDeleteOptionalParams)
Deletes a snapshot.
function beginDeleteAndWait(resourceGroupName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- options
- SnapshotsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginGrantAccess(string, string, GrantAccessData, SnapshotsGrantAccessOptionalParams)
Grants access to a snapshot.
function beginGrantAccess(resourceGroupName: string, snapshotName: string, grantAccessData: GrantAccessData, options?: SnapshotsGrantAccessOptionalParams): Promise<SimplePollerLike<OperationState<AccessUri>, AccessUri>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- grantAccessData
- GrantAccessData
Access data object supplied in the body of the get snapshot access operation.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<AccessUri>, AccessUri>>
beginGrantAccessAndWait(string, string, GrantAccessData, SnapshotsGrantAccessOptionalParams)
Grants access to a snapshot.
function beginGrantAccessAndWait(resourceGroupName: string, snapshotName: string, grantAccessData: GrantAccessData, options?: SnapshotsGrantAccessOptionalParams): Promise<AccessUri>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- grantAccessData
- GrantAccessData
Access data object supplied in the body of the get snapshot access operation.
The options parameters.
Returns
Promise<AccessUri>
beginRevokeAccess(string, string, SnapshotsRevokeAccessOptionalParams)
Revokes access to a snapshot.
function beginRevokeAccess(resourceGroupName: string, snapshotName: string, options?: SnapshotsRevokeAccessOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginRevokeAccessAndWait(string, string, SnapshotsRevokeAccessOptionalParams)
Revokes access to a snapshot.
function beginRevokeAccessAndWait(resourceGroupName: string, snapshotName: string, options?: SnapshotsRevokeAccessOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, SnapshotUpdate, SnapshotsUpdateOptionalParams)
Updates (patches) a snapshot.
function beginUpdate(resourceGroupName: string, snapshotName: string, snapshot: SnapshotUpdate, options?: SnapshotsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- snapshot
- SnapshotUpdate
Snapshot object supplied in the body of the Patch snapshot operation.
- options
- SnapshotsUpdateOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>
beginUpdateAndWait(string, string, SnapshotUpdate, SnapshotsUpdateOptionalParams)
Updates (patches) a snapshot.
function beginUpdateAndWait(resourceGroupName: string, snapshotName: string, snapshot: SnapshotUpdate, options?: SnapshotsUpdateOptionalParams): Promise<Snapshot>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- snapshot
- SnapshotUpdate
Snapshot object supplied in the body of the Patch snapshot operation.
- options
- SnapshotsUpdateOptionalParams
The options parameters.
Returns
Promise<Snapshot>
get(string, string, SnapshotsGetOptionalParams)
Gets information about a snapshot.
function get(resourceGroupName: string, snapshotName: string, options?: SnapshotsGetOptionalParams): Promise<Snapshot>Parameters
- resourceGroupName
-
string
The name of the resource group.
- 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.
- options
- SnapshotsGetOptionalParams
The options parameters.
Returns
Promise<Snapshot>
list(SnapshotsListOptionalParams)
Lists snapshots under a subscription.
function list(options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>Parameters
- options
- SnapshotsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, SnapshotsListByResourceGroupOptionalParams)
Lists snapshots under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: SnapshotsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.