agents

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

Overview

Name	agents
Type	Resource
Id	azure.storage_mover.agents

Fields

The following fields are returned by SELECT queries:

get

The Agent resource.

Name	Datatype	Description
properties	object
systemData	object	Resource system metadata.

list

The list of Agents.

Name	Datatype	Description
properties	object
systemData	object	Resource system metadata.

Methods

The following methods are available for this resource:

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

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
agentName	string	The name of the Agent resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageMoverName	string	The name of the Storage Mover resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets an Agent resource.

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

list

Lists all Agents in a Storage Mover.

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

INSERT examples

create_or_update

Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.

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

Manifest

# Description fields are for documentation purposes
- name: agents
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the agents resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the agents resource.
    - name: storageMoverName
      value: string
      description: Required parameter for the agents resource.
    - name: agentName
      value: string
      description: Required parameter for the agents resource.
    - name: properties
      value: object

UPDATE examples

update

Creates or updates an Agent resource.

UPDATE azure.storage_mover.agents
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND agentName = '{{ agentName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes an Agent resource.

DELETE FROM azure.storage_mover.agents
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND agentName = '{{ agentName }}' --required
;