Microsoft.Authorization (stable:2017-04-01)

2025/12/05 • 17 new, 17 deleted methods

AuthorizationOperations_List (new)
Description :  Lists all of the available Microsoft.Authorization REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/operations
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Authorization operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Authorization ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtResourceGroupLevel (new)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group to lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: The management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtResourceGroupLevel (new)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtResourceGroupLevel (new)
Description :  Gets a management lock at the resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the locked resource group. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of the lock to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateByScope (new)
Description :  Create or update a management lock by scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteByScope (new)
Description :  Delete a management lock by scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetByScope (new)
Description :  Get a management lock by scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtResourceLevel (new)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to lock. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider namespace of the resource to lock. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to lock. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating a management lock. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtResourceLevel (new)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource with the lock to delete. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider namespace of the resource with the lock to delete. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource with the lock to delete. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource with the lock to delete. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of the lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtResourceLevel (new)
Description :  Get the management lock of a resource or any level below resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: An extra path parameter needed in some services, like SQL Databases. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtSubscriptionLevel (new)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: The management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtSubscriptionLevel (new)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtSubscriptionLevel (new)
Description :  Gets a management lock at the subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of the lock to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtResourceGroupLevel (new)
Description :  Gets all the management locks for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks
{
resourceGroupName:
{
Description: The name of the resource group containing the locks to get. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtResourceLevel (new)
Description :  Gets all the management locks for a resource or any level below resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks
{
resourceGroupName:
{
Description: The name of the resource group containing the locked resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the locked resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the locked resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtSubscriptionLevel (new)
Description :  Gets all the management locks for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListByScope (new)
Description :  Gets all the management locks for a scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/locks
{
scope:
{
Description: The scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationOperations_List (removed)
Description :  Lists all of the available Microsoft.Authorization REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/operations
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Authorization operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Authorization ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtResourceGroupLevel (removed)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group to lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: The management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtResourceGroupLevel (removed)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtResourceGroupLevel (removed)
Description :  Gets a management lock at the resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the locked resource group. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of the lock to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateByScope (removed)
Description :  Create or update a management lock by scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteByScope (removed)
Description :  Delete a management lock by scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetByScope (removed)
Description :  Get a management lock by scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/locks/{lockName}
{
scope:
{
Description: The scope for the lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtResourceLevel (removed)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to lock. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider namespace of the resource to lock. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to lock. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to lock. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating a management lock. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtResourceLevel (removed)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource with the lock to delete. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider namespace of the resource with the lock to delete. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource with the lock to delete. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource with the lock to delete. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of the lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtResourceLevel (removed)
Description :  Get the management lock of a resource or any level below resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: An extra path parameter needed in some services, like SQL Databases. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
lockName:
{
Description: The name of lock. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_CreateOrUpdateAtSubscriptionLevel (removed)
Description :  When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. ,
Required: True ,
}
string ,
parameters:
{
Description: The management lock parameters. ,
Required: True ,
}
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_DeleteAtSubscriptionLevel (removed)
Description :  To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of lock to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_GetAtSubscriptionLevel (removed)
Description :  Gets a management lock at the subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}
{
lockName:
{
Description: The name of the lock to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtResourceGroupLevel (removed)
Description :  Gets all the management locks for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks
{
resourceGroupName:
{
Description: The name of the resource group containing the locks to get. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtResourceLevel (removed)
Description :  Gets all the management locks for a resource or any level below resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks
{
resourceGroupName:
{
Description: The name of the resource group containing the locked resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the locked resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the locked resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListAtSubscriptionLevel (removed)
Description :  Gets all the management locks for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementLocks_ListByScope (removed)
Description :  Gets all the management locks for a scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/locks
{
scope:
{
Description: The scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of locks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the lock. ,
Required: True ,
}
{
level:
{
Description: 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. ,
Enum:
{
NotSpecified: No description available. ,
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
}
,
Required: True ,
}
enum ,
notes:
{
Description: Notes about the lock. Maximum of 512 characters. ,
Required: False ,
}
string ,
owners:
{
Description: The owners of the lock. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application ID of the lock owner. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The resource ID of the lock. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the lock - Microsoft.Authorization/locks. ,
Required: False ,
}
string ,
name:
{
Description: The name of the lock. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}