virtual_machine_instances

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

Overview

Name	virtual_machine_instances
Type	Resource
Id	azure_isv.connected_vsphere.virtual_machine_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	Gets or sets the extended location.
properties	object	Resource properties.

list

Name	Datatype	Description
extendedLocation	object	Gets or sets the extended location.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri	api-version	Retrieves information about a virtual machine instance.
list	select	resourceUri	api-version	Lists all of the virtual machine instances within the specified parent resource.
create_or_update	insert	resourceUri, data__properties	api-version	The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
update	update	resourceUri	api-version	The operation to update a virtual machine instance.
delete	delete	resourceUri	api-version, deleteFromHost, force	The operation to delete a virtual machine instance.
stop	exec	resourceUri	api-version	The operation to power off (stop) a virtual machine instance.
start	exec	resourceUri	api-version	The operation to start a virtual machine instance.
restart	exec	resourceUri	api-version	The operation to restart a virtual machine instance.

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
resourceUri	string	The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
api-version	string	Client Api Version.
deleteFromHost	boolean	Whether to delete the VM from the vCenter.
force	boolean	Whether force delete was specified.

SELECT examples

get

Retrieves information about a virtual machine instance.

SELECT
extendedLocation,
properties
FROM azure_isv.connected_vsphere.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists all of the virtual machine instances within the specified parent resource.

SELECT
extendedLocation,
properties
FROM azure_isv.connected_vsphere.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.

INSERT INTO azure_isv.connected_vsphere.virtual_machine_instances (
data__properties,
data__extendedLocation,
resourceUri,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ extendedLocation }}',
'{{ resourceUri }}',
'{{ api-version }}'
RETURNING
extendedLocation,
properties
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machine_instances
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the virtual_machine_instances resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: extendedLocation
      value: object
      description: |
        Gets or sets the extended location.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

The operation to update a virtual machine instance.

UPDATE azure_isv.connected_vsphere.virtual_machine_instances
SET 
data__properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
AND api-version = '{{ api-version}}'
RETURNING
extendedLocation,
properties;

DELETE examples

delete

The operation to delete a virtual machine instance.

DELETE FROM azure_isv.connected_vsphere.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' --required
AND api-version = '{{ api-version }}'
AND deleteFromHost = '{{ deleteFromHost }}'
AND force = '{{ force }}'
;

Lifecycle Methods

stop

The operation to power off (stop) a virtual machine instance.

EXEC azure_isv.connected_vsphere.virtual_machine_instances.stop 
@resourceUri='{{ resourceUri }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"skipShutdown": {{ skipShutdown }}
}'
;

start

The operation to start a virtual machine instance.

EXEC azure_isv.connected_vsphere.virtual_machine_instances.start 
@resourceUri='{{ resourceUri }}' --required, 
@api-version='{{ api-version }}'
;

restart

The operation to restart a virtual machine instance.

EXEC azure_isv.connected_vsphere.virtual_machine_instances.restart 
@resourceUri='{{ resourceUri }}' --required, 
@api-version='{{ api-version }}'
;