azure_availability_set.md

Document: "compute"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json")

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 Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

azure_availability_set {
  api_version => "api_version",
  location => "location (optional)",
  parameters => "parameters",
  properties => $azure_availability_set_properties
  resource_group_name => "resource_group_name",
  sku => $azure_sku
  subscription_id => "subscription_id",
  tags => "tags (optional)",
}

Name	Type	Required	Description
api_version	String	true	Client Api Version.
location	String	false	Resource location
parameters	Hash	true	Parameters supplied to the Create Availability Set operation.
properties	AvailabilitySetProperties	false
resource_group_name	String	true	The name of the resource group.
sku	Sku	false	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'.
subscription_id	String	true	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
tags	Hash	false	Resource tags

AvailabilitySetProperties

The instance view of a resource.

$azure_availability_set_properties = {
  platformFaultDomainCount => "1234 (optional)",
  platformUpdateDomainCount => "1234 (optional)",
  proximityPlacementGroup => $azure_sub_resource
  statuses => $azure_instance_view_status
  virtualMachines => $azure_sub_resource
}

Name	Type	Required	Description
platformFaultDomainCount	Integer	false	Fault Domain count.
platformUpdateDomainCount	Integer	false	Update Domain count.
proximityPlacementGroup	SubResource	false	Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
statuses	InstanceViewStatus	false	The resource status information.
virtualMachines	SubResource	false	A list of references to all virtual machines in the availability set.

SubResource

$azure_sub_resource = {
  id => "id (optional)",
}

Name	Type	Required	Description
id	String	false	Resource Id

InstanceViewStatus

Instance view status.

$azure_instance_view_status = {
  code => "code (optional)",
  displayStatus => "displayStatus (optional)",
  level => "level (optional)",
  message => "message (optional)",
  time => "time (optional)",
}

Name	Type	Required	Description
code	String	false	The status code.
displayStatus	String	false	The short localizable label for the status.
level	String	false	The level code.
message	String	false	The detailed status message, including for alerts and error messages.
time	String	false	The time of the status.

Sku

Describes a virtual machine scale set sku.

$azure_sku = {
  capacity => "1234 (optional)",
  name => "name (optional)",
  tier => "tier (optional)",
}

Name	Type	Required	Description
capacity	Integer	false	Specifies the number of virtual machines in the scale set.
name	String	false	The sku name.
tier	String	false	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the AvailabilitySet

Operation	Path	Verb	Description	OperationID
Create	/subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Compute/availabilitySets/%{availability_set_name}	Put	Create or update an availability set.	AvailabilitySets_CreateOrUpdate
List - list all	/subscriptions/%{subscription_id}/providers/Microsoft.Compute/availabilitySets	Get	Lists all availability sets in a subscription.	AvailabilitySets_ListBySubscription
List - get one	/subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Compute/availabilitySets/%{availability_set_name}	Get	Retrieves information about an availability set.	AvailabilitySets_Get
List - get list using params	/subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Compute/availabilitySets	Get	Lists all availability sets in a resource group.	AvailabilitySets_List
Update	/subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Compute/availabilitySets/%{availability_set_name}	Put	Create or update an availability set.	AvailabilitySets_CreateOrUpdate
Delete	/subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Compute/availabilitySets/%{availability_set_name}	Delete	Delete an availability set.	AvailabilitySets_Delete