Share via


SnapshotProperties interface

Properties used to configure a node pool snapshot.

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.

Property Details

creationData

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

creationData?: CreationData

Property Value

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