virtual_machines

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

Overview

Name	virtual_machines
Type	Resource
Id	azure_isv.vmware_cloud_simple.virtual_machines

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
name	string	{virtualMachineName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Virtual machine properties
tags	object	The list of tags
type	string	{resourceProviderNamespace}/{resourceType}

list_by_resource_group

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
name	string	{virtualMachineName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Virtual machine properties
tags	object	The list of tags
type	string	{resourceProviderNamespace}/{resourceType}

list_by_subscription

successful operation

Name	Datatype	Description
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
name	string	{virtualMachineName} (pattern: ^a-zA-Z0-9?$)
location	string	Azure region
properties	object	Virtual machine properties
tags	object	The list of tags
type	string	{resourceProviderNamespace}/{resourceType}

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualMachineName	api-version	Get virtual machine
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $filter, $top, $skipToken	Returns list of virtual machine within resource group
list_by_subscription	select	subscriptionId	api-version, $filter, $top, $skipToken	Returns list virtual machine within subscription
create_or_update	insert	subscriptionId, resourceGroupName, Referer, virtualMachineName, data__location	api-version	Create Or Update Virtual Machine
update	update	subscriptionId, resourceGroupName, virtualMachineName	api-version	Patch virtual machine properties
delete	delete	subscriptionId, resourceGroupName, Referer, virtualMachineName	api-version	Delete virtual machine
start	exec	subscriptionId, resourceGroupName, Referer, virtualMachineName	api-version	Power on virtual machine
stop	exec	subscriptionId, resourceGroupName, Referer, virtualMachineName	mode, api-version	Power off virtual machine, options: shutdown, poweroff, and suspend

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
Referer	string	referer url
resourceGroupName	string	The name of the resource group
subscriptionId	string	The subscription ID.
virtualMachineName	string	virtual machine name
$filter	string	The filter to apply on the list operation
$skipToken	string	to be used by nextLink implementation
$top	integer (int32)	The maximum number of record sets to return
api-version	string	Client API version.
mode	string	query stop mode parameter (reboot, shutdown, etc...)

SELECT examples

get

Get virtual machine

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_isv.vmware_cloud_simple.virtual_machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineName = '{{ virtualMachineName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Returns list of virtual machine within resource group

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_isv.vmware_cloud_simple.virtual_machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Returns list virtual machine within subscription

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_isv.vmware_cloud_simple.virtual_machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create Or Update Virtual Machine

INSERT INTO azure_isv.vmware_cloud_simple.virtual_machines (
data__location,
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
Referer,
virtualMachineName,
api-version
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ Referer }}',
'{{ virtualMachineName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machines
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the virtual_machines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_machines resource.
    - name: Referer
      value: string
      description: Required parameter for the virtual_machines resource.
    - name: virtualMachineName
      value: string
      description: Required parameter for the virtual_machines resource.
    - name: location
      value: string
      description: |
        Azure region
    - name: properties
      value: object
      description: |
        Virtual machine properties
    - name: tags
      value: object
      description: |
        The list of tags
    - name: api-version
      value: string
      description: Client API version.

UPDATE examples

update

Patch virtual machine properties

UPDATE azure_isv.vmware_cloud_simple.virtual_machines
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualMachineName = '{{ virtualMachineName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete virtual machine

DELETE FROM azure_isv.vmware_cloud_simple.virtual_machines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND Referer = '{{ Referer }}' --required
AND virtualMachineName = '{{ virtualMachineName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

start

Power on virtual machine

EXEC azure_isv.vmware_cloud_simple.virtual_machines.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@Referer='{{ Referer }}' --required, 
@virtualMachineName='{{ virtualMachineName }}' --required, 
@api-version='{{ api-version }}'
;

stop

Power off virtual machine, options: shutdown, poweroff, and suspend

EXEC azure_isv.vmware_cloud_simple.virtual_machines.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@Referer='{{ Referer }}' --required, 
@virtualMachineName='{{ virtualMachineName }}' --required, 
@mode='{{ mode }}', 
@api-version='{{ api-version }}' 
@@json=
'{
"mode": "{{ mode }}"
}'
;