New-AzResourceLock

Reference

Module:: Az.Resources

Creates a resource lock.

Syntax

New-AzResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -Scope <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceName <String>
   -ResourceType <String>
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzResourceLock
   -LockName <String>
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzResourceLock
   -LockLevel <LockLevel>
   [-LockNotes <String>]
   [-Force]
   -LockId <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzResourceLock cmdlet creates a resource lock.

Examples

Example 1: Create a resource lock on a website

New-AzResourceLock -LockLevel CanNotDelete -LockNotes "My lock notes" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites"

This command creates a resource lock on a website.

Example 2: Create a resource lock on a database

New-AzResourceLock -LockLevel CanNotDelete -LockNotes "Lock note" -LockName "db-lock" -ResourceName "server1/ContosoDB"  -ResourceGroupName "RG1" -ResourceType "Microsoft.Sql/servers/databases"

This command creates a resource lock on a Azure database.

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
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

-LockId

Specifies the ID of the lock.

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

-LockLevel

Specifies the level for the lock. Currently, valid values are CanNotDelete, ReadOnly.

Type:	LockLevel
Aliases:	Level
Accepted values:	CanNotDelete, ReadOnly
Position:	Named
Default value:	None
Accept pipeline input:	True
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
Accept wildcard characters:	False

-LockNotes

Specifies the notes for the lock.

Type:	String
Aliases:	Notes
Position:	Named
Default value:	None
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
Accept pipeline input:	False
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
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
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
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
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

Inputs

String

LockLevel

Outputs

PSObject