Edit

Share via

Set-AzureRmBatchApplication

  • Reference
Module:
AzureRM.Batch

Updates settings for the specified application.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmBatchApplication
   [-AccountName] <String>
   [-ResourceGroupName] <String>
   [-ApplicationId] <String>
   [[-DisplayName] <String>]
   [[-DefaultVersion] <String>]
   [[-AllowUpdates] <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzureRmBatchApplication cmdlet modifies settings for the specified Azure Batch application.

Examples

Example 1: Update an application in a Batch account

PS C:\>Set-AzureRmBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -AllowUpdates $False

This command changes whether the Llitware application in the ContosoBatch account allows updates. The command does not change the default version or display name of the application.

Parameters

-AccountName

Specifies the name of the Batch account for which this cmdlet modifies an application.

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

-AllowUpdates

Specifies whether packages within the application can be overwritten using the same version string.

Type:Nullable<T>[Boolean]
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApplicationId

Specifies the ID of the application.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

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

-DefaultVersion

Specifies which package to use if a client requests the application but does not specify a version.

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

-DisplayName

Specifies the display name for the application.

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

-ResourceGroupName

Specifies the name of the resource group that contains the Batch account.

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

Inputs

String

Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

Void