Share via

Snapshot interface

Package:
@azure/arm-containerservice

A node pool snapshot resource.

Extends
TrackedResource

Properties

creationData

CreationData to be used to specify the source agent pool resource ID to create this snapshot.
enableFips

Whether to use a FIPS-enabled OS.
kubernetesVersion

The version of Kubernetes.
nodeImageVersion

The version of node image.
osSku

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
osType

The operating system type. The default is Linux.
snapshotType

The type of a snapshot. The default is NodePool.
vmSize

The size of the VM.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

creationData

CreationData to be used to specify the source agent pool resource ID to create this snapshot.

creationData?: CreationData

Property Value

CreationData

enableFips

Whether to use a FIPS-enabled OS.

enableFips?: boolean

Property Value

boolean

kubernetesVersion

The version of Kubernetes.

kubernetesVersion?: string

Property Value

string

nodeImageVersion

The version of node image.

nodeImageVersion?: string

Property Value

string

osSku

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

osSku?: string

Property Value

string

osType

The operating system type. The default is Linux.

osType?: string

Property Value

string

snapshotType

The type of a snapshot. The default is NodePool.

snapshotType?: string

Property Value

string

vmSize

The size of the VM.

vmSize?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type