azure-native-v2.storagemover.JobDefinition
Explore with Pulumi AI
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.
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
This property is required. string - The unique name of the resource.
- args
This property is required. JobDefinitionArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. JobDefinitionArgs - 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. JobDefinitionArgs - 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. 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: "string",
ProjectName: "string",
ResourceGroupName: "string",
SourceName: "string",
StorageMoverName: "string",
TargetName: "string",
AgentName: "string",
Description: "string",
JobDefinitionName: "string",
SourceSubpath: "string",
TargetSubpath: "string",
})
var azure_nativeJobDefinitionResource = new com.pulumi.azurenative.storagemover.JobDefinition("azure-nativeJobDefinitionResource", com.pulumi.azurenative.storagemover.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:
- Copy
Mode This property is required. string | Pulumi.Azure Native. Storage Mover. Copy Mode - Strategy to use for copy.
- Project
Name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Source
Name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- Storage
Mover Name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- Target
Name This property is required. Changes to this property will trigger replacement.
- The name of the target Endpoint.
- Agent
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- Description string
- A description for the Job Definition.
- Job
Definition Name Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- Source
Subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- Target
Subpath Changes to this property will trigger replacement.
- The subpath to use when writing to the target Endpoint.
- Copy
Mode This property is required. string | CopyMode - Strategy to use for copy.
- Project
Name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Source
Name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- Storage
Mover Name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- Target
Name This property is required. Changes to this property will trigger replacement.
- The name of the target Endpoint.
- Agent
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- Description string
- A description for the Job Definition.
- Job
Definition Name Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- Source
Subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- Target
Subpath Changes to this property will trigger replacement.
- The subpath to use when writing to the target Endpoint.
- copy
Mode This property is required. String | CopyMode - Strategy to use for copy.
- project
Name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- source
Name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- storage
Mover Name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- target
Name This property is required. Changes to this property will trigger replacement.
- The name of the target Endpoint.
- agent
Name String - Name of the Agent to assign for new Job Runs of this Job Definition.
- description String
- A description for the Job Definition.
- job
Definition Name Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- source
Subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- target
Subpath Changes to this property will trigger replacement.
- The subpath to use when writing to the target Endpoint.
- copy
Mode This property is required. string | CopyMode - Strategy to use for copy.
- project
Name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- source
Name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- storage
Mover Name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- target
Name This property is required. Changes to this property will trigger replacement.
- The name of the target Endpoint.
- agent
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- description string
- A description for the Job Definition.
- job
Definition Name Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- source
Subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- target
Subpath Changes to this property will trigger replacement.
- The subpath to use when writing to the target Endpoint.
- copy_
mode This property is required. str | CopyMode - Strategy to use for copy.
- project_
name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- source_
name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- storage_
mover_ name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- target_
name This property is required. Changes to this property will trigger replacement.
- 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 Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- source_
subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- target_
subpath Changes to this property will trigger replacement.
- The subpath to use when writing to the target Endpoint.
- copy
Mode This property is required. String | "Additive" | "Mirror" - Strategy to use for copy.
- project
Name This property is required. Changes to this property will trigger replacement.
- The name of the Project resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- source
Name This property is required. Changes to this property will trigger replacement.
- The name of the source Endpoint.
- storage
Mover Name This property is required. Changes to this property will trigger replacement.
- The name of the Storage Mover resource.
- target
Name This property is required. Changes to this property will trigger replacement.
- The name of the target Endpoint.
- agent
Name String - Name of the Agent to assign for new Job Runs of this Job Definition.
- description String
- A description for the Job Definition.
- job
Definition Name Changes to this property will trigger replacement.
- The name of the Job Definition resource.
- source
Subpath Changes to this property will trigger replacement.
- The subpath to use when reading from the source Endpoint.
- target
Subpath Changes to this property will trigger replacement.
- 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:
- Agent
Resource stringId - 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.
- Latest
Job stringRun Name - The name of the Job Run in a non-terminal state, if exists.
- Latest
Job stringRun Resource Id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- Latest
Job stringRun Status - The current status of the Job Run in a non-terminal state, if exists.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of this resource.
- Source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- System
Data Pulumi.Azure Native. Storage Mover. Outputs. System Data Response - Resource system metadata.
- Target
Resource stringId - 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 stringId - 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.
- Latest
Job stringRun Name - The name of the Job Run in a non-terminal state, if exists.
- Latest
Job stringRun Resource Id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- Latest
Job stringRun Status - The current status of the Job Run in a non-terminal state, if exists.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of this resource.
- Source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- System
Data SystemData Response - Resource system metadata.
- Target
Resource stringId - 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 StringId - 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.
- latest
Job StringRun Name - The name of the Job Run in a non-terminal state, if exists.
- latest
Job StringRun Resource Id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- latest
Job StringRun Status - The current status of the Job Run in a non-terminal state, if exists.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of this resource.
- source
Resource StringId - Fully qualified resource ID of the source Endpoint.
- system
Data SystemData Response - Resource system metadata.
- target
Resource StringId - 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 stringId - 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.
- latest
Job stringRun Name - The name of the Job Run in a non-terminal state, if exists.
- latest
Job stringRun Resource Id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- latest
Job stringRun Status - The current status of the Job Run in a non-terminal state, if exists.
- name string
- The name of the resource
- provisioning
State string - The provisioning state of this resource.
- source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- system
Data SystemData Response - Resource system metadata.
- target
Resource stringId - 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_ strid - 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_ strrun_ name - The name of the Job Run in a non-terminal state, if exists.
- latest_
job_ strrun_ resource_ id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- latest_
job_ strrun_ status - 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_ strid - Fully qualified resource ID of the source Endpoint.
- system_
data SystemData Response - Resource system metadata.
- target_
resource_ strid - Fully qualified resource ID of the target Endpoint.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- agent
Resource StringId - 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.
- latest
Job StringRun Name - The name of the Job Run in a non-terminal state, if exists.
- latest
Job StringRun Resource Id - The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
- latest
Job StringRun Status - The current status of the Job Run in a non-terminal state, if exists.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of this resource.
- source
Resource StringId - Fully qualified resource ID of the source Endpoint.
- system
Data Property Map - Resource system metadata.
- target
Resource StringId - 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
- Copy
Mode Additive - Additive
- Copy
Mode Mirror - Mirror
- Additive
- Additive
- Mirror
- Mirror
- Additive
- Additive
- Mirror
- Mirror
- ADDITIVE
- Additive
- MIRROR
- Mirror
- "Additive"
- Additive
- "Mirror"
- Mirror
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0