1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. MoverAgent

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.storage.MoverAgent

Explore with Pulumi AI

Manages a Storage Mover Agent.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "East US",
});
const exampleMover = new azure.storage.Mover("example", {
    name: "example-ssm",
    resourceGroupName: example.name,
});
const exampleMoverAgent = new azure.storage.MoverAgent("example", {
    name: "example-sa",
    storageMoverId: exampleMover.id,
    arcVirtualMachineId: pulumi.interpolate`${example.id}/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName`,
    arcVirtualMachineUuid: "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
    description: "Example Agent Description",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="East US")
example_mover = azure.storage.Mover("example",
    name="example-ssm",
    resource_group_name=example.name)
example_mover_agent = azure.storage.MoverAgent("example",
    name="example-sa",
    storage_mover_id=example_mover.id,
    arc_virtual_machine_id=example.id.apply(lambda id: f"{id}/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
    arc_virtual_machine_uuid="3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
    description="Example Agent Description")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("East US"),
		})
		if err != nil {
			return err
		}
		exampleMover, err := storage.NewMover(ctx, "example", &storage.MoverArgs{
			Name:              pulumi.String("example-ssm"),
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = storage.NewMoverAgent(ctx, "example", &storage.MoverAgentArgs{
			Name:           pulumi.String("example-sa"),
			StorageMoverId: exampleMover.ID(),
			ArcVirtualMachineId: example.ID().ApplyT(func(id string) (string, error) {
				return fmt.Sprintf("%v/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", id), nil
			}).(pulumi.StringOutput),
			ArcVirtualMachineUuid: pulumi.String("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9"),
			Description:           pulumi.String("Example Agent Description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "East US",
    });

    var exampleMover = new Azure.Storage.Mover("example", new()
    {
        Name = "example-ssm",
        ResourceGroupName = example.Name,
    });

    var exampleMoverAgent = new Azure.Storage.MoverAgent("example", new()
    {
        Name = "example-sa",
        StorageMoverId = exampleMover.Id,
        ArcVirtualMachineId = example.Id.Apply(id => $"{id}/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
        ArcVirtualMachineUuid = "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
        Description = "Example Agent Description",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Mover;
import com.pulumi.azure.storage.MoverArgs;
import com.pulumi.azure.storage.MoverAgent;
import com.pulumi.azure.storage.MoverAgentArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("East US")
            .build());

        var exampleMover = new Mover("exampleMover", MoverArgs.builder()
            .name("example-ssm")
            .resourceGroupName(example.name())
            .build());

        var exampleMoverAgent = new MoverAgent("exampleMoverAgent", MoverAgentArgs.builder()
            .name("example-sa")
            .storageMoverId(exampleMover.id())
            .arcVirtualMachineId(example.id().applyValue(id -> String.format("%s/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", id)))
            .arcVirtualMachineUuid("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9")
            .description("Example Agent Description")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: East US
  exampleMover:
    type: azure:storage:Mover
    name: example
    properties:
      name: example-ssm
      resourceGroupName: ${example.name}
  exampleMoverAgent:
    type: azure:storage:MoverAgent
    name: example
    properties:
      name: example-sa
      storageMoverId: ${exampleMover.id}
      arcVirtualMachineId: ${example.id}/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName
      arcVirtualMachineUuid: 3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9
      description: Example Agent Description
Copy

Create MoverAgent Resource

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

Constructor syntax

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

@overload
def MoverAgent(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               arc_virtual_machine_id: Optional[str] = None,
               arc_virtual_machine_uuid: Optional[str] = None,
               storage_mover_id: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
func NewMoverAgent(ctx *Context, name string, args MoverAgentArgs, opts ...ResourceOption) (*MoverAgent, error)
public MoverAgent(string name, MoverAgentArgs args, CustomResourceOptions? opts = null)
public MoverAgent(String name, MoverAgentArgs args)
public MoverAgent(String name, MoverAgentArgs args, CustomResourceOptions options)
type: azure:storage:MoverAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MoverAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MoverAgentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MoverAgentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MoverAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MoverAgentArgs
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 moverAgentResource = new Azure.Storage.MoverAgent("moverAgentResource", new()
{
    ArcVirtualMachineId = "string",
    ArcVirtualMachineUuid = "string",
    StorageMoverId = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := storage.NewMoverAgent(ctx, "moverAgentResource", &storage.MoverAgentArgs{
	ArcVirtualMachineId:   pulumi.String("string"),
	ArcVirtualMachineUuid: pulumi.String("string"),
	StorageMoverId:        pulumi.String("string"),
	Description:           pulumi.String("string"),
	Name:                  pulumi.String("string"),
})
Copy
var moverAgentResource = new MoverAgent("moverAgentResource", MoverAgentArgs.builder()
    .arcVirtualMachineId("string")
    .arcVirtualMachineUuid("string")
    .storageMoverId("string")
    .description("string")
    .name("string")
    .build());
Copy
mover_agent_resource = azure.storage.MoverAgent("moverAgentResource",
    arc_virtual_machine_id="string",
    arc_virtual_machine_uuid="string",
    storage_mover_id="string",
    description="string",
    name="string")
Copy
const moverAgentResource = new azure.storage.MoverAgent("moverAgentResource", {
    arcVirtualMachineId: "string",
    arcVirtualMachineUuid: "string",
    storageMoverId: "string",
    description: "string",
    name: "string",
});
Copy
type: azure:storage:MoverAgent
properties:
    arcVirtualMachineId: string
    arcVirtualMachineUuid: string
    description: string
    name: string
    storageMoverId: string
Copy

MoverAgent 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 MoverAgent resource accepts the following input properties:

ArcVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
ArcVirtualMachineUuid
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
StorageMoverId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
Description string
Specifies a description for this Storage Mover Agent.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
ArcVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
ArcVirtualMachineUuid
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
StorageMoverId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
Description string
Specifies a description for this Storage Mover Agent.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
storageMoverId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
description String
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
storageMoverId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
description string
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
arc_virtual_machine_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arc_virtual_machine_uuid
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
storage_mover_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
description str
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. str
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
storageMoverId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
description String
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing MoverAgent Resource

Get an existing MoverAgent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MoverAgentState, opts?: CustomResourceOptions): MoverAgent
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arc_virtual_machine_id: Optional[str] = None,
        arc_virtual_machine_uuid: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        storage_mover_id: Optional[str] = None) -> MoverAgent
func GetMoverAgent(ctx *Context, name string, id IDInput, state *MoverAgentState, opts ...ResourceOption) (*MoverAgent, error)
public static MoverAgent Get(string name, Input<string> id, MoverAgentState? state, CustomResourceOptions? opts = null)
public static MoverAgent get(String name, Output<String> id, MoverAgentState state, CustomResourceOptions options)
resources:  _:    type: azure:storage:MoverAgent    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ArcVirtualMachineId Changes to this property will trigger replacement. string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
ArcVirtualMachineUuid Changes to this property will trigger replacement. string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
Description string
Specifies a description for this Storage Mover Agent.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
StorageMoverId Changes to this property will trigger replacement. string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
ArcVirtualMachineId Changes to this property will trigger replacement. string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
ArcVirtualMachineUuid Changes to this property will trigger replacement. string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
Description string
Specifies a description for this Storage Mover Agent.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
StorageMoverId Changes to this property will trigger replacement. string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
arcVirtualMachineId Changes to this property will trigger replacement. String
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid Changes to this property will trigger replacement. String
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
description String
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
storageMoverId Changes to this property will trigger replacement. String
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
arcVirtualMachineId Changes to this property will trigger replacement. string
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid Changes to this property will trigger replacement. string
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
description string
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
storageMoverId Changes to this property will trigger replacement. string
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
arc_virtual_machine_id Changes to this property will trigger replacement. str
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arc_virtual_machine_uuid Changes to this property will trigger replacement. str
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
description str
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. str
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
storage_mover_id Changes to this property will trigger replacement. str
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.
arcVirtualMachineId Changes to this property will trigger replacement. String
Specifies the fully qualified ID of the Hybrid Compute resource for the Storage Mover Agent. Changing this forces a new resource to be created.
arcVirtualMachineUuid Changes to this property will trigger replacement. String
Specifies the Hybrid Compute resource's unique SMBIOS ID. Changing this forces a new resource to be created.
description String
Specifies a description for this Storage Mover Agent.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Storage Mover Agent. Changing this forces a new resource to be created.
storageMoverId Changes to this property will trigger replacement. String
Specifies the ID of the Storage Mover that this Agent should be connected to. Changing this forces a new resource to be created.

Import

Storage Mover Agent can be imported using the resource id, e.g.

$ pulumi import azure:storage/moverAgent:MoverAgent example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.StorageMover/storageMovers/storageMover1/agents/agent1
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.