Snapshots interface

Package:

@azure/arm-containerservice

Interface representing a Snapshots.

Methods

createOrUpdate(string, string, Snapshot, SnapshotsCreateOrUpdateOptionalParams)	Creates or updates a snapshot.
delete(string, string, SnapshotsDeleteOptionalParams)	Deletes a snapshot.
get(string, string, SnapshotsGetOptionalParams)	Gets a snapshot.
list(SnapshotsListOptionalParams)	Gets a list of snapshots in the specified subscription.
listByResourceGroup(string, SnapshotsListByResourceGroupOptionalParams)	Lists snapshots in the specified subscription and resource group.
updateTags(string, string, TagsObject, SnapshotsUpdateTagsOptionalParams)	Updates tags on a snapshot.

Method Details

createOrUpdate(string, string, Snapshot, SnapshotsCreateOrUpdateOptionalParams)

Creates or updates a snapshot.

function createOrUpdate(resourceGroupName: string, resourceName: string, parameters: Snapshot, options?: SnapshotsCreateOrUpdateOptionalParams): Promise<Snapshot>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

parameters

Snapshot

The snapshot to create or update.

options

SnapshotsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Snapshot>

delete(string, string, SnapshotsDeleteOptionalParams)

Deletes a snapshot.

function delete(resourceGroupName: string, resourceName: string, options?: SnapshotsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

options

SnapshotsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, SnapshotsGetOptionalParams)

Gets a snapshot.

function get(resourceGroupName: string, resourceName: string, options?: SnapshotsGetOptionalParams): Promise<Snapshot>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

options

SnapshotsGetOptionalParams

The options parameters.

Returns

Promise<Snapshot>

list(SnapshotsListOptionalParams)

Gets a list of snapshots in the specified subscription.

function list(options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

options

SnapshotsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

listByResourceGroup(string, SnapshotsListByResourceGroupOptionalParams)

Lists snapshots in the specified subscription and resource group.

function listByResourceGroup(resourceGroupName: string, options?: SnapshotsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

SnapshotsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

updateTags(string, string, TagsObject, SnapshotsUpdateTagsOptionalParams)

Updates tags on a snapshot.

function updateTags(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: SnapshotsUpdateTagsOptionalParams): Promise<Snapshot>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

parameters

TagsObject

Parameters supplied to the Update snapshot Tags operation.

options

SnapshotsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<Snapshot>