Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. appplatform
  5. getJob
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.appplatform.getJob

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Job and its properties. Azure REST API version: 2024-05-01-preview.

Using getJob

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 getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(job_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            service_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appplatform:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Job resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
jobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Job resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
job_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Job resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Job resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.

getJob Result

The following output properties are available:

Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.JobResourcePropertiesResponse
Properties of the Job resource
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties JobResourcePropertiesResponse
Properties of the Job resource
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties JobResourcePropertiesResponse
Properties of the Job resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
properties JobResourcePropertiesResponse
Properties of the Job resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
properties JobResourcePropertiesResponse
Properties of the Job resource
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties Property Map
Properties of the Job resource
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

BuildResultUserSourceInfoResponse

BuildResultId string
Resource id of an existing succeeded build result under the same Spring instance.
Version string
Version of the source
BuildResultId string
Resource id of an existing succeeded build result under the same Spring instance.
Version string
Version of the source
buildResultId String
Resource id of an existing succeeded build result under the same Spring instance.
version String
Version of the source
buildResultId string
Resource id of an existing succeeded build result under the same Spring instance.
version string
Version of the source
build_result_id str
Resource id of an existing succeeded build result under the same Spring instance.
version str
Version of the source
buildResultId String
Resource id of an existing succeeded build result under the same Spring instance.
version String
Version of the source

CustomContainerResponse

Args List<string>
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Command List<string>
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
ContainerImage string
Container image of the custom container. This should be in the form of : without the server name of the registry
ImageRegistryCredential Pulumi.AzureNative.AppPlatform.Inputs.ImageRegistryCredentialResponse
Credential of the image registry
LanguageFramework string
Language framework of the container image uploaded. Supported values: "springboot", "", null.
Server string
The name of the registry that contains the container image
Args []string
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Command []string
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
ContainerImage string
Container image of the custom container. This should be in the form of : without the server name of the registry
ImageRegistryCredential ImageRegistryCredentialResponse
Credential of the image registry
LanguageFramework string
Language framework of the container image uploaded. Supported values: "springboot", "", null.
Server string
The name of the registry that contains the container image
args List<String>
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command List<String>
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
containerImage String
Container image of the custom container. This should be in the form of : without the server name of the registry
imageRegistryCredential ImageRegistryCredentialResponse
Credential of the image registry
languageFramework String
Language framework of the container image uploaded. Supported values: "springboot", "", null.
server String
The name of the registry that contains the container image
args string[]
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command string[]
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
containerImage string
Container image of the custom container. This should be in the form of : without the server name of the registry
imageRegistryCredential ImageRegistryCredentialResponse
Credential of the image registry
languageFramework string
Language framework of the container image uploaded. Supported values: "springboot", "", null.
server string
The name of the registry that contains the container image
args Sequence[str]
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command Sequence[str]
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
container_image str
Container image of the custom container. This should be in the form of : without the server name of the registry
image_registry_credential ImageRegistryCredentialResponse
Credential of the image registry
language_framework str
Language framework of the container image uploaded. Supported values: "springboot", "", null.
server str
The name of the registry that contains the container image
args List<String>
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command List<String>
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
containerImage String
Container image of the custom container. This should be in the form of : without the server name of the registry
imageRegistryCredential Property Map
Credential of the image registry
languageFramework String
Language framework of the container image uploaded. Supported values: "springboot", "", null.
server String
The name of the registry that contains the container image

CustomContainerUserSourceInfoResponse

CustomContainer CustomContainerResponse
Custom container payload
Version string
Version of the source
customContainer CustomContainerResponse
Custom container payload
version String
Version of the source
customContainer CustomContainerResponse
Custom container payload
version string
Version of the source
custom_container CustomContainerResponse
Custom container payload
version str
Version of the source
customContainer Property Map
Custom container payload
version String
Version of the source

EnvVarResponse

Name string
Environment variable name.
SecretValue string
secret environment variable value.
Value string
Non-secret environment variable value.
Name string
Environment variable name.
SecretValue string
secret environment variable value.
Value string
Non-secret environment variable value.
name String
Environment variable name.
secretValue String
secret environment variable value.
value String
Non-secret environment variable value.
name string
Environment variable name.
secretValue string
secret environment variable value.
value string
Non-secret environment variable value.
name str
Environment variable name.
secret_value str
secret environment variable value.
value str
Non-secret environment variable value.
name String
Environment variable name.
secretValue String
secret environment variable value.
value String
Non-secret environment variable value.

ImageRegistryCredentialResponse

Password string
The password of the image registry credential
Username string
The username of the image registry credential
Password string
The password of the image registry credential
Username string
The username of the image registry credential
password String
The password of the image registry credential
username String
The username of the image registry credential
password string
The password of the image registry credential
username string
The username of the image registry credential
password str
The password of the image registry credential
username str
The username of the image registry credential
password String
The password of the image registry credential
username String
The username of the image registry credential

JarUploadedUserSourceInfoResponse

JvmOptions string
JVM parameter
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the Jar file
Version string
Version of the source
JvmOptions string
JVM parameter
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the Jar file
Version string
Version of the source
jvmOptions String
JVM parameter
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the Jar file
version String
Version of the source
jvmOptions string
JVM parameter
relativePath string
Relative path of the storage which stores the source
runtimeVersion string
Runtime version of the Jar file
version string
Version of the source
jvm_options str
JVM parameter
relative_path str
Relative path of the storage which stores the source
runtime_version str
Runtime version of the Jar file
version str
Version of the source
jvmOptions String
JVM parameter
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the Jar file
version String
Version of the source

JobExecutionTemplateResponse

Args List<string>
Arguments for the Job execution.
EnvironmentVariables List<Pulumi.AzureNative.AppPlatform.Inputs.EnvVarResponse>
Environment variables of Job execution
ResourceRequests Pulumi.AzureNative.AppPlatform.Inputs.JobResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
Args []string
Arguments for the Job execution.
EnvironmentVariables []EnvVarResponse
Environment variables of Job execution
ResourceRequests JobResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
args List<String>
Arguments for the Job execution.
environmentVariables List<EnvVarResponse>
Environment variables of Job execution
resourceRequests JobResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
args string[]
Arguments for the Job execution.
environmentVariables EnvVarResponse[]
Environment variables of Job execution
resourceRequests JobResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
args Sequence[str]
Arguments for the Job execution.
environment_variables Sequence[EnvVarResponse]
Environment variables of Job execution
resource_requests JobResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
args List<String>
Arguments for the Job execution.
environmentVariables List<Property Map>
Environment variables of Job execution
resourceRequests Property Map
The requested resource quantity for required CPU and Memory.

JobResourcePropertiesResponse

ProvisioningState This property is required. string
Provisioning state of the Job
ManagedComponentReferences List<Pulumi.AzureNative.AppPlatform.Inputs.ManagedComponentReferenceResponse>
Referenced managed components collection
Source Pulumi.AzureNative.AppPlatform.Inputs.BuildResultUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.CustomContainerUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.JarUploadedUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.NetCoreZipUploadedUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.SourceUploadedUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.UploadedUserSourceInfoResponse | Pulumi.AzureNative.AppPlatform.Inputs.WarUploadedUserSourceInfoResponse
Uploaded source information of the Job.
Template Pulumi.AzureNative.AppPlatform.Inputs.JobExecutionTemplateResponse
The template which is applied for all executions of the Job.
TriggerConfig Pulumi.AzureNative.AppPlatform.Inputs.ManualJobTriggerConfigResponse
The Job trigger related configuration.
provisioningState This property is required. String
Provisioning state of the Job
managedComponentReferences List<Property Map>
Referenced managed components collection
source Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
Uploaded source information of the Job.
template Property Map
The template which is applied for all executions of the Job.
triggerConfig Property Map
The Job trigger related configuration.

JobResourceRequestsResponse

Cpu string
CPU allocated to each job execution instance.
Memory string
Memory allocated to each job execution instance.
Cpu string
CPU allocated to each job execution instance.
Memory string
Memory allocated to each job execution instance.
cpu String
CPU allocated to each job execution instance.
memory String
Memory allocated to each job execution instance.
cpu string
CPU allocated to each job execution instance.
memory string
Memory allocated to each job execution instance.
cpu str
CPU allocated to each job execution instance.
memory str
Memory allocated to each job execution instance.
cpu String
CPU allocated to each job execution instance.
memory String
Memory allocated to each job execution instance.

ManagedComponentReferenceResponse

ResourceId This property is required. string
Resource Id of the managed component
ResourceId This property is required. string
Resource Id of the managed component
resourceId This property is required. String
Resource Id of the managed component
resourceId This property is required. string
Resource Id of the managed component
resource_id This property is required. str
Resource Id of the managed component
resourceId This property is required. String
Resource Id of the managed component

ManualJobTriggerConfigResponse

Parallelism int
Number of parallel replicas of a job execution can run.
RetryLimit int
Maximum number of retries before failing the job.
TimeoutInSeconds int
Maximum number of seconds an execution is allowed to run.
Parallelism int
Number of parallel replicas of a job execution can run.
RetryLimit int
Maximum number of retries before failing the job.
TimeoutInSeconds int
Maximum number of seconds an execution is allowed to run.
parallelism Integer
Number of parallel replicas of a job execution can run.
retryLimit Integer
Maximum number of retries before failing the job.
timeoutInSeconds Integer
Maximum number of seconds an execution is allowed to run.
parallelism number
Number of parallel replicas of a job execution can run.
retryLimit number
Maximum number of retries before failing the job.
timeoutInSeconds number
Maximum number of seconds an execution is allowed to run.
parallelism int
Number of parallel replicas of a job execution can run.
retry_limit int
Maximum number of retries before failing the job.
timeout_in_seconds int
Maximum number of seconds an execution is allowed to run.
parallelism Number
Number of parallel replicas of a job execution can run.
retryLimit Number
Maximum number of retries before failing the job.
timeoutInSeconds Number
Maximum number of seconds an execution is allowed to run.

NetCoreZipUploadedUserSourceInfoResponse

NetCoreMainEntryPath string
The path to the .NET executable relative to zip root
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the .Net file
Version string
Version of the source
NetCoreMainEntryPath string
The path to the .NET executable relative to zip root
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the .Net file
Version string
Version of the source
netCoreMainEntryPath String
The path to the .NET executable relative to zip root
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the .Net file
version String
Version of the source
netCoreMainEntryPath string
The path to the .NET executable relative to zip root
relativePath string
Relative path of the storage which stores the source
runtimeVersion string
Runtime version of the .Net file
version string
Version of the source
net_core_main_entry_path str
The path to the .NET executable relative to zip root
relative_path str
Relative path of the storage which stores the source
runtime_version str
Runtime version of the .Net file
version str
Version of the source
netCoreMainEntryPath String
The path to the .NET executable relative to zip root
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the .Net file
version String
Version of the source

SourceUploadedUserSourceInfoResponse

ArtifactSelector string
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the source file
Version string
Version of the source
ArtifactSelector string
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the source file
Version string
Version of the source
artifactSelector String
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the source file
version String
Version of the source
artifactSelector string
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
relativePath string
Relative path of the storage which stores the source
runtimeVersion string
Runtime version of the source file
version string
Version of the source
artifact_selector str
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
relative_path str
Relative path of the storage which stores the source
runtime_version str
Runtime version of the source file
version str
Version of the source
artifactSelector String
Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project.
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the source file
version String
Version of the source

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 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 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 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 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 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 modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UploadedUserSourceInfoResponse

RelativePath string
Relative path of the storage which stores the source
Version string
Version of the source
RelativePath string
Relative path of the storage which stores the source
Version string
Version of the source
relativePath String
Relative path of the storage which stores the source
version String
Version of the source
relativePath string
Relative path of the storage which stores the source
version string
Version of the source
relative_path str
Relative path of the storage which stores the source
version str
Version of the source
relativePath String
Relative path of the storage which stores the source
version String
Version of the source

WarUploadedUserSourceInfoResponse

JvmOptions string
JVM parameter
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the war file
ServerVersion string
Server version, currently only Apache Tomcat is supported
Version string
Version of the source
JvmOptions string
JVM parameter
RelativePath string
Relative path of the storage which stores the source
RuntimeVersion string
Runtime version of the war file
ServerVersion string
Server version, currently only Apache Tomcat is supported
Version string
Version of the source
jvmOptions String
JVM parameter
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the war file
serverVersion String
Server version, currently only Apache Tomcat is supported
version String
Version of the source
jvmOptions string
JVM parameter
relativePath string
Relative path of the storage which stores the source
runtimeVersion string
Runtime version of the war file
serverVersion string
Server version, currently only Apache Tomcat is supported
version string
Version of the source
jvm_options str
JVM parameter
relative_path str
Relative path of the storage which stores the source
runtime_version str
Runtime version of the war file
server_version str
Server version, currently only Apache Tomcat is supported
version str
Version of the source
jvmOptions String
JVM parameter
relativePath String
Relative path of the storage which stores the source
runtimeVersion String
Runtime version of the war file
serverVersion String
Server version, currently only Apache Tomcat is supported
version String
Version of the source

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native