published on Thursday, Aug 13, 2026 by Pulumi
published on Thursday, Aug 13, 2026 by Pulumi
Gets a Job Definition resource.
Uses Azure REST API version 2024-07-01.
Other available API versions: 2023-03-01, 2023-07-01-preview, 2023-10-01, 2025-07-01, 2025-08-01, 2025-12-01, 2026-05-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 for details.
Using getJobDefinition
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getJobDefinition(args: GetJobDefinitionArgs, opts?: InvokeOptions): Promise<GetJobDefinitionResult>
function getJobDefinitionOutput(args: GetJobDefinitionOutputArgs, opts?: InvokeOutputOptions): Output<GetJobDefinitionResult>def get_job_definition(job_definition_name: Optional[str] = None,
project_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
storage_mover_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetJobDefinitionResult
def get_job_definition_output(job_definition_name: pulumi.Input[Optional[str]] = None,
project_name: pulumi.Input[Optional[str]] = None,
resource_group_name: pulumi.Input[Optional[str]] = None,
storage_mover_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetJobDefinitionResult]func LookupJobDefinition(ctx *Context, args *LookupJobDefinitionArgs, opts ...InvokeOption) (*LookupJobDefinitionResult, error)
func LookupJobDefinitionOutput(ctx *Context, args *LookupJobDefinitionOutputArgs, opts ...InvokeOption) LookupJobDefinitionResultOutput> Note: This function is named LookupJobDefinition in the Go SDK.
public static class GetJobDefinition
{
public static Task<GetJobDefinitionResult> InvokeAsync(GetJobDefinitionArgs args, InvokeOptions? opts = null)
public static Output<GetJobDefinitionResult> Invoke(GetJobDefinitionInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetJobDefinitionResult> Invoke(GetJobDefinitionInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetJobDefinitionResult> getJobDefinition(GetJobDefinitionArgs args, InvokeOptions options)
public static Output<GetJobDefinitionResult> getJobDefinition(GetJobDefinitionArgs args, InvokeOptions options)
public static Output<GetJobDefinitionResult> getJobDefinition(GetJobDefinitionArgs args, InvokeOutputOptions options)
fn::invoke:
function: azure-native:storagemover:getJobDefinition
arguments:
# arguments dictionarydata "azure-native_storagemover_get_job_definition" "name" {
# arguments
}The following arguments are supported:
- Job
Definition stringName - The name of the Job Definition resource.
- Project
Name string - The name of the Project resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Storage
Mover stringName - The name of the Storage Mover resource.
- Job
Definition stringName - The name of the Job Definition resource.
- Project
Name string - The name of the Project resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Storage
Mover stringName - The name of the Storage Mover resource.
- job_
definition_ stringname - The name of the Job Definition resource.
- project_
name string - The name of the Project resource.
- resource_
group_ stringname - The name of the resource group. The name is case insensitive.
- storage_
mover_ stringname - The name of the Storage Mover resource.
- job
Definition StringName - The name of the Job Definition resource.
- project
Name String - The name of the Project resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- storage
Mover StringName - The name of the Storage Mover resource.
- job
Definition stringName - The name of the Job Definition resource.
- project
Name string - The name of the Project resource.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- storage
Mover stringName - The name of the Storage Mover resource.
- job_
definition_ strname - The name of the Job Definition resource.
- project_
name str - The name of the Project resource.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- storage_
mover_ strname - The name of the Storage Mover resource.
- job
Definition StringName - The name of the Job Definition resource.
- project
Name String - The name of the Project resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- storage
Mover StringName - The name of the Storage Mover resource.
getJobDefinition Result
The following output properties are available:
- Agent
Resource stringId - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- Azure
Api stringVersion - The Azure API version of the resource.
- Copy
Mode string - Strategy to use for copy.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
Name string - The name of the source Endpoint.
- Source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- System
Data Pulumi.Azure Native. Storage Mover. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Target
Name string - The name of the target Endpoint.
- 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
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- Description string
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- Source
Subpath string - The subpath to use when reading from the source Endpoint.
- Target
Subpath string - The subpath to use when writing to the target Endpoint.
- Agent
Resource stringId - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- Azure
Api stringVersion - The Azure API version of the resource.
- Copy
Mode string - Strategy to use for copy.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
Name string - The name of the source Endpoint.
- Source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Target
Name string - The name of the target Endpoint.
- 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
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- Description string
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- Source
Subpath string - The subpath to use when reading from the source Endpoint.
- Target
Subpath string - The subpath to use when writing to the target Endpoint.
- agent_
resource_ stringid - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- azure_
api_ stringversion - The Azure API version of the resource.
- copy_
mode string - Strategy to use for copy.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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_
name string - The name of the source Endpoint.
- source_
resource_ stringid - Fully qualified resource ID of the source Endpoint.
- system_
data object - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target_
name string - The name of the target Endpoint.
- 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_
name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- description string
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- source_
subpath string - The subpath to use when reading from the source Endpoint.
- target_
subpath string - The subpath to use when writing to the target Endpoint.
- agent
Resource StringId - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- azure
Api StringVersion - The Azure API version of the resource.
- copy
Mode String - Strategy to use for copy.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
Name String - The name of the source Endpoint.
- source
Resource StringId - Fully qualified resource ID of the source Endpoint.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Name String - The name of the target Endpoint.
- 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
Name String - Name of the Agent to assign for new Job Runs of this Job Definition.
- description String
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- source
Subpath String - The subpath to use when reading from the source Endpoint.
- target
Subpath String - The subpath to use when writing to the target Endpoint.
- agent
Resource stringId - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- azure
Api stringVersion - The Azure API version of the resource.
- copy
Mode string - Strategy to use for copy.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
Name string - The name of the source Endpoint.
- source
Resource stringId - Fully qualified resource ID of the source Endpoint.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Name string - The name of the target Endpoint.
- 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
Name string - Name of the Agent to assign for new Job Runs of this Job Definition.
- description string
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- source
Subpath string - The subpath to use when reading from the source Endpoint.
- target
Subpath string - The subpath to use when writing to the target Endpoint.
- agent_
resource_ strid - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- azure_
api_ strversion - The Azure API version of the resource.
- copy_
mode str - Strategy to use for copy.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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_
name str - The name of the source Endpoint.
- source_
resource_ strid - Fully qualified resource ID of the source Endpoint.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target_
name str - The name of the target Endpoint.
- 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_
name str - Name of the Agent to assign for new Job Runs of this Job Definition.
- description str
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- 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.
- agent
Resource StringId - Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
- azure
Api StringVersion - The Azure API version of the resource.
- copy
Mode String - Strategy to use for copy.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
Name String - The name of the source Endpoint.
- source
Resource StringId - Fully qualified resource ID of the source Endpoint.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Name String - The name of the target Endpoint.
- 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
Name String - Name of the Agent to assign for new Job Runs of this Job Definition.
- description String
- A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.
- source
Subpath String - The subpath to use when reading from the source Endpoint.
- target
Subpath String - The subpath to use when writing to the target Endpoint.
Supporting Types
SystemDataResponse
- 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 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Thursday, Aug 13, 2026 by Pulumi