virtual_machine_instances

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

Overview

Name	virtual_machine_instances
Type	Resource
Id	azure.system_center_vm_manager.virtual_machine_instances

Fields

The following fields are returned by SELECT queries:

list

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Gets or sets the extended location.
properties	object	The resource-specific properties for this resource.

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Gets or sets the extended location.
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceUri		Lists all of the virtual machine instances within the specified parent resource.
get	select	resourceUri		Retrieves information about a virtual machine instance.
create_or_update	insert	resourceUri, data__extendedLocation		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		The operation to update a virtual machine instance.
delete	delete	resourceUri	force, deleteFromHost	The operation to delete a virtual machine instance.
restart	exec	resourceUri		The operation to restart a virtual machine instance.
restore_checkpoint	exec	resourceUri		Restores to a checkpoint in virtual machine instance.
start	exec	resourceUri		The operation to start a virtual machine instance.
stop	exec	resourceUri		The operation to power off (stop) 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 resource.
deleteFromHost	string	Whether to disable the VM from azure and also delete it from Vmm.
force	string	Forces the resource to be deleted.

SELECT examples

list

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

SELECT
extendedLocation,
properties
FROM azure.system_center_vm_manager.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' -- required
;

get

Retrieves information about a virtual machine instance.

SELECT
extendedLocation,
properties
FROM azure.system_center_vm_manager.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' -- required
;

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.system_center_vm_manager.virtual_machine_instances (
data__properties,
data__extendedLocation,
resourceUri
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ resourceUri }}'
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: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Gets or sets the extended location.

UPDATE examples

update

The operation to update a virtual machine instance.

UPDATE azure.system_center_vm_manager.virtual_machine_instances
SET 
data__properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
RETURNING
extendedLocation,
properties;

DELETE examples

delete

The operation to delete a virtual machine instance.

DELETE FROM azure.system_center_vm_manager.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' --required
AND force = '{{ force }}'
AND deleteFromHost = '{{ deleteFromHost }}'
;

Lifecycle Methods

restart

The operation to restart a virtual machine instance.

EXEC azure.system_center_vm_manager.virtual_machine_instances.restart 
@resourceUri='{{ resourceUri }}' --required
;

restore_checkpoint

Restores to a checkpoint in virtual machine instance.

EXEC azure.system_center_vm_manager.virtual_machine_instances.restore_checkpoint 
@resourceUri='{{ resourceUri }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;

start

The operation to start a virtual machine instance.

EXEC azure.system_center_vm_manager.virtual_machine_instances.start 
@resourceUri='{{ resourceUri }}' --required
;

stop

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

EXEC azure.system_center_vm_manager.virtual_machine_instances.stop 
@resourceUri='{{ resourceUri }}' --required 
@@json=
'{
"skipShutdown": "{{ skipShutdown }}"
}'
;