ManagementLocksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ManagementLockClient's

<xref:management_locks> attribute.

Inheritance

builtins.object

ManagementLocksOperations

Constructor

ManagementLocksOperations(*args, **kwargs)

Methods

create_or_update_at_resource_group_level	Creates or updates a management lock at the resource group level. 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.
create_or_update_at_resource_level	Creates or updates a management lock at the resource level or any level below the resource. 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.
create_or_update_at_subscription_level	Creates or updates a management lock at the subscription level. 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.
create_or_update_by_scope	Create or update a management lock by scope.
delete_at_resource_group_level	Deletes a management lock at the resource group level. 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.
delete_at_resource_level	Deletes the management lock of a resource or any level below the resource. 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.
delete_at_subscription_level	Deletes the management lock at the subscription level. 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.
delete_by_scope	Delete a management lock by scope.
get_at_resource_group_level	Gets a management lock at the resource group level.
get_at_resource_level	Get the management lock of a resource or any level below resource.
get_at_subscription_level	Gets a management lock at the subscription level.
get_by_scope	Get a management lock by scope.
list_at_resource_group_level	Gets all the management locks for a resource group.
list_at_resource_level	Gets all the management locks for a resource or any level below resource.
list_at_subscription_level	Gets all the management locks for a subscription.
list_by_scope	Gets all the management locks for a scope.

create_or_update_at_resource_group_level

Creates or updates a management lock at the resource group level.

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.

create_or_update_at_resource_group_level(resource_group_name: str, lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ManagementLockObject

Parameters

Name	Description
resource_group_name Required	str The name of the resource group to lock. Required.
lock_name Required	str The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters. Required.
parameters Required	ManagementLockObject or IO[bytes] The management lock parameters. Is either a ManagementLockObject type or a IO[bytes] type. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_at_resource_level

Creates or updates a management lock at the resource level or any level below the resource.

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.

create_or_update_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ManagementLockObject

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing the resource to lock. Required.
resource_provider_namespace Required	str The resource provider namespace of the resource to lock. Required.
parent_resource_path Required	str The parent resource identity. Required.
resource_type Required	str The resource type of the resource to lock. Required.
resource_name Required	str The name of the resource to lock. Required.
lock_name Required	str The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters. Required.
parameters Required	ManagementLockObject or IO[bytes] Parameters for creating or updating a management lock. Is either a ManagementLockObject type or a IO[bytes] type. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_at_subscription_level

Creates or updates a management lock at the subscription level.

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.

create_or_update_at_subscription_level(lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ManagementLockObject

Parameters

Name	Description
lock_name Required	str The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters. Required.
parameters Required	ManagementLockObject or IO[bytes] The management lock parameters. Is either a ManagementLockObject type or a IO[bytes] type. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_by_scope

Create or update a management lock by scope.

create_or_update_by_scope(scope: str, lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ManagementLockObject

Parameters

Name	Description
scope Required	str 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.
lock_name Required	str The name of lock. Required.
parameters Required	ManagementLockObject or IO[bytes] Create or update management lock parameters. Is either a ManagementLockObject type or a IO[bytes] type. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_at_resource_group_level

Deletes a management lock at the resource group level.

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.

delete_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing the lock. Required.
lock_name Required	str The name of lock to delete. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_at_resource_level

Deletes the management lock of a resource or any level below the resource.

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.

delete_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing the resource with the lock to delete. Required.
resource_provider_namespace Required	str The resource provider namespace of the resource with the lock to delete. Required.
parent_resource_path Required	str The parent resource identity. Required.
resource_type Required	str The resource type of the resource with the lock to delete. Required.
resource_name Required	str The name of the resource with the lock to delete. Required.
lock_name Required	str The name of the lock to delete. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_at_subscription_level

Deletes the management lock at the subscription level.

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.

delete_at_subscription_level(lock_name: str, **kwargs: Any) -> None

Parameters

Name	Description
lock_name Required	str The name of lock to delete. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_by_scope

Delete a management lock by scope.

delete_by_scope(scope: str, lock_name: str, **kwargs: Any) -> None

Parameters

Name	Description
scope Required	str The scope for the lock. Required.
lock_name Required	str The name of lock. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_resource_group_level

Gets a management lock at the resource group level.

get_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs: Any) -> ManagementLockObject

Parameters

Name	Description
resource_group_name Required	str The name of the locked resource group. Required.
lock_name Required	str The name of the lock to get. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_resource_level

Get the management lock of a resource or any level below resource.

get_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, **kwargs: Any) -> ManagementLockObject

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
resource_provider_namespace Required	str The namespace of the resource provider. Required.
parent_resource_path Required	str An extra path parameter needed in some services, like SQL Databases. Required.
resource_type Required	str The type of the resource. Required.
resource_name Required	str The name of the resource. Required.
lock_name Required	str The name of lock. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_subscription_level

Gets a management lock at the subscription level.

get_at_subscription_level(lock_name: str, **kwargs: Any) -> ManagementLockObject

Parameters

Name	Description
lock_name Required	str The name of the lock to get. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_scope

Get a management lock by scope.

get_by_scope(scope: str, lock_name: str, **kwargs: Any) -> ManagementLockObject

Parameters

Name	Description
scope Required	str The scope for the lock. Required.
lock_name Required	str The name of lock. Required.

Returns

Type	Description
ManagementLockObject	ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_resource_group_level

Gets all the management locks for a resource group.

list_at_resource_group_level(resource_group_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[ManagementLockObject]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing the locks to get. Required.
filter Required	str The filter to apply on the operation. Default value is None.

Returns

Type	Description
ItemPaged[ManagementLockObject]	An iterator like instance of either ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_resource_level

Gets all the management locks for a resource or any level below resource.

list_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[ManagementLockObject]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing the locked resource. The name is case insensitive. Required.
resource_provider_namespace Required	str The namespace of the resource provider. Required.
parent_resource_path Required	str The parent resource identity. Required.
resource_type Required	str The resource type of the locked resource. Required.
resource_name Required	str The name of the locked resource. Required.
filter Required	str The filter to apply on the operation. Default value is None.

Returns

Type	Description
ItemPaged[ManagementLockObject]	An iterator like instance of either ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_subscription_level

Gets all the management locks for a subscription.

list_at_subscription_level(filter: str | None = None, **kwargs: Any) -> Iterable[ManagementLockObject]

Parameters

Name	Description
filter Required	str The filter to apply on the operation. Default value is None.

Returns

Type	Description
ItemPaged[ManagementLockObject]	An iterator like instance of either ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_scope

Gets all the management locks for a scope.

list_by_scope(scope: str, filter: str | None = None, **kwargs: Any) -> Iterable[ManagementLockObject]

Parameters

Name	Description
scope Required	str 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.
filter Required	str The filter to apply on the operation. Default value is None.

Returns

Type	Description
ItemPaged[ManagementLockObject]	An iterator like instance of either ManagementLockObject or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.resource.locks.v2016_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\locks\\v2016_09_01\\models\\__init__.py'>