Snapshots | @azure/arm-containerservice

Interface representing a Snapshots.

Hierarchy

Snapshots

Implemented by

SnapshotsImpl

Index

Methods

createOrUpdate

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

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

delete

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

- Defined in operationsInterfaces/snapshots.ts:86
Deletes a snapshot.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: SnapshotsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/snapshots.ts:49
Gets a snapshot.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: SnapshotsGetOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsGetResponse>

list

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

- Defined in operationsInterfaces/snapshots.ts:31
Gets a list of snapshots in the specified subscription.

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

listByResourceGroup

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

- Defined in operationsInterfaces/snapshots.ts:39
Lists snapshots in the specified subscription and resource group.

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

updateTags

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

- Defined in operationsInterfaces/snapshots.ts:74
Updates tags on a 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.
- Optional options: SnapshotsUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<SnapshotsUpdateTagsResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: Snapshot

Optional options: SnapshotsCreateOrUpdateOptionalParams

Returns Promise<SnapshotsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

resourceName: string

Optional options: SnapshotsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

resourceName: string

Optional options: SnapshotsGetOptionalParams

Returns Promise<SnapshotsGetResponse>

list

Parameters

Optional options: SnapshotsListOptionalParams

Returns PagedAsyncIterableIterator<Snapshot>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: SnapshotsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Snapshot>

updateTags

Parameters

resourceGroupName: string

resourceName: string

parameters: TagsObject

Optional options: SnapshotsUpdateTagsOptionalParams

Returns Promise<SnapshotsUpdateTagsResponse>