Management Locks - Get At Subscription Level
Gets a management lock at the subscription level.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}?api-version=2016-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
lock
|
path | True |
string |
The name of the lock to get. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for the operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK - Returns information about the lock. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get management lock at subscription level
Sample request
GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Authorization/locks/testlock?api-version=2016-09-01
Sample response
{
"properties": {
"level": "ReadOnly"
},
"id": "/providers/Microsoft.Authorization/locks/testlock",
"type": "Microsoft.Authorization/locks",
"name": "testlock"
}
Definitions
Name | Description |
---|---|
Lock |
The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. |
Management |
The lock information. |
Management |
Lock owner properties. |
LockLevel
The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it.
Name | Type | Description |
---|---|---|
CanNotDelete |
string |
|
NotSpecified |
string |
|
ReadOnly |
string |
ManagementLockObject
The lock information.
Name | Type | Description |
---|---|---|
id |
string |
The resource ID of the lock. |
name |
string |
The name of the lock. |
properties.level |
The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. |
|
properties.notes |
string |
Notes about the lock. Maximum of 512 characters. |
properties.owners |
The owners of the lock. |
|
type |
string |
The resource type of the lock - Microsoft.Authorization/locks. |
ManagementLockOwner
Lock owner properties.
Name | Type | Description |
---|---|---|
applicationId |
string |
The application ID of the lock owner. |