Set-AzureRmResourceLock

Module:

AzureRM.Resources

Modifies a resource lock.

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-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -Scope <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceName <String>
   -ResourceType <String>
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceName <String>
   -ResourceType <String>
   [-TenantLevel]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockId <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmResourceLock cmdlet modifies a resource lock.

Examples

Example 1: Update notes for a lock

PS C:\>Set-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "Updated note" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11"

This command updates the note for a lock named ContosoSiteLock.

Parameters

-ApiVersion

Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.

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:	False
Required:	False
Accept pipeline input:	False
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

-Force

Forces the command to run without asking for user confirmation.

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

-InformationAction

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

• Continue
• Ignore
• Inquire
• SilentlyContinue
• Stop
• Suspend

Type:	ActionPreference
Aliases:	infa
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationVariable

Specifies an information variable.

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

-LockId

Specifies the ID of the lock that this cmdlet modifies.

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

-LockLevel

Specifies the level for the lock. Currently, the only valid value is CanNotDelete.

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

-LockName

Specifies the name of the lock that this cmdlet modifies.

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

-LockNotes

Specifies the notes for the lock.

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

-Pre

Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.

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

-ResourceGroupName

Specifies the name of the resource group for which the lock applies.

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

-ResourceName

Specifies the name of the resource for which the lock applies. For instance, to specify a database, use the following format: Server/Database

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

-ResourceType

Specifies the resource type for which the lock applies.

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

-Scope

Specifies the scope to which the lock applies. For instance, to specify a database, use the following format: /subscriptions/subscription ID/resourceGroups/resource group name/providers/Microsoft.Sql/servers/server name/databases/database name To specify a resource group, use the following format: /subscriptions/subscription ID/resourceGroups/resource group name

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

-TenantLevel

Indicates that this cmdlet operates at the tenant level.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
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:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Related Links

• Get-AzureRmResourceLock
• New-AzureRmResourceLock
• Remove-AzureRmResourceLock