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

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.
agentStatus	string	The Agent status. Known values are: "Registering", "Offline", "Online", "Executing", "RequiresAttention", and "Unregistering". (Registering, Offline, Online, Executing, RequiresAttention, Unregistering)
agentVersion	string	The Agent version.
arcResourceId	string	The fully qualified resource ID of the Hybrid Compute resource for the Agent. Required.
arcVmUuid	string	The VM UUID of the Hybrid Compute resource for the Agent. Required.
description	string	A description for the Agent.
errorDetails	object	:vartype error_details: ~azure.mgmt.storagemover.models.AgentPropertiesErrorDetails
lastStatusUpdate	string (date-time)	The last updated time of the Agent status.
localIPAddress	string	Local IP address reported by the Agent.
memoryInMB	integer	Available memory reported by the Agent, in MB.
numberOfCores	integer	Available compute cores reported by the Agent.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZone	string	The agent's local time zone represented in Windows format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uploadLimitSchedule	object	The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time.
uptimeInSeconds	integer	Uptime of the Agent in seconds.

list

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.
agentStatus	string	The Agent status. Known values are: "Registering", "Offline", "Online", "Executing", "RequiresAttention", and "Unregistering". (Registering, Offline, Online, Executing, RequiresAttention, Unregistering)
agentVersion	string	The Agent version.
arcResourceId	string	The fully qualified resource ID of the Hybrid Compute resource for the Agent. Required.
arcVmUuid	string	The VM UUID of the Hybrid Compute resource for the Agent. Required.
description	string	A description for the Agent.
errorDetails	object	:vartype error_details: ~azure.mgmt.storagemover.models.AgentPropertiesErrorDetails
lastStatusUpdate	string (date-time)	The last updated time of the Agent status.
localIPAddress	string	Local IP address reported by the Agent.
memoryInMB	integer	Available memory reported by the Agent, in MB.
numberOfCores	integer	Available compute cores reported by the Agent.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZone	string	The agent's local time zone represented in Windows format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uploadLimitSchedule	object	The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time.
uptimeInSeconds	integer	Uptime of the Agent in seconds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_mover_name, agent_name, subscription_id		Gets an Agent resource.
list	select	resource_group_name, storage_mover_name, subscription_id		Lists all Agents in a Storage Mover.
create_or_update	insert	resource_group_name, storage_mover_name, agent_name, subscription_id, properties		Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.
update	update	resource_group_name, storage_mover_name, agent_name, subscription_id		Creates or updates an Agent resource.
create_or_update	replace	resource_group_name, storage_mover_name, agent_name, subscription_id, properties		Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.
delete	delete	resource_group_name, storage_mover_name, agent_name, subscription_id		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
agent_name	string	The name of the Agent resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_mover_name	string	The name of the Storage Mover resource. Required.
subscription_id	string

SELECT examples

get

Gets an Agent resource.

SELECT
id,
name,
agentStatus,
agentVersion,
arcResourceId,
arcVmUuid,
description,
errorDetails,
lastStatusUpdate,
localIPAddress,
memoryInMB,
numberOfCores,
provisioningState,
systemData,
timeZone,
type,
uploadLimitSchedule,
uptimeInSeconds
FROM azure.storage_mover.agents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND agent_name = '{{ agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Agents in a Storage Mover.

SELECT
id,
name,
agentStatus,
agentVersion,
arcResourceId,
arcVmUuid,
description,
errorDetails,
lastStatusUpdate,
localIPAddress,
memoryInMB,
numberOfCores,
provisioningState,
systemData,
timeZone,
type,
uploadLimitSchedule,
uptimeInSeconds
FROM azure.storage_mover.agents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
storage_mover_name,
agent_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ storage_mover_name }}',
'{{ agent_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: agents
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the agents resource.
  - name: storage_mover_name
    value: "{{ storage_mover_name }}"
    description: Required parameter for the agents resource.
  - name: agent_name
    value: "{{ agent_name }}"
    description: Required parameter for the agents resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the agents resource.
  - name: properties
    description: |
      Required.
    value:
      description: "{{ description }}"
      agentVersion: "{{ agentVersion }}"
      arcResourceId: "{{ arcResourceId }}"
      arcVmUuid: "{{ arcVmUuid }}"
      agentStatus: "{{ agentStatus }}"
      lastStatusUpdate: "{{ lastStatusUpdate }}"
      localIPAddress: "{{ localIPAddress }}"
      memoryInMB: {{ memoryInMB }}
      numberOfCores: {{ numberOfCores }}
      uptimeInSeconds: {{ uptimeInSeconds }}
      timeZone: "{{ timeZone }}"
      uploadLimitSchedule:
        weeklyRecurrences:
          - startTime:
              hour: {{ hour }}
              minute: "{{ minute }}"
            endTime:
              hour: {{ hour }}
              minute: "{{ minute }}"
            days: "{{ days }}"
            limitInMbps: {{ limitInMbps }}
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Creates or updates an Agent resource.

UPDATE azure.storage_mover.agents
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND agent_name = '{{ agent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure.storage_mover.agents
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND agent_name = '{{ agent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an Agent resource.

DELETE FROM azure.storage_mover.agents
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND agent_name = '{{ agent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;