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
- vw_virtual_machine_instances
- virtual_machine_instances
| Name | Datatype | Description |
|---|---|---|
extended_location | text | field from the properties object |
guest_agent_install_status | text | field from the properties object |
hardware_profile | text | field from the properties object |
http_proxy_config | text | field from the properties object |
identity | text | Identity for the resource. |
instance_view | text | field from the properties object |
network_profile | text | field from the properties object |
os_profile | text | field from the properties object |
provisioning_state | text | field from the properties object |
resourceUri | text | field from the properties object |
resource_uid | text | field from the properties object |
security_profile | text | field from the properties object |
status | text | field from the properties object |
storage_profile | text | field from the properties object |
vm_id | text | field from the properties object |
| Name | Datatype | Description |
|---|---|---|
extendedLocation | object | The complex type of the extended location. |
identity | object | Identity for the resource. |
properties | object | Properties under the virtual machine instance resource |
Methods
| Name | Accessible by | Required 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. |
delete | DELETE | resourceUri | The operation to delete a virtual machine instance. |
update | UPDATE | resourceUri | The operation to update a virtual machine instance. |
restart | EXEC | resourceUri | The operation to restart 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. |
SELECT examples
Gets a virtual machine instance
- vw_virtual_machine_instances
- virtual_machine_instances
SELECT
extended_location,
guest_agent_install_status,
hardware_profile,
http_proxy_config,
identity,
instance_view,
network_profile,
os_profile,
provisioning_state,
resourceUri,
resource_uid,
security_profile,
status,
storage_profile,
vm_id
FROM azure_stack.azure_stack_hci.vw_virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}';
SELECT
extendedLocation,
identity,
properties
FROM azure_stack.azure_stack_hci.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}';
INSERT example
Use the following StackQL query and manifest file to create a new virtual_machine_instances resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_stack.azure_stack_hci.virtual_machine_instances (
resourceUri,
properties,
extendedLocation,
identity
)
SELECT
'{{ resourceUri }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ identity }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: hardwareProfile
value:
- name: vmSize
value: string
- name: processors
value: integer
- name: memoryMB
value: integer
- name: dynamicMemoryConfig
value:
- name: maximumMemoryMB
value: integer
- name: minimumMemoryMB
value: integer
- name: targetMemoryBuffer
value: integer
- name: networkProfile
value:
- name: networkInterfaces
value:
- - name: id
value: string
- name: osProfile
value:
- name: adminPassword
value: string
- name: adminUsername
value: string
- name: computerName
value: string
- name: linuxConfiguration
value:
- name: disablePasswordAuthentication
value: boolean
- name: ssh
value:
- name: publicKeys
value:
- - name: path
value: string
- name: keyData
value: string
- name: provisionVMAgent
value: boolean
- name: provisionVMConfigAgent
value: boolean
- name: windowsConfiguration
value:
- name: enableAutomaticUpdates
value: boolean
- name: timeZone
value: string
- name: provisionVMAgent
value: boolean
- name: provisionVMConfigAgent
value: boolean
- name: securityProfile
value:
- name: enableTPM
value: boolean
- name: uefiSettings
value:
- name: secureBootEnabled
value: boolean
- name: securityType
value: string
- name: storageProfile
value:
- name: dataDisks
value:
- - name: id
value: string
- name: imageReference
value:
- name: id
value: string
- name: osDisk
value:
- name: id
value: string
- name: osType
value: string
- name: vmConfigStoragePathId
value: string
- name: httpProxyConfig
value:
- name: httpProxy
value: string
- name: httpsProxy
value: string
- name: noProxy
value:
- string
- name: trustedCa
value: string
- name: provisioningState
value: string
- name: instanceView
value:
- name: vmAgent
value:
- name: vmConfigAgentVersion
value: string
- name: statuses
value:
- - name: code
value: string
- name: level
value: string
- name: displayStatus
value: string
- name: message
value: string
- name: time
value: string
- name: status
value:
- name: errorCode
value: string
- name: errorMessage
value: string
- name: powerState
value: string
- name: provisioningStatus
value:
- name: operationId
value: string
- name: status
value: string
- name: guestAgentInstallStatus
value:
- name: vmUuid
value: string
- name: status
value: string
- name: lastStatusChange
value: string
- name: agentVersion
value: string
- name: errorDetails
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- []
- name: additionalInfo
value:
- []
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: vmId
value: string
- name: resourceUid
value: string
- name: extendedLocation
value:
- name: name
value: string
- name: type
value: []
- name: identity
value:
- name: principalId
value: string
- name: tenantId
value: string
- name: type
value: string
UPDATE example
Updates a virtual_machine_instances resource.
/*+ update */
UPDATE azure_stack.azure_stack_hci.virtual_machine_instances
SET
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE
resourceUri = '{{ resourceUri }}';
DELETE example
Deletes the specified virtual_machine_instances resource.
/*+ delete */
DELETE FROM azure_stack.azure_stack_hci.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}';