ManagedClusterSnapshots interface

Package:

@azure/arm-containerservice

Interface representing a ManagedClusterSnapshots.

Methods

createOrUpdate(string, string, ManagedClusterSnapshot, ManagedClusterSnapshotsCreateOrUpdateOptionalParams)	Creates or updates a managed cluster snapshot.
delete(string, string, ManagedClusterSnapshotsDeleteOptionalParams)	Deletes a managed cluster snapshot.
get(string, string, ManagedClusterSnapshotsGetOptionalParams)	Gets a managed cluster snapshot.
list(ManagedClusterSnapshotsListOptionalParams)	Gets a list of managed cluster snapshots in the specified subscription.
listByResourceGroup(string, ManagedClusterSnapshotsListByResourceGroupOptionalParams)	Lists managed cluster snapshots in the specified subscription and resource group.
updateTags(string, string, TagsObject, ManagedClusterSnapshotsUpdateTagsOptionalParams)	Updates tags on a managed cluster snapshot.

Method Details

createOrUpdate(string, string, ManagedClusterSnapshot, ManagedClusterSnapshotsCreateOrUpdateOptionalParams)

Creates or updates a managed cluster snapshot.

function createOrUpdate(resourceGroupName: string, resourceName: string, parameters: ManagedClusterSnapshot, options?: ManagedClusterSnapshotsCreateOrUpdateOptionalParams): Promise<ManagedClusterSnapshot>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

parameters

ManagedClusterSnapshot

The managed cluster snapshot to create or update.

options

ManagedClusterSnapshotsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedClusterSnapshot>

delete(string, string, ManagedClusterSnapshotsDeleteOptionalParams)

Deletes a managed cluster snapshot.

function delete(resourceGroupName: string, resourceName: string, options?: ManagedClusterSnapshotsDeleteOptionalParams): 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

ManagedClusterSnapshotsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ManagedClusterSnapshotsGetOptionalParams)

Gets a managed cluster snapshot.

function get(resourceGroupName: string, resourceName: string, options?: ManagedClusterSnapshotsGetOptionalParams): Promise<ManagedClusterSnapshot>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the managed cluster resource.

options

ManagedClusterSnapshotsGetOptionalParams

The options parameters.

Returns

Promise<ManagedClusterSnapshot>

list(ManagedClusterSnapshotsListOptionalParams)

Gets a list of managed cluster snapshots in the specified subscription.

function list(options?: ManagedClusterSnapshotsListOptionalParams): PagedAsyncIterableIterator<ManagedClusterSnapshot, ManagedClusterSnapshot[], PageSettings>

Parameters

options

ManagedClusterSnapshotsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedClusterSnapshot, ManagedClusterSnapshot[], PageSettings>

listByResourceGroup(string, ManagedClusterSnapshotsListByResourceGroupOptionalParams)

Lists managed cluster snapshots in the specified subscription and resource group.

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

Parameters

resourceGroupName

string

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

options

ManagedClusterSnapshotsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedClusterSnapshot, ManagedClusterSnapshot[], PageSettings>

updateTags(string, string, TagsObject, ManagedClusterSnapshotsUpdateTagsOptionalParams)

Updates tags on a managed cluster snapshot.

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

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 managed cluster snapshot Tags operation.

options

ManagedClusterSnapshotsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ManagedClusterSnapshot>