agents

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

Overview

Name	agents
Type	Resource
Id	azure.storage_mover.agents

Fields

vw_agents

Name	Datatype	Description
description	text	field from the properties object
agentName	text	field from the properties object
agent_status	text	field from the properties object
agent_version	text	field from the properties object
arc_resource_id	text	field from the properties object
arc_vm_uuid	text	field from the properties object
error_details	text	field from the properties object
last_status_update	text	field from the properties object
local_ip_address	text	field from the properties object
memory_in_mb	text	field from the properties object
number_of_cores	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
storageMoverName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
time_zone	text	field from the properties object
upload_limit_schedule	text	field from the properties object
uptime_in_seconds	text	field from the properties object

agents

Name	Datatype	Description
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	agentName, resourceGroupName, storageMoverName, subscriptionId	Gets an Agent resource.
list	SELECT	resourceGroupName, storageMoverName, subscriptionId	Lists all Agents in a Storage Mover.
create_or_update	INSERT	agentName, resourceGroupName, storageMoverName, subscriptionId, data__properties	Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.
delete	DELETE	agentName, resourceGroupName, storageMoverName, subscriptionId	Deletes an Agent resource.
update	UPDATE	agentName, resourceGroupName, storageMoverName, subscriptionId	Creates or updates an Agent resource.

SELECT examples

Lists all Agents in a Storage Mover.

vw_agents

SELECT
description,
agentName,
agent_status,
agent_version,
arc_resource_id,
arc_vm_uuid,
error_details,
last_status_update,
local_ip_address,
memory_in_mb,
number_of_cores,
provisioning_state,
resourceGroupName,
storageMoverName,
subscriptionId,
system_data,
time_zone,
upload_limit_schedule,
uptime_in_seconds
FROM azure.storage_mover.vw_agents
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND storageMoverName = '{{ storageMoverName }}'
AND subscriptionId = '{{ subscriptionId }}';

agents

SELECT
properties,
systemData
FROM azure.storage_mover.agents
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND storageMoverName = '{{ storageMoverName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new agents resource.

All Properties

/*+ create */
INSERT INTO azure.storage_mover.agents (
agentName,
resourceGroupName,
storageMoverName,
subscriptionId,
data__properties,
properties,
systemData
)
SELECT 
'{{ agentName }}',
'{{ resourceGroupName }}',
'{{ storageMoverName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ systemData }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: agentVersion
          value: string
        - name: arcResourceId
          value: string
        - name: arcVmUuid
          value: string
        - name: agentStatus
          value: string
        - name: lastStatusUpdate
          value: string
        - name: localIPAddress
          value: string
        - name: memoryInMB
          value: integer
        - name: numberOfCores
          value: integer
        - name: uptimeInSeconds
          value: integer
        - name: timeZone
          value: string
        - name: uploadLimitSchedule
          value:
            - name: weeklyRecurrences
              value:
                - - name: days
                    value:
                      - []
                  - name: limitInMbps
                    value: integer
        - name: errorDetails
          value:
            - name: code
              value: string
            - name: message
              value: string
        - name: provisioningState
          value: []
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a agents resource.

/*+ update */
UPDATE azure.storage_mover.agents
SET 
properties = '{{ properties }}'
WHERE 
agentName = '{{ agentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND storageMoverName = '{{ storageMoverName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified agents resource.

/*+ delete */
DELETE FROM azure.storage_mover.agents
WHERE agentName = '{{ agentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND storageMoverName = '{{ storageMoverName }}'
AND subscriptionId = '{{ subscriptionId }}';