Share via

AvailabilitySet interface

Package:
@azure/arm-compute

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set.

Extends
TrackedResource

Properties

platformFaultDomainCount

Fault Domain count.
platformUpdateDomainCount

Update Domain count.
proximityPlacementGroup

Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
scheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
sku

Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
statuses

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachines

A list of references to all virtual machines in the availability set.
virtualMachineScaleSetMigrationInfo

Describes the migration properties on the Availability Set. 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. Ex - /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

platformFaultDomainCount

Fault Domain count.

platformFaultDomainCount?: number

Property Value

number

platformUpdateDomainCount

Update Domain count.

platformUpdateDomainCount?: number

Property Value

number

proximityPlacementGroup

Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.

proximityPlacementGroup?: SubResource

Property Value

SubResource

scheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.

scheduledEventsPolicy?: ScheduledEventsPolicy

Property Value

ScheduledEventsPolicy

sku

Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.

sku?: Sku

Property Value

Sku

statuses

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

statuses?: InstanceViewStatus[]

Property Value

InstanceViewStatus[]

virtualMachines

A list of references to all virtual machines in the availability set.

virtualMachines?: SubResource[]

Property Value

SubResource[]

virtualMachineScaleSetMigrationInfo

Describes the migration properties on the Availability Set. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachineScaleSetMigrationInfo?: VirtualMachineScaleSetMigrationInfo

Property Value

VirtualMachineScaleSetMigrationInfo

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /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