< Back
Set-AzureRmResourceLock
Post
NAME Set-AzureRmResourceLock
SYNOPSIS
Modifies a resource lock.
SYNTAX
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockId <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -Scope <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceGroupName <String> [-Confirm]
[-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceGroupName <String> -ResourceName
<String> -ResourceType <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceName <String> -ResourceType
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceName <String> -ResourceType
<String> -TenantLevel [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmResourceLock cmdlet modifies a resource lock.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LockId <String>
Specifies the ID of the lock that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockLevel <LockLevel>
Specifies the level for the lock. Currently, the only valid value is CanNotDelete.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockName <String>
Specifies the name of the lock that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockNotes <String>
Specifies the notes for the lock.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for which the lock applies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceName <String>
Specifies the name of the resource for which the lock applies. For instance, to specify a database, use the following format:
Server`/`Database
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceType <String>
Specifies the resource type for which the lock applies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <String>
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
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TenantLevel [<SwitchParameter>]
Indicates that this cmdlet operates at the tenant level.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sourcelock
Get-AzureRmResourceLock
New-AzureRmResourceLock
Remove-AzureRmResourceLock
SYNOPSIS
Modifies a resource lock.
SYNTAX
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockId <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -Scope <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceGroupName <String> [-Confirm]
[-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceGroupName <String> -ResourceName
<String> -ResourceType <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceName <String> -ResourceType
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmResourceLock [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockLevel <LockLevel> -LockName <String> [-LockNotes <String>] [-Pre] -ResourceName <String> -ResourceType
<String> -TenantLevel [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmResourceLock cmdlet modifies a resource lock.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LockId <String>
Specifies the ID of the lock that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockLevel <LockLevel>
Specifies the level for the lock. Currently, the only valid value is CanNotDelete.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockName <String>
Specifies the name of the lock that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LockNotes <String>
Specifies the notes for the lock.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for which the lock applies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceName <String>
Specifies the name of the resource for which the lock applies. For instance, to specify a database, use the following format:
Server`/`Database
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceType <String>
Specifies the resource type for which the lock applies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <String>
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
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TenantLevel [<SwitchParameter>]
Indicates that this cmdlet operates at the tenant level.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sourcelock
Get-AzureRmResourceLock
New-AzureRmResourceLock
Remove-AzureRmResourceLock