guest_agents

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

Overview

Name	guest_agents
Type	Resource
Id	azure_stack.azure_stack_hci.guest_agents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	The system data.

list

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	The system data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri		Implements GuestAgent GET method.
list	select	resourceUri		Returns the list of GuestAgent of the given vm.
create	insert	resourceUri, data__properties		Create Or Update GuestAgent.
delete	delete	resourceUri		Implements GuestAgent DELETE method.

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

Implements GuestAgent GET method.

SELECT
properties,
systemData
FROM azure_stack.azure_stack_hci.guest_agents
WHERE resourceUri = '{{ resourceUri }}' -- required
;

list

Returns the list of GuestAgent of the given vm.

SELECT
properties,
systemData
FROM azure_stack.azure_stack_hci.guest_agents
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create

Create Or Update GuestAgent.

INSERT INTO azure_stack.azure_stack_hci.guest_agents (
data__properties,
resourceUri
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceUri }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: guest_agents
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the guest_agents resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Implements GuestAgent DELETE method.

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