availability_sets

Creates, updates, deletes, gets or lists an availability_sets resource.

Overview

Name	availability_sets
Type	Resource
Id	azure.compute.availability_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The instance view of a resource.
sku	object	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'.
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The instance view of a resource.
sku	object	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'.
tags	object	Resource tags
type	string	Resource type

list_by_subscription

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The instance view of a resource.
sku	object	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'.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, availabilitySetName, subscriptionId		Retrieves information about an availability set.
list	select	resourceGroupName, subscriptionId		Lists all availability sets in a resource group.
list_by_subscription	select	subscriptionId	$expand	Lists all availability sets in a subscription.
create_or_update	insert	resourceGroupName, availabilitySetName, subscriptionId		Create or update an availability set.
update	update	resourceGroupName, availabilitySetName, subscriptionId		Update an availability set.
delete	delete	resourceGroupName, availabilitySetName, subscriptionId		Delete an availability set.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
availabilitySetName	string	The name of the availability set.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply to the operation. Allowed values are 'instanceView'.

SELECT examples

get

Retrieves information about an availability set.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.availability_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND availabilitySetName = '{{ availabilitySetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all availability sets in a resource group.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.availability_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all availability sets in a subscription.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.availability_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Create or update an availability set.

INSERT INTO azure.compute.availability_sets (
data__properties,
data__sku,
data__location,
data__tags,
resourceGroupName,
availabilitySetName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ availabilitySetName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: availability_sets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the availability_sets resource.
    - name: availabilitySetName
      value: string
      description: Required parameter for the availability_sets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the availability_sets resource.
    - name: properties
      value: object
      description: |
        The instance view of a resource.
    - name: sku
      value: object
      description: |
        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'.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update an availability set.

UPDATE azure.compute.availability_sets
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND availabilitySetName = '{{ availabilitySetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete an availability set.

DELETE FROM azure.compute.availability_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND availabilitySetName = '{{ availabilitySetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;