azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations
name: ManagementLocksOperations
fullName: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations
module: azure.mgmt.resource.locks.v2016_09_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.resource.locks.v2016_09_01.ManagementLockClient>'s\n\
  >\n> <xref:management_locks> attribute.\n>"
constructor:
  syntax: ManagementLocksOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.create_or_update_at_resource_group_level
  name: create_or_update_at_resource_group_level
  summary: '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.'
  signature: '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: resource_group_name
    description: The name of the resource group to lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: 'The lock name. The lock name can be a maximum of 260 characters.
      It cannot

      contain <, > %, &, :, , ?, /, or any control characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The management lock parameters. Is either a ManagementLockObject
      type or a

      IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.create_or_update_at_resource_level
  name: create_or_update_at_resource_level
  summary: '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.'
  signature: '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: resource_group_name
    description: 'The name of the resource group containing the resource to lock.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: resource_provider_namespace
    description: 'The resource provider namespace of the resource to lock.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parent_resource_path
    description: The parent resource identity. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_type
    description: The resource type of the resource to lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the resource to lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: 'The name of lock. The lock name can be a maximum of 260 characters.
      It cannot

      contain <, > %, &, :, , ?, /, or any control characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters for creating or updating a  management lock. Is either
      a

      ManagementLockObject type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.create_or_update_at_subscription_level
  name: create_or_update_at_subscription_level
  summary: '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.'
  signature: 'create_or_update_at_subscription_level(lock_name: str, parameters: _models.ManagementLockObject,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.ManagementLockObject'
  parameters:
  - name: lock_name
    description: 'The name of lock. The lock name can be a maximum of 260 characters.
      It cannot

      contain <, > %, &, :, , ?, /, or any control characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The management lock parameters. Is either a ManagementLockObject
      type or a

      IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.create_or_update_by_scope
  name: create_or_update_by_scope
  summary: Create or update a management lock by scope.
  signature: 'create_or_update_by_scope(scope: str, lock_name: str, parameters: _models.ManagementLockObject,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.ManagementLockObject'
  parameters:
  - name: 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.'
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Create or update management lock parameters. Is either a

      ManagementLockObject type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.delete_at_resource_group_level
  name: delete_at_resource_group_level
  summary: '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.'
  signature: 'delete_at_resource_group_level(resource_group_name: str, lock_name:
    str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group containing the lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of lock to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.delete_at_resource_level
  name: delete_at_resource_level
  summary: '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.'
  signature: '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: resource_group_name
    description: 'The name of the resource group containing the resource with the

      lock to delete. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: resource_provider_namespace
    description: 'The resource provider namespace of the resource with the

      lock to delete. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parent_resource_path
    description: The parent resource identity. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_type
    description: The resource type of the resource with the lock to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the resource with the lock to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of the lock to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.delete_at_subscription_level
  name: delete_at_subscription_level
  summary: '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.'
  signature: 'delete_at_subscription_level(lock_name: str, **kwargs: Any) -> None'
  parameters:
  - name: lock_name
    description: The name of lock to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.delete_by_scope
  name: delete_by_scope
  summary: Delete a management lock by scope.
  signature: 'delete_by_scope(scope: str, lock_name: str, **kwargs: Any) -> None'
  parameters:
  - name: scope
    description: The scope for the lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of lock. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.get_at_resource_group_level
  name: get_at_resource_group_level
  summary: Gets a management lock at the resource group level.
  signature: 'get_at_resource_group_level(resource_group_name: str, lock_name: str,
    **kwargs: Any) -> ManagementLockObject'
  parameters:
  - name: resource_group_name
    description: The name of the locked resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of the lock to get. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.get_at_resource_level
  name: get_at_resource_level
  summary: Get the management lock of a resource or any level below resource.
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_provider_namespace
    description: The namespace of the resource provider. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parent_resource_path
    description: 'An extra path parameter needed in some services, like SQL

      Databases. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: resource_type
    description: The type of the resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of lock. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.get_at_subscription_level
  name: get_at_subscription_level
  summary: Gets a management lock at the subscription level.
  signature: 'get_at_subscription_level(lock_name: str, **kwargs: Any) -> ManagementLockObject'
  parameters:
  - name: lock_name
    description: The name of the lock to get. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.get_by_scope
  name: get_by_scope
  summary: Get a management lock by scope.
  signature: 'get_by_scope(scope: str, lock_name: str, **kwargs: Any) -> ManagementLockObject'
  parameters:
  - name: scope
    description: The scope for the lock. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: lock_name
    description: The name of lock. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagementLockObject or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.list_at_resource_group_level
  name: list_at_resource_group_level
  summary: Gets all the management locks for a resource group.
  signature: 'list_at_resource_group_level(resource_group_name: str, filter: str |
    None = None, **kwargs: Any) -> Iterable[ManagementLockObject]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group containing the locks to get.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: The filter to apply on the operation. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either ManagementLockObject or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.list_at_resource_level
  name: list_at_resource_level
  summary: Gets all the management locks for a resource or any level below resource.
  signature: '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: resource_group_name
    description: 'The name of the resource group containing the locked resource. The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: resource_provider_namespace
    description: The namespace of the resource provider. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parent_resource_path
    description: The parent resource identity. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_type
    description: The resource type of the locked resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the locked resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: The filter to apply on the operation. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either ManagementLockObject or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.list_at_subscription_level
  name: list_at_subscription_level
  summary: Gets all the management locks for a subscription.
  signature: 'list_at_subscription_level(filter: str | None = None, **kwargs: Any)
    -> Iterable[ManagementLockObject]'
  parameters:
  - name: filter
    description: The filter to apply on the operation. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either ManagementLockObject or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.list_by_scope
  name: list_by_scope
  summary: Gets all the management locks for a scope.
  signature: 'list_by_scope(scope: str, filter: str | None = None, **kwargs: Any)
    -> Iterable[ManagementLockObject]'
  parameters:
  - name: 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.'
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: The filter to apply on the operation. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either ManagementLockObject or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.locks.v2016_09_01.models.ManagementLockObject>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations.models
  name: models
  signature: 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'>