Package version:

Interface AvailabilitySet

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.

interface AvailabilitySet {
    id?: string;
    location: string;
    name?: string;
    platformFaultDomainCount?: number;
    platformUpdateDomainCount?: number;
    proximityPlacementGroup?: SubResource;
    scheduledEventsPolicy?: ScheduledEventsPolicy;
    sku?: Sku;
    statuses?: InstanceViewStatus[];
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
    virtualMachines?: SubResource[];
    virtualMachineScaleSetMigrationInfo?: VirtualMachineScaleSetMigrationInfo;
}

Hierarchy (view full)

Properties

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location: string

Resource location

name?: string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

platformFaultDomainCount?: number

Fault Domain count.

platformUpdateDomainCount?: number

Update Domain count.

proximityPlacementGroup?: SubResource

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

scheduledEventsPolicy?: ScheduledEventsPolicy

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

sku?: 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?: InstanceViewStatus[]

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

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

Resource tags

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachines?: SubResource[]

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

virtualMachineScaleSetMigrationInfo?: VirtualMachineScaleSetMigrationInfo

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