Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storagemover
  5. getAgent
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.storagemover.getAgent

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an Agent resource.

    Uses Azure REST API version 2024-07-01.

    Other available API versions: 2023-03-01, 2023-07-01-preview, 2023-10-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storagemover [ApiVersion]. See the version guide for details.

    Using getAgent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
    def get_agent(agent_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              storage_mover_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              storage_mover_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
    func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput

    > Note: This function is named LookupAgent in the Go SDK.

    public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:storagemover:getAgent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    agent_name str
    The name of the Agent resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    storage_mover_name str
    The name of the Storage Mover resource.
    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.

    getAgent Result

    The following output properties are available:

    AgentStatus string
    The Agent status.
    AgentVersion string
    The Agent version.
    ArcResourceId string
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    ArcVmUuid string
    The VM UUID of the Hybrid Compute resource for the Agent.
    AzureApiVersion string
    The Azure API version of the resource.
    ErrorDetails Pulumi.AzureNative.StorageMover.Outputs.AgentPropertiesResponseErrorDetails
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastStatusUpdate string
    The last updated time of the Agent status.
    LocalIPAddress string
    Local IP address reported by the Agent.
    MemoryInMB double
    Available memory reported by the Agent, in MB.
    Name string
    The name of the resource
    NumberOfCores double
    Available compute cores reported by the Agent.
    ProvisioningState string
    The provisioning state of this resource.
    SystemData Pulumi.AzureNative.StorageMover.Outputs.SystemDataResponse
    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"
    UptimeInSeconds double
    Uptime of the Agent in seconds.
    Description string
    A description for the Agent.
    UploadLimitSchedule Pulumi.AzureNative.StorageMover.Outputs.UploadLimitScheduleResponse
    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.
    AgentStatus string
    The Agent status.
    AgentVersion string
    The Agent version.
    ArcResourceId string
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    ArcVmUuid string
    The VM UUID of the Hybrid Compute resource for the Agent.
    AzureApiVersion string
    The Azure API version of the resource.
    ErrorDetails AgentPropertiesResponseErrorDetails
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastStatusUpdate string
    The last updated time of the Agent status.
    LocalIPAddress string
    Local IP address reported by the Agent.
    MemoryInMB float64
    Available memory reported by the Agent, in MB.
    Name string
    The name of the resource
    NumberOfCores float64
    Available compute cores reported by the Agent.
    ProvisioningState string
    The provisioning state of this resource.
    SystemData SystemDataResponse
    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"
    UptimeInSeconds float64
    Uptime of the Agent in seconds.
    Description string
    A description for the Agent.
    UploadLimitSchedule UploadLimitScheduleResponse
    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.
    agentStatus String
    The Agent status.
    agentVersion String
    The Agent version.
    arcResourceId String
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    arcVmUuid String
    The VM UUID of the Hybrid Compute resource for the Agent.
    azureApiVersion String
    The Azure API version of the resource.
    errorDetails AgentPropertiesResponseErrorDetails
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastStatusUpdate String
    The last updated time of the Agent status.
    localIPAddress String
    Local IP address reported by the Agent.
    memoryInMB Double
    Available memory reported by the Agent, in MB.
    name String
    The name of the resource
    numberOfCores Double
    Available compute cores reported by the Agent.
    provisioningState String
    The provisioning state of this resource.
    systemData SystemDataResponse
    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"
    uptimeInSeconds Double
    Uptime of the Agent in seconds.
    description String
    A description for the Agent.
    uploadLimitSchedule UploadLimitScheduleResponse
    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.
    agentStatus string
    The Agent status.
    agentVersion string
    The Agent version.
    arcResourceId string
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    arcVmUuid string
    The VM UUID of the Hybrid Compute resource for the Agent.
    azureApiVersion string
    The Azure API version of the resource.
    errorDetails AgentPropertiesResponseErrorDetails
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastStatusUpdate string
    The last updated time of the Agent status.
    localIPAddress string
    Local IP address reported by the Agent.
    memoryInMB number
    Available memory reported by the Agent, in MB.
    name string
    The name of the resource
    numberOfCores number
    Available compute cores reported by the Agent.
    provisioningState string
    The provisioning state of this resource.
    systemData SystemDataResponse
    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"
    uptimeInSeconds number
    Uptime of the Agent in seconds.
    description string
    A description for the Agent.
    uploadLimitSchedule UploadLimitScheduleResponse
    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.
    agent_status str
    The Agent status.
    agent_version str
    The Agent version.
    arc_resource_id str
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    arc_vm_uuid str
    The VM UUID of the Hybrid Compute resource for the Agent.
    azure_api_version str
    The Azure API version of the resource.
    error_details AgentPropertiesResponseErrorDetails
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    last_status_update str
    The last updated time of the Agent status.
    local_ip_address str
    Local IP address reported by the Agent.
    memory_in_mb float
    Available memory reported by the Agent, in MB.
    name str
    The name of the resource
    number_of_cores float
    Available compute cores reported by the Agent.
    provisioning_state str
    The provisioning state of this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    time_zone str
    The agent's local time zone represented in Windows format.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uptime_in_seconds float
    Uptime of the Agent in seconds.
    description str
    A description for the Agent.
    upload_limit_schedule UploadLimitScheduleResponse
    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.
    agentStatus String
    The Agent status.
    agentVersion String
    The Agent version.
    arcResourceId String
    The fully qualified resource ID of the Hybrid Compute resource for the Agent.
    arcVmUuid String
    The VM UUID of the Hybrid Compute resource for the Agent.
    azureApiVersion String
    The Azure API version of the resource.
    errorDetails Property Map
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastStatusUpdate String
    The last updated time of the Agent status.
    localIPAddress String
    Local IP address reported by the Agent.
    memoryInMB Number
    Available memory reported by the Agent, in MB.
    name String
    The name of the resource
    numberOfCores Number
    Available compute cores reported by the Agent.
    provisioningState String
    The provisioning state of this resource.
    systemData Property Map
    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"
    uptimeInSeconds Number
    Uptime of the Agent in seconds.
    description String
    A description for the Agent.
    uploadLimitSchedule Property Map
    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.

    Supporting Types

    AgentPropertiesResponseErrorDetails

    Code string
    Error code reported by Agent
    Message string
    Expanded description of reported error code
    Code string
    Error code reported by Agent
    Message string
    Expanded description of reported error code
    code String
    Error code reported by Agent
    message String
    Expanded description of reported error code
    code string
    Error code reported by Agent
    message string
    Expanded description of reported error code
    code str
    Error code reported by Agent
    message str
    Expanded description of reported error code
    code String
    Error code reported by Agent
    message String
    Expanded description of reported error code

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    TimeResponse

    Hour int
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    Minute int
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.
    Hour int
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    Minute int
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.
    hour Integer
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    minute Integer
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.
    hour number
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    minute number
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.
    hour int
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    minute int
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.
    hour Number
    The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.
    minute Number
    The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.

    UploadLimitScheduleResponse

    WeeklyRecurrences List<Pulumi.AzureNative.StorageMover.Inputs.UploadLimitWeeklyRecurrenceResponse>
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.
    WeeklyRecurrences []UploadLimitWeeklyRecurrenceResponse
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.
    weeklyRecurrences List<UploadLimitWeeklyRecurrenceResponse>
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.
    weeklyRecurrences UploadLimitWeeklyRecurrenceResponse[]
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.
    weekly_recurrences Sequence[UploadLimitWeeklyRecurrenceResponse]
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.
    weeklyRecurrences List<Property Map>
    The set of weekly repeating recurrences of the WAN-link upload limit schedule.

    UploadLimitWeeklyRecurrenceResponse

    Days List<string>
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    EndTime Pulumi.AzureNative.StorageMover.Inputs.TimeResponse
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    LimitInMbps int
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    StartTime Pulumi.AzureNative.StorageMover.Inputs.TimeResponse
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    Days []string
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    EndTime TimeResponse
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    LimitInMbps int
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    StartTime TimeResponse
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    days List<String>
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    endTime TimeResponse
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    limitInMbps Integer
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    startTime TimeResponse
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    days string[]
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    endTime TimeResponse
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    limitInMbps number
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    startTime TimeResponse
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    days Sequence[str]
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    end_time TimeResponse
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    limit_in_mbps int
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    start_time TimeResponse
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    days List<String>
    The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.
    endTime Property Map
    The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.
    limitInMbps Number
    The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.
    startTime Property Map
    The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native