ManagementLocks.yml

### YamlMime:TSType
name: ManagementLocks
uid: '@azure/arm-locks.ManagementLocks'
package: '@azure/arm-locks'
summary: Interface representing a ManagementLocks.
fullName: ManagementLocks
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      createOrUpdateAtResourceGroupLevel(string, string, ManagementLockObject,
      ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.createOrUpdateAtResourceGroupLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdateAtResourceGroupLevel(resourceGroupName: string,
        lockName: string, parameters: ManagementLockObject, options?:
        ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group to lock.
        - id: lockName
          type: string
          description: >-
            The lock name. The lock name can be a maximum of 260 characters. It
            cannot contain
                            <, > %, &, :, \, ?, /, or any control characters.
        - id: parameters
          type: <xref uid="@azure/arm-locks.ManagementLockObject" />
          description: The management lock parameters.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      createOrUpdateAtResourceLevel(string, string, string, string, string,
      string, ManagementLockObject,
      ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.createOrUpdateAtResourceLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdateAtResourceLevel(resourceGroupName: string,
        resourceProviderNamespace: string, parentResourcePath: string,
        resourceType: string, resourceName: string, lockName: string,
        parameters: ManagementLockObject, options?:
        ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group containing the resource to lock.
        - id: resourceProviderNamespace
          type: string
          description: The resource provider namespace of the resource to lock.
        - id: parentResourcePath
          type: string
          description: The parent resource identity.
        - id: resourceType
          type: string
          description: The resource type of the resource to lock.
        - id: resourceName
          type: string
          description: The name of the resource to lock.
        - id: lockName
          type: string
          description: >-
            The name of lock. The lock name can be a maximum of 260 characters.
            It cannot
                            contain <, > %, &, :, \, ?, /, or any control characters.
        - id: parameters
          type: <xref uid="@azure/arm-locks.ManagementLockObject" />
          description: Parameters for creating or updating a  management lock.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      createOrUpdateAtSubscriptionLevel(string, ManagementLockObject,
      ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.createOrUpdateAtSubscriptionLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdateAtSubscriptionLevel(lockName: string, parameters:
        ManagementLockObject, options?:
        ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: lockName
          type: string
          description: >-
            The name of lock. The lock name can be a maximum of 260 characters.
            It cannot
                            contain <, > %, &, :, \, ?, /, or any control characters.
        - id: parameters
          type: <xref uid="@azure/arm-locks.ManagementLockObject" />
          description: The management lock parameters.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      createOrUpdateByScope(string, string, ManagementLockObject,
      ManagementLocksCreateOrUpdateByScopeOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.createOrUpdateByScope'
    package: '@azure/arm-locks'
    summary: Create or update a management lock by scope.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdateByScope(scope: string, lockName: string,
        parameters: ManagementLockObject, options?:
        ManagementLocksCreateOrUpdateByScopeOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: scope
          type: string
          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.
        - id: lockName
          type: string
          description: The name of lock.
        - id: parameters
          type: <xref uid="@azure/arm-locks.ManagementLockObject" />
          description: Create or update management lock parameters.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksCreateOrUpdateByScopeOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      deleteAtResourceGroupLevel(string, string,
      ManagementLocksDeleteAtResourceGroupLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.deleteAtResourceGroupLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteAtResourceGroupLevel(resourceGroupName: string, lockName:
        string, options?:
        ManagementLocksDeleteAtResourceGroupLevelOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group containing the lock.
        - id: lockName
          type: string
          description: The name of lock to delete.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksDeleteAtResourceGroupLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      deleteAtResourceLevel(string, string, string, string, string, string,
      ManagementLocksDeleteAtResourceLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.deleteAtResourceLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteAtResourceLevel(resourceGroupName: string,
        resourceProviderNamespace: string, parentResourcePath: string,
        resourceType: string, resourceName: string, lockName: string, options?:
        ManagementLocksDeleteAtResourceLevelOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group containing the resource with the lock
            to
                                     delete.
        - id: resourceProviderNamespace
          type: string
          description: |-
            The resource provider namespace of the resource with the lock to
                                             delete.
        - id: parentResourcePath
          type: string
          description: The parent resource identity.
        - id: resourceType
          type: string
          description: The resource type of the resource with the lock to delete.
        - id: resourceName
          type: string
          description: The name of the resource with the lock to delete.
        - id: lockName
          type: string
          description: The name of the lock to delete.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksDeleteAtResourceLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      deleteAtSubscriptionLevel(string,
      ManagementLocksDeleteAtSubscriptionLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.deleteAtSubscriptionLevel'
    package: '@azure/arm-locks'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteAtSubscriptionLevel(lockName: string, options?:
        ManagementLocksDeleteAtSubscriptionLevelOptionalParams): Promise<void>
      parameters:
        - id: lockName
          type: string
          description: The name of lock to delete.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksDeleteAtSubscriptionLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: deleteByScope(string, string, ManagementLocksDeleteByScopeOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.deleteByScope'
    package: '@azure/arm-locks'
    summary: Delete a management lock by scope.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteByScope(scope: string, lockName: string, options?:
        ManagementLocksDeleteByScopeOptionalParams): Promise<void>
      parameters:
        - id: scope
          type: string
          description: The scope for the lock.
        - id: lockName
          type: string
          description: The name of lock.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksDeleteByScopeOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      getAtResourceGroupLevel(string, string,
      ManagementLocksGetAtResourceGroupLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.getAtResourceGroupLevel'
    package: '@azure/arm-locks'
    summary: Gets a management lock at the resource group level.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getAtResourceGroupLevel(resourceGroupName: string, lockName:
        string, options?: ManagementLocksGetAtResourceGroupLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the locked resource group.
        - id: lockName
          type: string
          description: The name of the lock to get.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksGetAtResourceGroupLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      getAtResourceLevel(string, string, string, string, string, string,
      ManagementLocksGetAtResourceLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.getAtResourceLevel'
    package: '@azure/arm-locks'
    summary: Get the management lock of a resource or any level below resource.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getAtResourceLevel(resourceGroupName: string,
        resourceProviderNamespace: string, parentResourcePath: string,
        resourceType: string, resourceName: string, lockName: string, options?:
        ManagementLocksGetAtResourceLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: resourceProviderNamespace
          type: string
          description: The namespace of the resource provider.
        - id: parentResourcePath
          type: string
          description: An extra path parameter needed in some services, like SQL Databases.
        - id: resourceType
          type: string
          description: The type of the resource.
        - id: resourceName
          type: string
          description: The name of the resource.
        - id: lockName
          type: string
          description: The name of lock.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksGetAtResourceLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      getAtSubscriptionLevel(string,
      ManagementLocksGetAtSubscriptionLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.getAtSubscriptionLevel'
    package: '@azure/arm-locks'
    summary: Gets a management lock at the subscription level.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getAtSubscriptionLevel(lockName: string, options?:
        ManagementLocksGetAtSubscriptionLevelOptionalParams):
        Promise<ManagementLockObject>
      parameters:
        - id: lockName
          type: string
          description: The name of the lock to get.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksGetAtSubscriptionLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: getByScope(string, string, ManagementLocksGetByScopeOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.getByScope'
    package: '@azure/arm-locks'
    summary: Get a management lock by scope.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getByScope(scope: string, lockName: string, options?:
        ManagementLocksGetByScopeOptionalParams): Promise<ManagementLockObject>
      parameters:
        - id: scope
          type: string
          description: The scope for the lock.
        - id: lockName
          type: string
          description: The name of lock.
        - id: options
          type: >-
            <xref uid="@azure/arm-locks.ManagementLocksGetByScopeOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-locks.ManagementLockObject" />&gt;
  - name: >-
      listAtResourceGroupLevel(string,
      ManagementLocksListAtResourceGroupLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.listAtResourceGroupLevel'
    package: '@azure/arm-locks'
    summary: Gets all the management locks for a resource group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listAtResourceGroupLevel(resourceGroupName: string, options?:
        ManagementLocksListAtResourceGroupLevelOptionalParams):
        PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[],
        PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group containing the locks to get.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksListAtResourceGroupLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-locks.ManagementLockObject" />, <xref
          uid="@azure/arm-locks.ManagementLockObject" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: >-
      listAtResourceLevel(string, string, string, string, string,
      ManagementLocksListAtResourceLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.listAtResourceLevel'
    package: '@azure/arm-locks'
    summary: Gets all the management locks for a resource or any level below resource.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listAtResourceLevel(resourceGroupName: string,
        resourceProviderNamespace: string, parentResourcePath: string,
        resourceType: string, resourceName: string, options?:
        ManagementLocksListAtResourceLevelOptionalParams):
        PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[],
        PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group containing the locked resource. The
            name is
                                     case insensitive.
        - id: resourceProviderNamespace
          type: string
          description: The namespace of the resource provider.
        - id: parentResourcePath
          type: string
          description: The parent resource identity.
        - id: resourceType
          type: string
          description: The resource type of the locked resource.
        - id: resourceName
          type: string
          description: The name of the locked resource.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksListAtResourceLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-locks.ManagementLockObject" />, <xref
          uid="@azure/arm-locks.ManagementLockObject" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: >-
      listAtSubscriptionLevel(ManagementLocksListAtSubscriptionLevelOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.listAtSubscriptionLevel'
    package: '@azure/arm-locks'
    summary: Gets all the management locks for a subscription.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listAtSubscriptionLevel(options?:
        ManagementLocksListAtSubscriptionLevelOptionalParams):
        PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[],
        PageSettings>
      parameters:
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksListAtSubscriptionLevelOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-locks.ManagementLockObject" />, <xref
          uid="@azure/arm-locks.ManagementLockObject" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: listByScope(string, ManagementLocksListByScopeOptionalParams)
    uid: '@azure/arm-locks.ManagementLocks.listByScope'
    package: '@azure/arm-locks'
    summary: Gets all the management locks for a scope.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByScope(scope: string, options?:
        ManagementLocksListByScopeOptionalParams):
        PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[],
        PageSettings>
      parameters:
        - id: scope
          type: string
          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.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-locks.ManagementLocksListByScopeOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-locks.ManagementLockObject" />, <xref
          uid="@azure/arm-locks.ManagementLockObject" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;