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

vw_virtual_machine_instances

Name	Datatype	Description
extended_location	text	field from the properties object
hardware_profile	text	field from the properties object
infrastructure_profile	text	field from the properties object
network_profile	text	field from the properties object
os_profile	text	field from the properties object
placement_profile	text	field from the properties object
power_state	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
statuses	text	field from the properties object
storage_profile	text	field from the properties object

virtual_machine_instances

Name	Datatype	Description
extendedLocation	object	The extended location.
properties	object	Describes the properties of a Virtual Machine Instance.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceUri	Retrieves information about a virtual machine instance.
list	SELECT	resourceUri	Lists all of the virtual machine instances within the specified parent resource.
create_or_update	INSERT	resourceUri, data__properties	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 power off (stop) a virtual machine instance.

SELECT examples

Retrieves information about a virtual machine instance.

vw_virtual_machine_instances

SELECT
extended_location,
hardware_profile,
infrastructure_profile,
network_profile,
os_profile,
placement_profile,
power_state,
provisioning_state,
resourceUri,
resource_uid,
security_profile,
statuses,
storage_profile
FROM azure_isv.connected_vsphere.vw_virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}';

virtual_machine_instances

SELECT
extendedLocation,
properties
FROM azure_isv.connected_vsphere.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

/*+ create */
INSERT INTO azure_isv.connected_vsphere.virtual_machine_instances (
resourceUri,
data__properties,
properties,
extendedLocation
)
SELECT 
'{{ resourceUri }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ extendedLocation }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: placementProfile
          value:
            - name: resourcePoolId
              value: string
            - name: clusterId
              value: string
            - name: hostId
              value: string
            - name: datastoreId
              value: string
        - name: osProfile
          value:
            - name: computerName
              value: string
            - name: adminUsername
              value: string
            - name: adminPassword
              value: string
            - name: guestId
              value: string
            - name: osType
              value: []
            - name: osSku
              value: string
            - name: toolsRunningStatus
              value: string
            - name: toolsVersionStatus
              value: string
            - name: toolsVersion
              value: string
            - name: windowsConfiguration
              value:
                - name: fullName
                  value: string
                - name: orgName
                  value: string
                - name: domainName
                  value: string
                - name: domainUsername
                  value: string
                - name: domainUserPassword
                  value: string
                - name: workGroupName
                  value: string
                - name: productId
                  value: string
                - name: autoLogon
                  value: boolean
                - name: autoLogonCount
                  value: integer
                - name: timeZone
                  value: string
                - name: firstLogonCommands
                  value:
                    - string
        - name: hardwareProfile
          value:
            - name: memorySizeMB
              value: integer
            - name: numCPUs
              value: integer
            - name: numCoresPerSocket
              value: integer
            - name: cpuHotAddEnabled
              value: boolean
            - name: cpuHotRemoveEnabled
              value: boolean
            - name: memoryHotAddEnabled
              value: boolean
        - name: networkProfile
          value:
            - name: networkInterfaces
              value:
                - - name: name
                    value: string
                  - name: label
                    value: string
                  - name: ipAddresses
                    value:
                      - string
                  - name: macAddress
                    value: string
                  - name: networkId
                    value: string
                  - name: nicType
                    value: []
                  - name: powerOnBoot
                    value: []
                  - name: networkMoRefId
                    value: string
                  - name: networkMoName
                    value: string
                  - name: deviceKey
                    value: integer
                  - name: ipSettings
                    value:
                      - name: allocationMethod
                        value: []
                      - name: dnsServers
                        value:
                          - string
                      - name: gateway
                        value:
                          - string
                      - name: ipAddress
                        value: string
                      - name: subnetMask
                        value: string
                      - name: primaryWinsServer
                        value: string
                      - name: secondaryWinsServer
                        value: string
                      - name: ipAddressInfo
                        value:
                          - - name: allocationMethod
                              value: string
                            - name: ipAddress
                              value: string
                            - name: subnetMask
                              value: string
        - name: storageProfile
          value:
            - name: disks
              value:
                - - name: name
                    value: string
                  - name: label
                    value: string
                  - name: diskObjectId
                    value: string
                  - name: diskSizeGB
                    value: integer
                  - name: deviceKey
                    value: integer
                  - name: diskMode
                    value: []
                  - name: controllerKey
                    value: integer
                  - name: unitNumber
                    value: integer
                  - name: deviceName
                    value: string
                  - name: diskType
                    value: []
            - name: scsiControllers
              value:
                - - name: type
                    value: []
                  - name: controllerKey
                    value: integer
                  - name: busNumber
                    value: integer
                  - name: scsiCtlrUnitNumber
                    value: integer
                  - name: sharing
                    value: []
        - name: securityProfile
          value:
            - name: uefiSettings
              value:
                - name: secureBootEnabled
                  value: boolean
        - name: infrastructureProfile
          value:
            - name: templateId
              value: string
            - name: vCenterId
              value: string
            - name: moRefId
              value: string
            - name: inventoryItemId
              value: string
            - name: moName
              value: string
            - name: folderPath
              value: string
            - name: instanceUuid
              value: string
            - name: smbiosUuid
              value: string
            - name: firmwareType
              value: []
            - name: customResourceName
              value: string
        - name: powerState
          value: string
        - name: statuses
          value:
            - - name: type
                value: string
              - name: status
                value: string
              - name: reason
                value: string
              - name: message
                value: string
              - name: severity
                value: string
              - name: lastUpdatedAt
                value: string
        - name: provisioningState
          value: []
        - name: resourceUid
          value: string
    - name: extendedLocation
      value:
        - name: type
          value: string
        - name: name
          value: string

UPDATE example

Updates a virtual_machine_instances resource.

/*+ update */
UPDATE azure_isv.connected_vsphere.virtual_machine_instances
SET 
properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}';

DELETE example

Deletes the specified virtual_machine_instances resource.

/*+ delete */
DELETE FROM azure_isv.connected_vsphere.virtual_machine_instances
WHERE resourceUri = '{{ resourceUri }}';