virtual_machine_instances

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

Overview

Name	virtual_machine_instances
Type	Resource
Id	azure_stack.azure_stack_hci.virtual_machine_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
identity	object	Identity for the resource.
properties	object	Properties under the virtual machine instance resource

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
identity	object	Identity for the resource.
properties	object	Properties under the virtual machine instance resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri		Gets a virtual machine instance
list	select	resourceUri		Lists all of the virtual machine instances within the specified parent resource.
create_or_update	insert	resourceUri		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		The operation to delete a virtual machine instance.
start	exec	resourceUri		The operation to start a virtual machine instance.
stop	exec	resourceUri		The operation to stop a virtual machine instance.
restart	exec	resourceUri		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.

SELECT examples

get

Gets a virtual machine instance

SELECT
extendedLocation,
identity,
properties
FROM azure_stack.azure_stack_hci.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' -- required
;

list

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

SELECT
extendedLocation,
identity,
properties
FROM azure_stack.azure_stack_hci.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_stack.azure_stack_hci.virtual_machine_instances (
data__properties,
data__extendedLocation,
data__identity,
resourceUri
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ resourceUri }}'
RETURNING
extendedLocation,
identity,
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: |
        Properties under the virtual machine instance resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: identity
      value: object
      description: |
        Identity for the resource.

UPDATE examples

update

The operation to update a virtual machine instance.

UPDATE azure_stack.azure_stack_hci.virtual_machine_instances
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
RETURNING
extendedLocation,
identity,
properties;

DELETE examples

delete

The operation to delete a virtual machine instance.

DELETE FROM azure_stack.azure_stack_hci.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}' --required
;

Lifecycle Methods

start

The operation to start a virtual machine instance.

EXEC azure_stack.azure_stack_hci.virtual_machine_instances.start 
@resourceUri='{{ resourceUri }}' --required
;

stop

The operation to stop a virtual machine instance.

EXEC azure_stack.azure_stack_hci.virtual_machine_instances.stop 
@resourceUri='{{ resourceUri }}' --required
;

restart

The operation to restart a virtual machine instance.

EXEC azure_stack.azure_stack_hci.virtual_machine_instances.restart 
@resourceUri='{{ resourceUri }}' --required
;