Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storagemover
  5. JobDefinition
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.JobDefinition

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 Job Definition 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

    JobDefinitions_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var jobDefinition = new AzureNative.StorageMover.JobDefinition("jobDefinition", new()
    {
        AgentName = "migration-agent",
        CopyMode = AzureNative.StorageMover.CopyMode.Additive,
        Description = "Example Job Definition Description",
        JobDefinitionName = "examples-jobDefinitionName",
        ProjectName = "examples-projectName",
        ResourceGroupName = "examples-rg",
        SourceName = "examples-sourceEndpointName",
        SourceSubpath = "/",
        StorageMoverName = "examples-storageMoverName",
        TargetName = "examples-targetEndpointName",
        TargetSubpath = "/",
    });

});

    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.NewJobDefinition(ctx, "jobDefinition", &storagemover.JobDefinitionArgs{
			AgentName:         pulumi.String("migration-agent"),
			CopyMode:          pulumi.String(storagemover.CopyModeAdditive),
			Description:       pulumi.String("Example Job Definition Description"),
			JobDefinitionName: pulumi.String("examples-jobDefinitionName"),
			ProjectName:       pulumi.String("examples-projectName"),
			ResourceGroupName: pulumi.String("examples-rg"),
			SourceName:        pulumi.String("examples-sourceEndpointName"),
			SourceSubpath:     pulumi.String("/"),
			StorageMoverName:  pulumi.String("examples-storageMoverName"),
			TargetName:        pulumi.String("examples-targetEndpointName"),
			TargetSubpath:     pulumi.String("/"),
		})
		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.JobDefinition;
import com.pulumi.azurenative.storagemover.JobDefinitionArgs;
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 jobDefinition = new JobDefinition("jobDefinition", JobDefinitionArgs.builder()
            .agentName("migration-agent")
            .copyMode("Additive")
            .description("Example Job Definition Description")
            .jobDefinitionName("examples-jobDefinitionName")
            .projectName("examples-projectName")
            .resourceGroupName("examples-rg")
            .sourceName("examples-sourceEndpointName")
            .sourceSubpath("/")
            .storageMoverName("examples-storageMoverName")
            .targetName("examples-targetEndpointName")
            .targetSubpath("/")
            .build());

    }
}

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

const jobDefinition = new azure_native.storagemover.JobDefinition("jobDefinition", {
    agentName: "migration-agent",
    copyMode: azure_native.storagemover.CopyMode.Additive,
    description: "Example Job Definition Description",
    jobDefinitionName: "examples-jobDefinitionName",
    projectName: "examples-projectName",
    resourceGroupName: "examples-rg",
    sourceName: "examples-sourceEndpointName",
    sourceSubpath: "/",
    storageMoverName: "examples-storageMoverName",
    targetName: "examples-targetEndpointName",
    targetSubpath: "/",
});

    import pulumi
import pulumi_azure_native as azure_native

job_definition = azure_native.storagemover.JobDefinition("jobDefinition",
    agent_name="migration-agent",
    copy_mode=azure_native.storagemover.CopyMode.ADDITIVE,
    description="Example Job Definition Description",
    job_definition_name="examples-jobDefinitionName",
    project_name="examples-projectName",
    resource_group_name="examples-rg",
    source_name="examples-sourceEndpointName",
    source_subpath="/",
    storage_mover_name="examples-storageMoverName",
    target_name="examples-targetEndpointName",
    target_subpath="/")

    resources:
  jobDefinition:
    type: azure-native:storagemover:JobDefinition
    properties:
      agentName: migration-agent
      copyMode: Additive
      description: Example Job Definition Description
      jobDefinitionName: examples-jobDefinitionName
      projectName: examples-projectName
      resourceGroupName: examples-rg
      sourceName: examples-sourceEndpointName
      sourceSubpath: /
      storageMoverName: examples-storageMoverName
      targetName: examples-targetEndpointName
      targetSubpath: /

    Create JobDefinition Resource

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

    Constructor syntax

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

@overload
def JobDefinition(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  copy_mode: Optional[Union[str, CopyMode]] = None,
                  project_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  source_name: Optional[str] = None,
                  storage_mover_name: Optional[str] = None,
                  target_name: Optional[str] = None,
                  agent_name: Optional[str] = None,
                  description: Optional[str] = None,
                  job_definition_name: Optional[str] = None,
                  source_subpath: Optional[str] = None,
                  target_subpath: Optional[str] = None)
    func NewJobDefinition(ctx *Context, name string, args JobDefinitionArgs, opts ...ResourceOption) (*JobDefinition, error)
    public JobDefinition(string name, JobDefinitionArgs args, CustomResourceOptions? opts = null)
    public JobDefinition(String name, JobDefinitionArgs args)
public JobDefinition(String name, JobDefinitionArgs args, CustomResourceOptions options)

    type: azure-native:storagemover:JobDefinition
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 JobDefinitionArgs
    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 JobDefinitionArgs
    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 JobDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobDefinitionArgs
    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 azure_nativeJobDefinitionResource = new AzureNative.StorageMover.JobDefinition("azure-nativeJobDefinitionResource", new()
{
    CopyMode = "string",
    ProjectName = "string",
    ResourceGroupName = "string",
    SourceName = "string",
    StorageMoverName = "string",
    TargetName = "string",
    AgentName = "string",
    Description = "string",
    JobDefinitionName = "string",
    SourceSubpath = "string",
    TargetSubpath = "string",
});

    example, err := storagemover.NewJobDefinition(ctx, "azure-nativeJobDefinitionResource", &storagemover.JobDefinitionArgs{
	CopyMode:          pulumi.String("string"),
	ProjectName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	SourceName:        pulumi.String("string"),
	StorageMoverName:  pulumi.String("string"),
	TargetName:        pulumi.String("string"),
	AgentName:         pulumi.String("string"),
	Description:       pulumi.String("string"),
	JobDefinitionName: pulumi.String("string"),
	SourceSubpath:     pulumi.String("string"),
	TargetSubpath:     pulumi.String("string"),
})

    var azure_nativeJobDefinitionResource = new JobDefinition("azure-nativeJobDefinitionResource", JobDefinitionArgs.builder()
    .copyMode("string")
    .projectName("string")
    .resourceGroupName("string")
    .sourceName("string")
    .storageMoverName("string")
    .targetName("string")
    .agentName("string")
    .description("string")
    .jobDefinitionName("string")
    .sourceSubpath("string")
    .targetSubpath("string")
    .build());

    azure_native_job_definition_resource = azure_native.storagemover.JobDefinition("azure-nativeJobDefinitionResource",
    copy_mode="string",
    project_name="string",
    resource_group_name="string",
    source_name="string",
    storage_mover_name="string",
    target_name="string",
    agent_name="string",
    description="string",
    job_definition_name="string",
    source_subpath="string",
    target_subpath="string")

    const azure_nativeJobDefinitionResource = new azure_native.storagemover.JobDefinition("azure-nativeJobDefinitionResource", {
    copyMode: "string",
    projectName: "string",
    resourceGroupName: "string",
    sourceName: "string",
    storageMoverName: "string",
    targetName: "string",
    agentName: "string",
    description: "string",
    jobDefinitionName: "string",
    sourceSubpath: "string",
    targetSubpath: "string",
});

    type: azure-native:storagemover:JobDefinition
properties:
    agentName: string
    copyMode: string
    description: string
    jobDefinitionName: string
    projectName: string
    resourceGroupName: string
    sourceName: string
    sourceSubpath: string
    storageMoverName: string
    targetName: string
    targetSubpath: string

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

    CopyMode string | Pulumi.AzureNative.StorageMover.CopyMode
    Strategy to use for copy.
    ProjectName string
    The name of the Project resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SourceName string
    The name of the source Endpoint.
    StorageMoverName string
    The name of the Storage Mover resource.
    TargetName string
    The name of the target Endpoint.
    AgentName string
    Name of the Agent to assign for new Job Runs of this Job Definition.
    Description string
    A description for the Job Definition.
    JobDefinitionName string
    The name of the Job Definition resource.
    SourceSubpath string
    The subpath to use when reading from the source Endpoint.
    TargetSubpath string
    The subpath to use when writing to the target Endpoint.
    CopyMode string | CopyMode
    Strategy to use for copy.
    ProjectName string
    The name of the Project resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SourceName string
    The name of the source Endpoint.
    StorageMoverName string
    The name of the Storage Mover resource.
    TargetName string
    The name of the target Endpoint.
    AgentName string
    Name of the Agent to assign for new Job Runs of this Job Definition.
    Description string
    A description for the Job Definition.
    JobDefinitionName string
    The name of the Job Definition resource.
    SourceSubpath string
    The subpath to use when reading from the source Endpoint.
    TargetSubpath string
    The subpath to use when writing to the target Endpoint.
    copyMode String | CopyMode
    Strategy to use for copy.
    projectName String
    The name of the Project resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sourceName String
    The name of the source Endpoint.
    storageMoverName String
    The name of the Storage Mover resource.
    targetName String
    The name of the target Endpoint.
    agentName String
    Name of the Agent to assign for new Job Runs of this Job Definition.
    description String
    A description for the Job Definition.
    jobDefinitionName String
    The name of the Job Definition resource.
    sourceSubpath String
    The subpath to use when reading from the source Endpoint.
    targetSubpath String
    The subpath to use when writing to the target Endpoint.
    copyMode string | CopyMode
    Strategy to use for copy.
    projectName string
    The name of the Project resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sourceName string
    The name of the source Endpoint.
    storageMoverName string
    The name of the Storage Mover resource.
    targetName string
    The name of the target Endpoint.
    agentName string
    Name of the Agent to assign for new Job Runs of this Job Definition.
    description string
    A description for the Job Definition.
    jobDefinitionName string
    The name of the Job Definition resource.
    sourceSubpath string
    The subpath to use when reading from the source Endpoint.
    targetSubpath string
    The subpath to use when writing to the target Endpoint.
    copy_mode str | CopyMode
    Strategy to use for copy.
    project_name str
    The name of the Project resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    source_name str
    The name of the source Endpoint.
    storage_mover_name str
    The name of the Storage Mover resource.
    target_name str
    The name of the target Endpoint.
    agent_name str
    Name of the Agent to assign for new Job Runs of this Job Definition.
    description str
    A description for the Job Definition.
    job_definition_name str
    The name of the Job Definition resource.
    source_subpath str
    The subpath to use when reading from the source Endpoint.
    target_subpath str
    The subpath to use when writing to the target Endpoint.
    copyMode String | "Additive" | "Mirror"
    Strategy to use for copy.
    projectName String
    The name of the Project resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sourceName String
    The name of the source Endpoint.
    storageMoverName String
    The name of the Storage Mover resource.
    targetName String
    The name of the target Endpoint.
    agentName String
    Name of the Agent to assign for new Job Runs of this Job Definition.
    description String
    A description for the Job Definition.
    jobDefinitionName String
    The name of the Job Definition resource.
    sourceSubpath String
    The subpath to use when reading from the source Endpoint.
    targetSubpath String
    The subpath to use when writing to the target Endpoint.

    Outputs

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

    AgentResourceId string
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestJobRunName string
    The name of the Job Run in a non-terminal state, if exists.
    LatestJobRunResourceId string
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    LatestJobRunStatus string
    The current status of the Job Run in a non-terminal state, if exists.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of this resource.
    SourceResourceId string
    Fully qualified resource ID of the source Endpoint.
    SystemData Pulumi.AzureNative.StorageMover.Outputs.SystemDataResponse
    Resource system metadata.
    TargetResourceId string
    Fully qualified resource ID of the target Endpoint.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AgentResourceId string
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestJobRunName string
    The name of the Job Run in a non-terminal state, if exists.
    LatestJobRunResourceId string
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    LatestJobRunStatus string
    The current status of the Job Run in a non-terminal state, if exists.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of this resource.
    SourceResourceId string
    Fully qualified resource ID of the source Endpoint.
    SystemData SystemDataResponse
    Resource system metadata.
    TargetResourceId string
    Fully qualified resource ID of the target Endpoint.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    agentResourceId String
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    id String
    The provider-assigned unique ID for this managed resource.
    latestJobRunName String
    The name of the Job Run in a non-terminal state, if exists.
    latestJobRunResourceId String
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    latestJobRunStatus String
    The current status of the Job Run in a non-terminal state, if exists.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of this resource.
    sourceResourceId String
    Fully qualified resource ID of the source Endpoint.
    systemData SystemDataResponse
    Resource system metadata.
    targetResourceId String
    Fully qualified resource ID of the target Endpoint.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    agentResourceId string
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    id string
    The provider-assigned unique ID for this managed resource.
    latestJobRunName string
    The name of the Job Run in a non-terminal state, if exists.
    latestJobRunResourceId string
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    latestJobRunStatus string
    The current status of the Job Run in a non-terminal state, if exists.
    name string
    The name of the resource
    provisioningState string
    The provisioning state of this resource.
    sourceResourceId string
    Fully qualified resource ID of the source Endpoint.
    systemData SystemDataResponse
    Resource system metadata.
    targetResourceId string
    Fully qualified resource ID of the target Endpoint.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    agent_resource_id str
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_job_run_name str
    The name of the Job Run in a non-terminal state, if exists.
    latest_job_run_resource_id str
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    latest_job_run_status str
    The current status of the Job Run in a non-terminal state, if exists.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of this resource.
    source_resource_id str
    Fully qualified resource ID of the source Endpoint.
    system_data SystemDataResponse
    Resource system metadata.
    target_resource_id str
    Fully qualified resource ID of the target Endpoint.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    agentResourceId String
    Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
    id String
    The provider-assigned unique ID for this managed resource.
    latestJobRunName String
    The name of the Job Run in a non-terminal state, if exists.
    latestJobRunResourceId String
    The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
    latestJobRunStatus String
    The current status of the Job Run in a non-terminal state, if exists.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of this resource.
    sourceResourceId String
    Fully qualified resource ID of the source Endpoint.
    systemData Property Map
    Resource system metadata.
    targetResourceId String
    Fully qualified resource ID of the target Endpoint.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    CopyMode, CopyModeArgs

    Additive
    Additive
    Mirror
    Mirror
    CopyModeAdditive
    Additive
    CopyModeMirror
    Mirror
    Additive
    Additive
    Mirror
    Mirror
    Additive
    Additive
    Mirror
    Mirror
    ADDITIVE
    Additive
    MIRROR
    Mirror
    "Additive"
    Additive
    "Mirror"
    Mirror

    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:JobDefinition examples-jobDefinitionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}

    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