Agent interface

Package:

@azure/arm-storagemover

The Agent resource.

Extends

ProxyResource

Properties

agentStatus	The Agent status. NOTE: This property will not be serialized. It can only be populated by the server.
agentVersion	The Agent version. NOTE: This property will not be serialized. It can only be populated by the server.
arcResourceId	The fully qualified resource ID of the Hybrid Compute resource for the Agent.
arcVmUuid	The VM UUID of the Hybrid Compute resource for the Agent.
description	A description for the Agent.
errorDetails	NOTE: This property will not be serialized. It can only be populated by the server.
lastStatusUpdate	The last updated time of the Agent status. NOTE: This property will not be serialized. It can only be populated by the server.
localIPAddress	Local IP address reported by the Agent. NOTE: This property will not be serialized. It can only be populated by the server.
memoryInMB	Available memory reported by the Agent, in MB. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfCores	Available compute cores reported by the Agent. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The provisioning state of this resource. NOTE: This property will not be serialized. It can only be populated by the server.
timeZone	The agent's local time zone represented in Windows format. NOTE: This property will not be serialized. It can only be populated by the server.
uploadLimitSchedule	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	Uptime of the Agent in seconds. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

agentStatus

The Agent status. NOTE: This property will not be serialized. It can only be populated by the server.

agentStatus?: string

Property Value

string

agentVersion

The Agent version. NOTE: This property will not be serialized. It can only be populated by the server.

agentVersion?: string

Property Value

string

arcResourceId

The fully qualified resource ID of the Hybrid Compute resource for the Agent.

arcResourceId: string

Property Value

string

arcVmUuid

The VM UUID of the Hybrid Compute resource for the Agent.

arcVmUuid: string

Property Value

string

description

A description for the Agent.

description?: string

Property Value

string

errorDetails

NOTE: This property will not be serialized. It can only be populated by the server.

errorDetails?: AgentPropertiesErrorDetails

Property Value

AgentPropertiesErrorDetails

lastStatusUpdate

The last updated time of the Agent status. NOTE: This property will not be serialized. It can only be populated by the server.

lastStatusUpdate?: Date

Property Value

Date

localIPAddress

Local IP address reported by the Agent. NOTE: This property will not be serialized. It can only be populated by the server.

localIPAddress?: string

Property Value

string

memoryInMB

Available memory reported by the Agent, in MB. NOTE: This property will not be serialized. It can only be populated by the server.

memoryInMB?: number

Property Value

number

numberOfCores

Available compute cores reported by the Agent. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfCores?: number

Property Value

number

provisioningState

The provisioning state of this resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

timeZone

The agent's local time zone represented in Windows format. NOTE: This property will not be serialized. It can only be populated by the server.

timeZone?: string

Property Value

string

uploadLimitSchedule

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.

uploadLimitSchedule?: UploadLimitSchedule

Property Value

UploadLimitSchedule

uptimeInSeconds

Uptime of the Agent in seconds. NOTE: This property will not be serialized. It can only be populated by the server.

uptimeInSeconds?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type