1. Packages
  2. Azure Native
  3. API Docs
  4. hybriddata
  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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.hybriddata.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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

This method gets job definition object by name.

Uses Azure REST API version 2019-06-01.

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(data_manager_name: Optional[str] = None,
                       data_service_name: Optional[str] = None,
                       job_definition_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetJobDefinitionResult
def get_job_definition_output(data_manager_name: Optional[pulumi.Input[str]] = None,
                       data_service_name: Optional[pulumi.Input[str]] = None,
                       job_definition_name: Optional[pulumi.Input[str]] = None,
                       resource_group_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:hybriddata:getJobDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
DataServiceName
This property is required.
Changes to this property will trigger replacement.
string
The data service name of the job definition
JobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The job definition name that is being queried.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name
DataManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
DataServiceName
This property is required.
Changes to this property will trigger replacement.
string
The data service name of the job definition
JobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The job definition name that is being queried.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name
dataManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
dataServiceName
This property is required.
Changes to this property will trigger replacement.
String
The data service name of the job definition
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The job definition name that is being queried.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Resource Group Name
dataManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
dataServiceName
This property is required.
Changes to this property will trigger replacement.
string
The data service name of the job definition
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The job definition name that is being queried.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name
data_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
data_service_name
This property is required.
Changes to this property will trigger replacement.
str
The data service name of the job definition
job_definition_name
This property is required.
Changes to this property will trigger replacement.
str
The job definition name that is being queried.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The Resource Group Name
dataManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
dataServiceName
This property is required.
Changes to this property will trigger replacement.
String
The data service name of the job definition
jobDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The job definition name that is being queried.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Resource Group Name

getJobDefinition Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DataSinkId string
Data Sink Id associated to the job definition.
DataSourceId string
Data Source Id associated to the job definition.
Id string
Id of the object.
Name string
Name of the object.
State string
State of the job definition.
Type string
Type of the object.
CustomerSecrets List<Pulumi.AzureNative.HybridData.Outputs.CustomerSecretResponse>
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
DataServiceInput object
A generic json used differently by each data service type.
LastModifiedTime string
Last modified time of the job definition.
RunLocation string
This is the preferred geo location for the job to run.
Schedules List<Pulumi.AzureNative.HybridData.Outputs.ScheduleResponse>
Schedule for running the job definition
UserConfirmation string
Enum to detect if user confirmation is required. If not passed will default to NotRequired.
AzureApiVersion string
The Azure API version of the resource.
DataSinkId string
Data Sink Id associated to the job definition.
DataSourceId string
Data Source Id associated to the job definition.
Id string
Id of the object.
Name string
Name of the object.
State string
State of the job definition.
Type string
Type of the object.
CustomerSecrets []CustomerSecretResponse
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
DataServiceInput interface{}
A generic json used differently by each data service type.
LastModifiedTime string
Last modified time of the job definition.
RunLocation string
This is the preferred geo location for the job to run.
Schedules []ScheduleResponse
Schedule for running the job definition
UserConfirmation string
Enum to detect if user confirmation is required. If not passed will default to NotRequired.
azureApiVersion String
The Azure API version of the resource.
dataSinkId String
Data Sink Id associated to the job definition.
dataSourceId String
Data Source Id associated to the job definition.
id String
Id of the object.
name String
Name of the object.
state String
State of the job definition.
type String
Type of the object.
customerSecrets List<CustomerSecretResponse>
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
dataServiceInput Object
A generic json used differently by each data service type.
lastModifiedTime String
Last modified time of the job definition.
runLocation String
This is the preferred geo location for the job to run.
schedules List<ScheduleResponse>
Schedule for running the job definition
userConfirmation String
Enum to detect if user confirmation is required. If not passed will default to NotRequired.
azureApiVersion string
The Azure API version of the resource.
dataSinkId string
Data Sink Id associated to the job definition.
dataSourceId string
Data Source Id associated to the job definition.
id string
Id of the object.
name string
Name of the object.
state string
State of the job definition.
type string
Type of the object.
customerSecrets CustomerSecretResponse[]
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
dataServiceInput any
A generic json used differently by each data service type.
lastModifiedTime string
Last modified time of the job definition.
runLocation string
This is the preferred geo location for the job to run.
schedules ScheduleResponse[]
Schedule for running the job definition
userConfirmation string
Enum to detect if user confirmation is required. If not passed will default to NotRequired.
azure_api_version str
The Azure API version of the resource.
data_sink_id str
Data Sink Id associated to the job definition.
data_source_id str
Data Source Id associated to the job definition.
id str
Id of the object.
name str
Name of the object.
state str
State of the job definition.
type str
Type of the object.
customer_secrets Sequence[CustomerSecretResponse]
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
data_service_input Any
A generic json used differently by each data service type.
last_modified_time str
Last modified time of the job definition.
run_location str
This is the preferred geo location for the job to run.
schedules Sequence[ScheduleResponse]
Schedule for running the job definition
user_confirmation str
Enum to detect if user confirmation is required. If not passed will default to NotRequired.
azureApiVersion String
The Azure API version of the resource.
dataSinkId String
Data Sink Id associated to the job definition.
dataSourceId String
Data Source Id associated to the job definition.
id String
Id of the object.
name String
Name of the object.
state String
State of the job definition.
type String
Type of the object.
customerSecrets List<Property Map>
List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
dataServiceInput Any
A generic json used differently by each data service type.
lastModifiedTime String
Last modified time of the job definition.
runLocation String
This is the preferred geo location for the job to run.
schedules List<Property Map>
Schedule for running the job definition
userConfirmation String
Enum to detect if user confirmation is required. If not passed will default to NotRequired.

Supporting Types

CustomerSecretResponse

Algorithm This property is required. string
The encryption algorithm used to encrypt data.
KeyIdentifier This property is required. string
The identifier to the data service input object which this secret corresponds to.
KeyValue This property is required. string
It contains the encrypted customer secret.
Algorithm This property is required. string
The encryption algorithm used to encrypt data.
KeyIdentifier This property is required. string
The identifier to the data service input object which this secret corresponds to.
KeyValue This property is required. string
It contains the encrypted customer secret.
algorithm This property is required. String
The encryption algorithm used to encrypt data.
keyIdentifier This property is required. String
The identifier to the data service input object which this secret corresponds to.
keyValue This property is required. String
It contains the encrypted customer secret.
algorithm This property is required. string
The encryption algorithm used to encrypt data.
keyIdentifier This property is required. string
The identifier to the data service input object which this secret corresponds to.
keyValue This property is required. string
It contains the encrypted customer secret.
algorithm This property is required. str
The encryption algorithm used to encrypt data.
key_identifier This property is required. str
The identifier to the data service input object which this secret corresponds to.
key_value This property is required. str
It contains the encrypted customer secret.
algorithm This property is required. String
The encryption algorithm used to encrypt data.
keyIdentifier This property is required. String
The identifier to the data service input object which this secret corresponds to.
keyValue This property is required. String
It contains the encrypted customer secret.

ScheduleResponse

Name string
Name of the schedule.
PolicyList List<string>
A list of repetition intervals in ISO 8601 format.
Name string
Name of the schedule.
PolicyList []string
A list of repetition intervals in ISO 8601 format.
name String
Name of the schedule.
policyList List<String>
A list of repetition intervals in ISO 8601 format.
name string
Name of the schedule.
policyList string[]
A list of repetition intervals in ISO 8601 format.
name str
Name of the schedule.
policy_list Sequence[str]
A list of repetition intervals in ISO 8601 format.
name String
Name of the schedule.
policyList List<String>
A list of repetition intervals in ISO 8601 format.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi