1. Packages
  2. Azure Native
  3. API Docs
  4. storagemover
  5. getJobDefinition
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.storagemover.getJobDefinition

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 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. 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?: InvokeOptions): Output<GetJobDefinitionResult>
Copy
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: Optional[pulumi.Input[str]] = None,
                       project_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       storage_mover_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetJobDefinitionResult]
Copy
func LookupJobDefinition(ctx *Context, args *LookupJobDefinitionArgs, opts ...InvokeOption) (*LookupJobDefinitionResult, error)
func LookupJobDefinitionOutput(ctx *Context, args *LookupJobDefinitionOutputArgs, opts ...InvokeOption) LookupJobDefinitionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetJobDefinitionResult> getJobDefinition(GetJobDefinitionArgs args, InvokeOptions options)
public static Output<GetJobDefinitionResult> getJobDefinition(GetJobDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storagemover:getJobDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job Definition resource.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Project resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageMoverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Storage Mover resource.
JobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job Definition resource.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Project resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageMoverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Storage Mover resource.
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Job Definition resource.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Project resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageMoverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Storage Mover resource.
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job Definition resource.
projectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Project resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
storageMoverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Storage Mover resource.
job_definition_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Job Definition resource.
project_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Project resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
storage_mover_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Storage Mover resource.
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Job Definition resource.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Project resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageMoverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Storage Mover resource.

getJobDefinition Result

The following output properties are available:

AgentResourceId string
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
AzureApiVersion string
The Azure API version of the resource.
CopyMode string
Strategy to use for copy.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
SourceName string
The name of the source Endpoint.
SourceResourceId string
Fully qualified resource ID of the source Endpoint.
SystemData Pulumi.AzureNative.StorageMover.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TargetName string
The name of the target Endpoint.
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"
AgentName string
Name of the Agent to assign for new Job Runs of this Job Definition.
Description string
A description for the Job Definition.
SourceSubpath string
The subpath to use when reading from the source Endpoint.
TargetSubpath string
The subpath to use when writing to the target Endpoint.
AgentResourceId string
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
AzureApiVersion string
The Azure API version of the resource.
CopyMode string
Strategy to use for copy.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
SourceName string
The name of the source Endpoint.
SourceResourceId string
Fully qualified resource ID of the source Endpoint.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TargetName string
The name of the target Endpoint.
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"
AgentName string
Name of the Agent to assign for new Job Runs of this Job Definition.
Description string
A description for the Job Definition.
SourceSubpath string
The subpath to use when reading from the source Endpoint.
TargetSubpath string
The subpath to use when writing to the target Endpoint.
agentResourceId String
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
azureApiVersion String
The Azure API version of the resource.
copyMode String
Strategy to use for copy.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
sourceName String
The name of the source Endpoint.
sourceResourceId String
Fully qualified resource ID of the source Endpoint.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetName String
The name of the target Endpoint.
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"
agentName String
Name of the Agent to assign for new Job Runs of this Job Definition.
description String
A description for the Job Definition.
sourceSubpath String
The subpath to use when reading from the source Endpoint.
targetSubpath String
The subpath to use when writing to the target Endpoint.
agentResourceId string
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
azureApiVersion string
The Azure API version of the resource.
copyMode string
Strategy to use for copy.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
sourceName string
The name of the source Endpoint.
sourceResourceId string
Fully qualified resource ID of the source Endpoint.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetName string
The name of the target Endpoint.
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"
agentName string
Name of the Agent to assign for new Job Runs of this Job Definition.
description string
A description for the Job Definition.
sourceSubpath string
The subpath to use when reading from the source Endpoint.
targetSubpath string
The subpath to use when writing to the target Endpoint.
agent_resource_id str
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
azure_api_version str
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_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_name str
The name of the source Endpoint.
source_resource_id str
Fully qualified resource ID of the source Endpoint.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
target_name str
The name of the target Endpoint.
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"
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.
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.
agentResourceId String
Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
azureApiVersion String
The Azure API version of the resource.
copyMode String
Strategy to use for copy.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
sourceName String
The name of the source Endpoint.
sourceResourceId String
Fully qualified resource ID of the source Endpoint.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetName String
The name of the target Endpoint.
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"
agentName String
Name of the Agent to assign for new Job Runs of this Job Definition.
description String
A description for the Job Definition.
sourceSubpath String
The subpath to use when reading from the source Endpoint.
targetSubpath String
The subpath to use when writing to the target Endpoint.

Supporting Types

SystemDataResponse

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi