Get-AzResourceLock

  • Reference
Module:
Az.Resources

Gets a resource lock.

Syntax

Get-AzResourceLock
   [-LockName <String>]
   [-AtScope]
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzResourceLock
   [-LockName <String>]
   [-AtScope]
   -ResourceName <String>
   -ResourceType <String>
   -ResourceGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzResourceLock
   [-LockName <String>]
   [-AtScope]
   -Scope <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzResourceLock
   [-LockName <String>]
   [-AtScope]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzResourceLock
   [-LockName <String>]
   [-AtScope]
   -ResourceName <String>
   -ResourceType <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzResourceLock
   [-AtScope]
   -LockId <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzResourceLock cmdlet gets Azure resource locks.

Examples

Example 1: Get a lock

Get-AzResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11"

This command gets the resource lock named ContosoSiteLock.

Example 2: Get locks at resource group level or higher

Get-AzResourceLock -ResourceGroupName "ResourceGroup11" -AtScope

This command gets the resource locks on the resource group or the subscription.

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

-AtScope

Indicates that this cmdlet returns all locks at or above the specified scope. If you do not specify this parameter, the cmdlet returns all locks at, above, or below the scope.

Type:SwitchParameter
Position:Named
Default value:None
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:AzContext, AzureRmContext, AzureCredential
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 gets.

Type:String
Aliases:Id, ResourceId
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 gets.

Type:String
Aliases:ExtensionResourceName, Name
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. This cmdlet gets locks for this resource group.

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 this lock applies. This cmdlet gets locks for this resource.

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

-ResourceType

Specifies the resource type of the resource for which this lock applies. This cmdlet gets locks for this resource.

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. The cmdlet gets locks for this scope.

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

Inputs

String

Outputs

PSObject