Share via


Job Class

Definition

Container App Job

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.JobTypeConverter))]
public class Job : Microsoft.Azure.PowerShell.Cmdlets.App.Models.IJob, Microsoft.Azure.PowerShell.Cmdlets.App.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.JobTypeConverter))>]
type Job = class
    interface IJob
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class Job
Implements IJob, IValidates
Inheritance
Job
Attributes
Implements

Constructors

Job()

Creates an new Job instance.

Properties

ConfigurationRegistry

Collection of private container registry credentials used by a Container apps job

ConfigurationReplicaRetryLimit

Maximum number of retries before failing the job.

ConfigurationReplicaTimeout

Maximum number of seconds a replica is allowed to run.

ConfigurationSecret

Collection of secrets used by a Container Apps Job

ConfigurationTriggerType

Trigger type of the job

EnvironmentId

Resource ID of environment.

EventStreamEndpoint

The endpoint of the eventstream of the container apps job.

EventTriggerConfigParallelism

Number of parallel replicas of a job that can run at a given time.

EventTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IdentityPrincipalId

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityTenantId

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

IdentityUserAssignedIdentity

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

Location

The geo-location where the resource lives

ManualTriggerConfigParallelism

Number of parallel replicas of a job that can run at a given time.

ManualTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

Name

The name of the resource

OutboundIPAddress

Outbound IP Addresses of a container apps job.

ProvisioningState

Provisioning state of the Container Apps Job.

ResourceGroupName

Gets the resource group name

ScaleMaxExecution

Maximum number of job executions that are created for a trigger, default 100.

ScaleMinExecution

Minimum number of job executions that are created for a trigger, default 0

ScalePollingInterval

Interval to check each event source in seconds. Defaults to 30s

ScaleRule

Scaling rules.

ScheduleTriggerConfigCronExpression

Cron formatted repeating schedule ("* * * * *") of a Cron Job.

ScheduleTriggerConfigParallelism

Number of parallel replicas of a job that can run at a given time.

ScheduleTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

TemplateContainer

List of container definitions for the Container App.

TemplateInitContainer

List of specialized containers that run before app containers.

TemplateVolume

List of volume definitions for the Container App.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkloadProfileName

Workload profile name to pin for container apps job execution.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Job.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Job.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.App.Models.IJob.

FromJsonString(String)

Creates a new instance of Job, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Job into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to