guest_agents

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

Overview

Name	guest_agents
Type	Resource
Id	azure_stack.azure_stack_hci_vm.guest_agents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
credentials	object	Username / Password Credentials to provision guest agent.
provisioningAction	string	The guest agent provisioning action. Known values are: "install", "uninstall", and "repair". (install, uninstall, repair)
provisioningState	string	Provisioning state of the virtual machine instance. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	string	The guest agent status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

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

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
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Implements GuestAgent GET method.

SELECT
id,
name,
credentials,
provisioningAction,
provisioningState,
status,
systemData,
type
FROM azure_stack.azure_stack_hci_vm.guest_agents
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create

Create Or Update GuestAgent.

INSERT INTO azure_stack.azure_stack_hci_vm.guest_agents (
properties,
resource_uri
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: guest_agents
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the guest_agents resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      credentials:
        username: "{{ username }}"
        password: "{{ password }}"
      provisioningAction: "{{ provisioningAction }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Implements GuestAgent DELETE method.

DELETE FROM azure_stack.azure_stack_hci_vm.guest_agents
WHERE resource_uri = '{{ resource_uri }}' --required
;

Lifecycle Methods

list_by_virtual_machine_instance

Returns the list of GuestAgent of the given vm.

EXEC azure_stack.azure_stack_hci_vm.guest_agents.list_by_virtual_machine_instance 
@resource_uri='{{ resource_uri }}' --required
;