vm_families

Creates, updates, deletes, gets or lists a vm_families resource.

Overview

Name	vm_families
Type	Resource
Id	azure.compute_limit.vm_families

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
category	string	The category of the VM family (for example, GeneralPurpose, ComputeOptimized).
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription_location_resource

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
category	string	The category of the VM family (for example, GeneralPurpose, ComputeOptimized).
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, vm_family_name, subscription_id		Gets the properties of a VM family.
list_by_subscription_location_resource	select	location, subscription_id	$filter	Lists all VM families for the subscription at the specified location.

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
location	string	The name of the Azure region. Required.
subscription_id	string
vm_family_name	string	The name of the VmFamily. Required.
$filter	string	The filter to apply to the list operation. Filter can be applied to the 'category' property. Example: $filter=category eq 'generalPurposeCategory'. Default value is None.

SELECT examples

get

Gets the properties of a VM family.

SELECT
id,
name,
category,
provisioningState,
systemData,
type
FROM azure.compute_limit.vm_families
WHERE location = '{{ location }}' -- required
AND vm_family_name = '{{ vm_family_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_location_resource

Lists all VM families for the subscription at the specified location.

SELECT
id,
name,
category,
provisioningState,
systemData,
type
FROM azure.compute_limit.vm_families
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;