Edit

Share via

Update-AzContainerAppJob

  • Reference
Module:
Az.App

Patches a Container Apps Job using JSON Merge Patch

Syntax

Update-AzContainerAppJob
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ConfigurationRegistry <IRegistryCredentials[]>]
      [-ConfigurationReplicaRetryLimit <Int32>]
      [-ConfigurationReplicaTimeout <Int32>]
      [-ConfigurationSecret <ISecret[]>]
      [-ConfigurationTriggerType <String>]
      [-EnvironmentId <String>]
      [-EventStreamEndpoint <String>]
      [-EventTriggerConfigParallelism <Int32>]
      [-EventTriggerConfigReplicaCompletionCount <Int32>]
      [-IdentityType <String>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-ManualTriggerConfigParallelism <Int32>]
      [-ManualTriggerConfigReplicaCompletionCount <Int32>]
      [-OutboundIPAddress <String[]>]
      [-ScaleMaxExecution <Int32>]
      [-ScaleMinExecution <Int32>]
      [-ScalePollingInterval <Int32>]
      [-ScaleRule <IJobScaleRule[]>]
      [-ScheduleTriggerConfigCronExpression <String>]
      [-ScheduleTriggerConfigParallelism <Int32>]
      [-ScheduleTriggerConfigReplicaCompletionCount <Int32>]
      [-Tag <Hashtable>]
      [-TemplateContainer <IContainer[]>]
      [-TemplateInitContainer <IInitContainer[]>]
      [-TemplateVolume <IVolume[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzContainerAppJob
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzContainerAppJob
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzContainerAppJob
      -InputObject <IAppIdentity>
      [-ConfigurationRegistry <IRegistryCredentials[]>]
      [-ConfigurationReplicaRetryLimit <Int32>]
      [-ConfigurationReplicaTimeout <Int32>]
      [-ConfigurationSecret <ISecret[]>]
      [-ConfigurationTriggerType <String>]
      [-EnvironmentId <String>]
      [-EventStreamEndpoint <String>]
      [-EventTriggerConfigParallelism <Int32>]
      [-EventTriggerConfigReplicaCompletionCount <Int32>]
      [-IdentityType <String>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-ManualTriggerConfigParallelism <Int32>]
      [-ManualTriggerConfigReplicaCompletionCount <Int32>]
      [-OutboundIPAddress <String[]>]
      [-ScaleMaxExecution <Int32>]
      [-ScaleMinExecution <Int32>]
      [-ScalePollingInterval <Int32>]
      [-ScaleRule <IJobScaleRule[]>]
      [-ScheduleTriggerConfigCronExpression <String>]
      [-ScheduleTriggerConfigParallelism <Int32>]
      [-ScheduleTriggerConfigReplicaCompletionCount <Int32>]
      [-Tag <Hashtable>]
      [-TemplateContainer <IContainer[]>]
      [-TemplateInitContainer <IInitContainer[]>]
      [-TemplateVolume <IVolume[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Patches a Container Apps Job using JSON Merge Patch

Examples

Example 1: Update container app job.

$EnvId = (Get-AzContainerAppManagedEnv -ResourceGroupName azps_test_group_app -Name azps-env).Id
$probeHttpGetHttpHeader = New-AzContainerAppProbeHeaderObject -Name "Custom-Header" -Value "Awesome"
$probe = New-AzContainerAppProbeObject -Type "Liveness" -HttpGetPath "/health" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -HttpGetHttpHeader $probeHttpGetHttpHeader
$temp = New-AzContainerAppTemplateObject -Image "mcr.microsoft.com/k8se/quickstart:latest" -Name "simple-hello-world-container" -Probe $probe -ResourceCpu 0.25 -ResourceMemory "0.5Gi"

Update-AzContainerAppJob -Name azps-app-job -ResourceGroupName azps_test_group_app -ConfigurationReplicaRetryLimit 10 -ConfigurationReplicaTimeout 10 -ConfigurationTriggerType Manual -EnvironmentId $EnvId -ManualTriggerConfigParallelism 4 -ManualTriggerConfigReplicaCompletionCount 1 -TemplateContainer $temp

Location Name         ProvisioningState ResourceGroupName
-------- ----         ----------------- -----------------
East US  azps-app-job Succeeded         azps_test_group_app

Update container app job.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationRegistry

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

Type:IRegistryCredentials[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationReplicaRetryLimit

Maximum number of retries before failing the job.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationReplicaTimeout

Maximum number of seconds a replica is allowed to run.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationSecret

Collection of secrets used by a Container Apps Job

Type:ISecret[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationTriggerType

Trigger type of the job

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnvironmentId

Resource ID of environment.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventStreamEndpoint

The endpoint of the eventstream of the container apps job.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventTriggerConfigParallelism

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IAppIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JsonFilePath

Path of Json file supplied to the Update operation

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-JsonString

Json string supplied to the Update operation

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ManualTriggerConfigParallelism

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManualTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Job Name

Type:String
Aliases:JobName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutboundIPAddress

Outbound IP Addresses of a container apps job.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ScaleMaxExecution

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScaleMinExecution

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScalePollingInterval

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScaleRule

Scaling rules.

Type:IJobScaleRule[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleTriggerConfigCronExpression

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleTriggerConfigParallelism

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleTriggerConfigReplicaCompletionCount

Minimum number of successful replica completions before overall job completion.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateContainer

List of container definitions for the Container App.

Type:IContainer[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateInitContainer

List of specialized containers that run before app containers.

Type:IInitContainer[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateVolume

List of volume definitions for the Container App.

Type:IVolume[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IAppIdentity

Outputs

IJob