Snapshots | @azure/arm-compute

Interface representing a Snapshots.

Hierarchy

Snapshots

Implemented by

SnapshotsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, snapshotName: string, snapshot: Snapshot, options?: SnapshotsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SnapshotsCreateOrUpdateResponse>, SnapshotsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/snapshots.ts:58
Creates or updates a 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.
- Optional options: SnapshotsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SnapshotsCreateOrUpdateResponse>, SnapshotsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, snapshotName: string, snapshot: Snapshot, options?: SnapshotsCreateOrUpdateOptionalParams): Promise<SnapshotsCreateOrUpdateResponse>

- Defined in operationsInterfaces/snapshots.ts:78
Creates or updates a 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.
- Optional options: SnapshotsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/snapshots.ts:140
Deletes a 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.
- Optional options: SnapshotsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/snapshots.ts:153
Deletes a 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.
- Optional options: SnapshotsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginGrantAccess

beginGrantAccess(resourceGroupName: string, snapshotName: string, grantAccessData: GrantAccessData, options?: SnapshotsGrantAccessOptionalParams): Promise<PollerLike<PollOperationState<SnapshotsGrantAccessResponse>, SnapshotsGrantAccessResponse>>

- Defined in operationsInterfaces/snapshots.ts:167
Grants access to a 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.
- grantAccessData: GrantAccessData
  
  Access data object supplied in the body of the get snapshot access operation.
- Optional options: SnapshotsGrantAccessOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SnapshotsGrantAccessResponse>, SnapshotsGrantAccessResponse>>

beginGrantAccessAndWait

beginGrantAccessAndWait(resourceGroupName: string, snapshotName: string, grantAccessData: GrantAccessData, options?: SnapshotsGrantAccessOptionalParams): Promise<SnapshotsGrantAccessResponse>

- Defined in operationsInterfaces/snapshots.ts:187
Grants access to a 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.
- grantAccessData: GrantAccessData
  
  Access data object supplied in the body of the get snapshot access operation.
- Optional options: SnapshotsGrantAccessOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsGrantAccessResponse>

beginRevokeAccess

beginRevokeAccess(resourceGroupName: string, snapshotName: string, options?: SnapshotsRevokeAccessOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/snapshots.ts:201
Revokes access to a 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.
- Optional options: SnapshotsRevokeAccessOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRevokeAccessAndWait

beginRevokeAccessAndWait(resourceGroupName: string, snapshotName: string, options?: SnapshotsRevokeAccessOptionalParams): Promise<void>

- Defined in operationsInterfaces/snapshots.ts:214
Revokes access to a 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.
- Optional options: SnapshotsRevokeAccessOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, snapshotName: string, snapshot: SnapshotUpdate, options?: SnapshotsUpdateOptionalParams): Promise<PollerLike<PollOperationState<SnapshotsUpdateResponse>, SnapshotsUpdateResponse>>

- Defined in operationsInterfaces/snapshots.ts:93
Updates (patches) a 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.
- Optional options: SnapshotsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SnapshotsUpdateResponse>, SnapshotsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, snapshotName: string, snapshot: SnapshotUpdate, options?: SnapshotsUpdateOptionalParams): Promise<SnapshotsUpdateResponse>

- Defined in operationsInterfaces/snapshots.ts:113
Updates (patches) a 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.
- Optional options: SnapshotsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsUpdateResponse>

get

get(resourceGroupName: string, snapshotName: string, options?: SnapshotsGetOptionalParams): Promise<SnapshotsGetResponse>

- Defined in operationsInterfaces/snapshots.ts:127
Gets information about a 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.
- Optional options: SnapshotsGetOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsGetResponse>

list

list(options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<Snapshot>

- Defined in operationsInterfaces/snapshots.ts:46
Lists snapshots under a subscription.

Parameters
- Optional options: SnapshotsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Snapshot>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: SnapshotsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Snapshot>

- Defined in operationsInterfaces/snapshots.ts:38
Lists snapshots under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: SnapshotsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Snapshot>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

snapshotName: string

snapshot: Snapshot

Optional options: SnapshotsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SnapshotsCreateOrUpdateResponse>, SnapshotsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

snapshotName: string

snapshot: Snapshot

Optional options: SnapshotsCreateOrUpdateOptionalParams

Returns Promise<SnapshotsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

snapshotName: string

Optional options: SnapshotsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

snapshotName: string

Optional options: SnapshotsDeleteOptionalParams

Returns Promise<void>

beginGrantAccess

Parameters

resourceGroupName: string

snapshotName: string

grantAccessData: GrantAccessData

Optional options: SnapshotsGrantAccessOptionalParams

Returns Promise<PollerLike<PollOperationState<SnapshotsGrantAccessResponse>, SnapshotsGrantAccessResponse>>

beginGrantAccessAndWait

Parameters

resourceGroupName: string

snapshotName: string

grantAccessData: GrantAccessData

Optional options: SnapshotsGrantAccessOptionalParams

Returns Promise<SnapshotsGrantAccessResponse>

beginRevokeAccess

Parameters

resourceGroupName: string

snapshotName: string

Optional options: SnapshotsRevokeAccessOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRevokeAccessAndWait

Parameters

resourceGroupName: string

snapshotName: string

Optional options: SnapshotsRevokeAccessOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

snapshotName: string

snapshot: SnapshotUpdate

Optional options: SnapshotsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SnapshotsUpdateResponse>, SnapshotsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

snapshotName: string

snapshot: SnapshotUpdate

Optional options: SnapshotsUpdateOptionalParams

Returns Promise<SnapshotsUpdateResponse>

get

Parameters

resourceGroupName: string

snapshotName: string

Optional options: SnapshotsGetOptionalParams

Returns Promise<SnapshotsGetResponse>

list

Parameters

Optional options: SnapshotsListOptionalParams