pulumi-azure-native-kotlin/com.pulumi.azurenative.storagemover.kotlin/Agent

Agent

class Agent : KotlinCustomResource

The Agent resource. Uses Azure REST API version 2024-07-01. In version 2.x of the Azure Native provider, it used API version 2023-03-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/#accessing-any-api-version-via-local-packages for details.

Example Usage

Agents_CreateOrUpdate_MaximumSet

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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/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",
        UploadLimitSchedule = new AzureNative.StorageMover.Inputs.UploadLimitScheduleArgs
        {
            WeeklyRecurrences = new[]
            {
                new AzureNative.StorageMover.Inputs.UploadLimitWeeklyRecurrenceArgs
                {
                    Days = new[]
                    {
                        AzureNative.StorageMover.DayOfWeek.Monday,
                    },
                    EndTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 18,
                        Minute = 30,
                    },
                    LimitInMbps = 2000,
                    StartTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 9,
                        Minute = 0,
                    },
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	storagemover "github.com/pulumi/pulumi-azure-native-sdk/storagemover/v3"
	"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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/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"),
			UploadLimitSchedule: &storagemover.UploadLimitScheduleArgs{
				WeeklyRecurrences: storagemover.UploadLimitWeeklyRecurrenceArray{
					&storagemover.UploadLimitWeeklyRecurrenceArgs{
						Days: storagemover.DayOfWeekArray{
							storagemover.DayOfWeekMonday,
						},
						EndTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(18),
							Minute: pulumi.Int(30),
						},
						LimitInMbps: pulumi.Int(2000),
						StartTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(9),
							Minute: pulumi.Int(0),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 com.pulumi.azurenative.storagemover.inputs.UploadLimitScheduleArgs;
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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/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")
            .uploadLimitSchedule(UploadLimitScheduleArgs.builder()
                .weeklyRecurrences(UploadLimitWeeklyRecurrenceArgs.builder()
                    .days("Monday")
                    .endTime(TimeArgs.builder()
                        .hour(18)
                        .minute(30)
                        .build())
                    .limitInMbps(2000)
                    .startTime(TimeArgs.builder()
                        .hour(9)
                        .minute(0)
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Agents_CreateOrUpdate_MinimumSet

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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
        ArcVmUuid = "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
        ResourceGroupName = "examples-rg",
        StorageMoverName = "examples-storageMoverName",
    });
});
Content copied to clipboard
package main
import (
	storagemover "github.com/pulumi/pulumi-azure-native-sdk/storagemover/v3"
	"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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
			ArcVmUuid:         pulumi.String("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9"),
			ResourceGroupName: pulumi.String("examples-rg"),
			StorageMoverName:  pulumi.String("examples-storageMoverName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName")
            .arcVmUuid("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9")
            .resourceGroupName("examples-rg")
            .storageMoverName("examples-storageMoverName")
            .build());
    }
}
Content copied to clipboard

Agents_CreateOrUpdate_WithOvernightUploadLimitSchedule

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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
        ArcVmUuid = "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
        ResourceGroupName = "examples-rg",
        StorageMoverName = "examples-storageMoverName",
        UploadLimitSchedule = new AzureNative.StorageMover.Inputs.UploadLimitScheduleArgs
        {
            WeeklyRecurrences = new[]
            {
                new AzureNative.StorageMover.Inputs.UploadLimitWeeklyRecurrenceArgs
                {
                    Days = new[]
                    {
                        AzureNative.StorageMover.DayOfWeek.Monday,
                        AzureNative.StorageMover.DayOfWeek.Tuesday,
                        AzureNative.StorageMover.DayOfWeek.Wednesday,
                        AzureNative.StorageMover.DayOfWeek.Thursday,
                        AzureNative.StorageMover.DayOfWeek.Friday,
                        AzureNative.StorageMover.DayOfWeek.Saturday,
                        AzureNative.StorageMover.DayOfWeek.Sunday,
                    },
                    EndTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 24,
                        Minute = 0,
                    },
                    LimitInMbps = 2000,
                    StartTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 18,
                        Minute = 0,
                    },
                },
                new AzureNative.StorageMover.Inputs.UploadLimitWeeklyRecurrenceArgs
                {
                    Days = new[]
                    {
                        AzureNative.StorageMover.DayOfWeek.Monday,
                        AzureNative.StorageMover.DayOfWeek.Tuesday,
                        AzureNative.StorageMover.DayOfWeek.Wednesday,
                        AzureNative.StorageMover.DayOfWeek.Thursday,
                        AzureNative.StorageMover.DayOfWeek.Friday,
                        AzureNative.StorageMover.DayOfWeek.Saturday,
                        AzureNative.StorageMover.DayOfWeek.Sunday,
                    },
                    EndTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 9,
                        Minute = 0,
                    },
                    LimitInMbps = 2000,
                    StartTime = new AzureNative.StorageMover.Inputs.TimeArgs
                    {
                        Hour = 0,
                        Minute = 0,
                    },
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	storagemover "github.com/pulumi/pulumi-azure-native-sdk/storagemover/v3"
	"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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
			ArcVmUuid:         pulumi.String("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9"),
			ResourceGroupName: pulumi.String("examples-rg"),
			StorageMoverName:  pulumi.String("examples-storageMoverName"),
			UploadLimitSchedule: &storagemover.UploadLimitScheduleArgs{
				WeeklyRecurrences: storagemover.UploadLimitWeeklyRecurrenceArray{
					&storagemover.UploadLimitWeeklyRecurrenceArgs{
						Days: storagemover.DayOfWeekArray{
							storagemover.DayOfWeekMonday,
							storagemover.DayOfWeekTuesday,
							storagemover.DayOfWeekWednesday,
							storagemover.DayOfWeekThursday,
							storagemover.DayOfWeekFriday,
							storagemover.DayOfWeekSaturday,
							storagemover.DayOfWeekSunday,
						},
						EndTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(24),
							Minute: pulumi.Int(0),
						},
						LimitInMbps: pulumi.Int(2000),
						StartTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(18),
							Minute: pulumi.Int(0),
						},
					},
					&storagemover.UploadLimitWeeklyRecurrenceArgs{
						Days: storagemover.DayOfWeekArray{
							storagemover.DayOfWeekMonday,
							storagemover.DayOfWeekTuesday,
							storagemover.DayOfWeekWednesday,
							storagemover.DayOfWeekThursday,
							storagemover.DayOfWeekFriday,
							storagemover.DayOfWeekSaturday,
							storagemover.DayOfWeekSunday,
						},
						EndTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(9),
							Minute: pulumi.Int(0),
						},
						LimitInMbps: pulumi.Int(2000),
						StartTime: &storagemover.TimeArgs{
							Hour:   pulumi.Int(0),
							Minute: pulumi.Int(0),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 com.pulumi.azurenative.storagemover.inputs.UploadLimitScheduleArgs;
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/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName")
            .arcVmUuid("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9")
            .resourceGroupName("examples-rg")
            .storageMoverName("examples-storageMoverName")
            .uploadLimitSchedule(UploadLimitScheduleArgs.builder()
                .weeklyRecurrences(
                    UploadLimitWeeklyRecurrenceArgs.builder()
                        .days(
                            "Monday",
                            "Tuesday",
                            "Wednesday",
                            "Thursday",
                            "Friday",
                            "Saturday",
                            "Sunday")
                        .endTime(TimeArgs.builder()
                            .hour(24)
                            .minute(0)
                            .build())
                        .limitInMbps(2000)
                        .startTime(TimeArgs.builder()
                            .hour(18)
                            .minute(0)
                            .build())
                        .build(),
                    UploadLimitWeeklyRecurrenceArgs.builder()
                        .days(
                            "Monday",
                            "Tuesday",
                            "Wednesday",
                            "Thursday",
                            "Friday",
                            "Saturday",
                            "Sunday")
                        .endTime(TimeArgs.builder()
                            .hour(9)
                            .minute(0)
                            .build())
                        .limitInMbps(2000)
                        .startTime(TimeArgs.builder()
                            .hour(0)
                            .minute(0)
                            .build())
                        .build())
                .build())
            .build());
    }
}
Content copied to clipboard

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}
Content copied to clipboard

Properties

Link copied to clipboard
val agentStatus: Output<String>

The Agent status.

Link copied to clipboard
val agentVersion: Output<String>

The Agent version.

Link copied to clipboard
val arcResourceId: Output<String>

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

Link copied to clipboard
val arcVmUuid: Output<String>

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

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val description: Output<String>?

A description for the Agent.

Link copied to clipboard
Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val lastStatusUpdate: Output<String>

The last updated time of the Agent status.

Link copied to clipboard
val localIPAddress: Output<String>

Local IP address reported by the Agent.

Link copied to clipboard
val memoryInMB: Output<Double>

Available memory reported by the Agent, in MB.

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val numberOfCores: Output<Double>

Available compute cores reported by the Agent.

Link copied to clipboard
val provisioningState: Output<String>

The provisioning state of this resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val timeZone: Output<String>

The agent's local time zone represented in Windows format.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val uploadLimitSchedule: Output<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.

Link copied to clipboard
val uptimeInSeconds: Output<Double>

Uptime of the Agent in seconds.

Link copied to clipboard
val urn: Output<String>