Share via

Snapshot interface

  • Reference
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. NOTE: This property will not be serialized. It can only be populated by the server.
kubernetesVersion

The version of Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.
nodeImageVersion

The version of node image. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
osType

The operating system type. The default is Linux. NOTE: This property will not be serialized. It can only be populated by the server.
snapshotType

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

The size of the VM. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

enableFips?: boolean

Property Value

boolean

kubernetesVersion

The version of Kubernetes. NOTE: This property will not be serialized. It can only be populated by the server.

kubernetesVersion?: string

Property Value

string

nodeImageVersion

The version of node image. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

osSku?: string

Property Value

string

osType

The operating system type. The default is Linux. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

vmSize?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type