Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storagemover
  5. Agent
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.storagemover.Agent

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    The Agent resource. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2022-07-01-preview.

    Other available API versions: 2023-07-01-preview, 2023-10-01, 2024-07-01.

    Example Usage

    Agents_CreateOrUpdate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var agent = new AzureNative.StorageMover.Agent("agent", new()
    {
        AgentName = "examples-agentName",
        ArcResourceId = "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
        ArcVmUuid = "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
        Description = "Example Agent Description",
        ResourceGroupName = "examples-rg",
        StorageMoverName = "examples-storageMoverName",
    });

});

    package main

import (
	storagemover "github.com/pulumi/pulumi-azure-native-sdk/storagemover/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagemover.NewAgent(ctx, "agent", &storagemover.AgentArgs{
			AgentName:         pulumi.String("examples-agentName"),
			ArcResourceId:     pulumi.String("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
			ArcVmUuid:         pulumi.String("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9"),
			Description:       pulumi.String("Example Agent Description"),
			ResourceGroupName: pulumi.String("examples-rg"),
			StorageMoverName:  pulumi.String("examples-storageMoverName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storagemover.Agent;
import com.pulumi.azurenative.storagemover.AgentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var agent = new Agent("agent", AgentArgs.builder()
            .agentName("examples-agentName")
            .arcResourceId("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName")
            .arcVmUuid("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9")
            .description("Example Agent Description")
            .resourceGroupName("examples-rg")
            .storageMoverName("examples-storageMoverName")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const agent = new azure_native.storagemover.Agent("agent", {
    agentName: "examples-agentName",
    arcResourceId: "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
    arcVmUuid: "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
    description: "Example Agent Description",
    resourceGroupName: "examples-rg",
    storageMoverName: "examples-storageMoverName",
});

    import pulumi
import pulumi_azure_native as azure_native

agent = azure_native.storagemover.Agent("agent",
    agent_name="examples-agentName",
    arc_resource_id="/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
    arc_vm_uuid="3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
    description="Example Agent Description",
    resource_group_name="examples-rg",
    storage_mover_name="examples-storageMoverName")

    resources:
  agent:
    type: azure-native:storagemover:Agent
    properties:
      agentName: examples-agentName
      arcResourceId: /subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName
      arcVmUuid: 3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9
      description: Example Agent Description
      resourceGroupName: examples-rg
      storageMoverName: examples-storageMoverName

    Create Agent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);
    @overload
def Agent(resource_name: str,
          args: AgentArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Agent(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          arc_resource_id: Optional[str] = None,
          arc_vm_uuid: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          storage_mover_name: Optional[str] = None,
          agent_name: Optional[str] = None,
          description: Optional[str] = None)
    func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)
    public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)
    public Agent(String name, AgentArgs args)
public Agent(String name, AgentArgs args, CustomResourceOptions options)

    type: azure-native:storagemover:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var agentResource = new AzureNative.StorageMover.Agent("agentResource", new()
{
    ArcResourceId = "string",
    ArcVmUuid = "string",
    ResourceGroupName = "string",
    StorageMoverName = "string",
    AgentName = "string",
    Description = "string",
});

    example, err := storagemover.NewAgent(ctx, "agentResource", &storagemover.AgentArgs{
	ArcResourceId:     pulumi.String("string"),
	ArcVmUuid:         pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	StorageMoverName:  pulumi.String("string"),
	AgentName:         pulumi.String("string"),
	Description:       pulumi.String("string"),
})

    var agentResource = new Agent("agentResource", AgentArgs.builder()
    .arcResourceId("string")
    .arcVmUuid("string")
    .resourceGroupName("string")
    .storageMoverName("string")
    .agentName("string")
    .description("string")
    .build());

    agent_resource = azure_native.storagemover.Agent("agentResource",
    arc_resource_id="string",
    arc_vm_uuid="string",
    resource_group_name="string",
    storage_mover_name="string",
    agent_name="string",
    description="string")

    const agentResource = new azure_native.storagemover.Agent("agentResource", {
    arcResourceId: "string",
    arcVmUuid: "string",
    resourceGroupName: "string",
    storageMoverName: "string",
    agentName: "string",
    description: "string",
});

    type: azure-native:storagemover:Agent
properties:
    agentName: string
    arcResourceId: string
    arcVmUuid: string
    description: string
    resourceGroupName: string
    storageMoverName: string

    Agent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Agent resource accepts the following input properties:

    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.
    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.
    Description string
    A description for the Agent.
    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.
    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.
    Description string
    A description for the Agent.
    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.
    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.
    description String
    A description for the Agent.
    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.
    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.
    description string
    A description for the Agent.
    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.
    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.
    agent_name str
    The name of the Agent resource.
    description str
    A description for the Agent.
    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.
    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.
    description String
    A description for the Agent.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:

    AgentStatus string
    The Agent status.
    AgentVersion string
    The Agent version.
    ErrorDetails Pulumi.AzureNative.StorageMover.Outputs.AgentPropertiesResponseErrorDetails
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UptimeInSeconds double
    Uptime of the Agent in seconds.
    AgentStatus string
    The Agent status.
    AgentVersion string
    The Agent version.
    ErrorDetails AgentPropertiesResponseErrorDetails
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UptimeInSeconds float64
    Uptime of the Agent in seconds.
    agentStatus String
    The Agent status.
    agentVersion String
    The Agent version.
    errorDetails AgentPropertiesResponseErrorDetails
    id String
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uptimeInSeconds Double
    Uptime of the Agent in seconds.
    agentStatus string
    The Agent status.
    agentVersion string
    The Agent version.
    errorDetails AgentPropertiesResponseErrorDetails
    id string
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uptimeInSeconds number
    Uptime of the Agent in seconds.
    agent_status str
    The Agent status.
    agent_version str
    The Agent version.
    error_details AgentPropertiesResponseErrorDetails
    id str
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    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.
    agentStatus String
    The Agent status.
    agentVersion String
    The Agent version.
    errorDetails Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    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
    Resource system metadata.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uptimeInSeconds Number
    Uptime of the Agent in seconds.

    Supporting Types

    AgentPropertiesResponseErrorDetails, AgentPropertiesResponseErrorDetailsArgs

    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, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:storagemover:Agent examples-agentName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}

    To learn more about importing existing cloud resources, see Importing resources.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native