New-​Azure​Rm​Resource​Lock

Creates a resource lock.

Syntax

New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -Scope <String>
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [-TenantLevel]
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -ResourceGroupName <String>
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -ResourceGroupName <String>
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -LockId <String>
   [<CommonParameters>]
New-AzureRmResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -LockId <String>
   [<CommonParameters>]

Description

The New-AzureRmResourceLock cmdlet creates a resource lock.

Examples

Example 1: Create a resource lock on a website

PS C:\>New-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "My lock notes" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites"

This command creates a resource lock on a website.

Required Parameters

-LockId

Specifies the ID of the lock.

Type:String
Aliases:Id, ResourceId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-LockName

Specifies the name of the lock.

Type:String
Aliases:ExtensionResourceName, Name
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of a resource group for which the lock applies or that contains the resource group for which the lock applies.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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: ContosoServer/ContosoDatabase

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceType

Specifies the resource type of the resource for which the lock applies.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TenantLevel

Indicates that this cmdlet operates at the tenant level.

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

Optional 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
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
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
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
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

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

Specifies the notes for the lock.

Type:String
Aliases:Notes
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
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
Accept pipeline input:False
Accept wildcard characters:False