< Back
Get-AzureRmResourceLock
Post
NAME Get-AzureRmResourceLock
SYNOPSIS
Gets a resource lock.
SYNTAX
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockId <String> [-Pre] [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceGroupName <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceGroupName <String> -ResourceName <String> -ResourceType <String>
[<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -Scope <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceName <String> -ResourceType <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceName <String> -ResourceType <String> -TenantLevel [<CommonParameters>]
DESCRIPTION
The Get-AzureRmResourceLock cmdlet gets Azure resource locks.
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
-AtScope [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
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
-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 gets.
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 gets.
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. This cmdlet gets locks for this resource group.
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 this lock applies. This cmdlet gets locks for this resource.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceType <String>
Specifies the resource type of the resource for which this lock applies. This cmdlet gets locks for this resource.
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. The cmdlet gets locks for this scope.
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
<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: Get a lock
PS C:\\>Get-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName
"ResourceGroup11"
This command gets the resource lock named ContosoSiteLock.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sourcelock
New-AzureRmResourceLock
Remove-AzureRmResourceLock
Set-AzureRmResourceLock
SYNOPSIS
Gets a resource lock.
SYNTAX
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -LockId <String> [-Pre] [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceGroupName <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceGroupName <String> -ResourceName <String> -ResourceType <String>
[<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -Scope <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceName <String> -ResourceType <String> [<CommonParameters>]
Get-AzureRmResourceLock [-ApiVersion <String>] [-AtScope] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-LockName <String>] [-Pre] -ResourceName <String> -ResourceType <String> -TenantLevel [<CommonParameters>]
DESCRIPTION
The Get-AzureRmResourceLock cmdlet gets Azure resource locks.
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
-AtScope [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
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
-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 gets.
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 gets.
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. This cmdlet gets locks for this resource group.
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 this lock applies. This cmdlet gets locks for this resource.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceType <String>
Specifies the resource type of the resource for which this lock applies. This cmdlet gets locks for this resource.
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. The cmdlet gets locks for this scope.
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
<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: Get a lock
PS C:\\>Get-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName
"ResourceGroup11"
This command gets the resource lock named ContosoSiteLock.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sourcelock
New-AzureRmResourceLock
Remove-AzureRmResourceLock
Set-AzureRmResourceLock