@datafire/azure_resources_locks v5.0.0
@datafire/azure_resources_locks
Client library for ManagementLockClient
Installation and Usage
npm install --save @datafire/azure_resources_locks
let azure_resources_locks = require('@datafire/azure_resources_locks').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Azure resources can be locked to prevent other users in your organization from deleting or modifying resources.
Actions
AuthorizationOperations_List
Lists all of the available Microsoft.Authorization REST API operations.
azure_resources_locks.AuthorizationOperations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: The API version to use for the operation.
- api-version required
Output
- output OperationListResult
ManagementLocks_ListAtSubscriptionLevel
Gets all the management locks for a subscription.
azure_resources_locks.ManagementLocks_ListAtSubscriptionLevel({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- $filter
Output
- output ManagementLockListResult
ManagementLocks_DeleteAtSubscriptionLevel
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.
azure_resources_locks.ManagementLocks_DeleteAtSubscriptionLevel({
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- lockName required
string
: The name of lock to delete. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- lockName required
Output
Output schema unknown
ManagementLocks_GetAtSubscriptionLevel
Gets a management lock at the subscription level.
azure_resources_locks.ManagementLocks_GetAtSubscriptionLevel({
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- lockName required
string
: The name of the lock to get. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- lockName required
Output
- output ManagementLockObject
ManagementLocks_CreateOrUpdateAtSubscriptionLevel
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.
azure_resources_locks.ManagementLocks_CreateOrUpdateAtSubscriptionLevel({
"lockName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- lockName required
string
: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. - parameters required ManagementLockObject
- api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- lockName required
Output
- output ManagementLockObject
ManagementLocks_ListAtResourceGroupLevel
Gets all the management locks for a resource group.
azure_resources_locks.ManagementLocks_ListAtResourceGroupLevel({
"resourceGroupName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the locks to get. - $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockListResult
ManagementLocks_DeleteAtResourceGroupLevel
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.
azure_resources_locks.ManagementLocks_DeleteAtResourceGroupLevel({
"resourceGroupName": "",
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the lock. - lockName required
string
: The name of lock to delete. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
Output schema unknown
ManagementLocks_GetAtResourceGroupLevel
Gets a management lock at the resource group level.
azure_resources_locks.ManagementLocks_GetAtResourceGroupLevel({
"resourceGroupName": "",
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the locked resource group. - lockName required
string
: The name of the lock to get. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockObject
ManagementLocks_CreateOrUpdateAtResourceGroupLevel
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.
azure_resources_locks.ManagementLocks_CreateOrUpdateAtResourceGroupLevel({
"resourceGroupName": "",
"lockName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group to lock. - lockName required
string
: The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. - parameters required ManagementLockObject
- api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockObject
ManagementLocks_ListAtResourceLevel
Gets all the management locks for a resource or any level below resource.
azure_resources_locks.ManagementLocks_ListAtResourceLevel({
"resourceGroupName": "",
"resourceProviderNamespace": "",
"parentResourcePath": "",
"resourceType": "",
"resourceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the locked resource. The name is case insensitive. - resourceProviderNamespace required
string
: The namespace of the resource provider. - parentResourcePath required
string
: The parent resource identity. - resourceType required
string
: The resource type of the locked resource. - resourceName required
string
: The name of the locked resource. - $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockListResult
ManagementLocks_DeleteAtResourceLevel
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.
azure_resources_locks.ManagementLocks_DeleteAtResourceLevel({
"resourceGroupName": "",
"resourceProviderNamespace": "",
"parentResourcePath": "",
"resourceType": "",
"resourceName": "",
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the resource with the lock to delete. - resourceProviderNamespace required
string
: The resource provider namespace of the resource with the lock to delete. - parentResourcePath required
string
: The parent resource identity. - resourceType required
string
: The resource type of the resource with the lock to delete. - resourceName required
string
: The name of the resource with the lock to delete. - lockName required
string
: The name of the lock to delete. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
Output schema unknown
ManagementLocks_GetAtResourceLevel
Get the management lock of a resource or any level below resource.
azure_resources_locks.ManagementLocks_GetAtResourceLevel({
"resourceGroupName": "",
"resourceProviderNamespace": "",
"parentResourcePath": "",
"resourceType": "",
"resourceName": "",
"lockName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - resourceProviderNamespace required
string
: The namespace of the resource provider. - parentResourcePath required
string
: An extra path parameter needed in some services, like SQL Databases. - resourceType required
string
: The type of the resource. - resourceName required
string
: The name of the resource. - lockName required
string
: The name of lock. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockObject
ManagementLocks_CreateOrUpdateAtResourceLevel
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.
azure_resources_locks.ManagementLocks_CreateOrUpdateAtResourceLevel({
"resourceGroupName": "",
"resourceProviderNamespace": "",
"parentResourcePath": "",
"resourceType": "",
"resourceName": "",
"lockName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the resource to lock. - resourceProviderNamespace required
string
: The resource provider namespace of the resource to lock. - parentResourcePath required
string
: The parent resource identity. - resourceType required
string
: The resource type of the resource to lock. - resourceName required
string
: The name of the resource to lock. - lockName required
string
: The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. - parameters required ManagementLockObject
- api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output ManagementLockObject
ManagementLocks_ListByScope
Gets all the management locks for a scope.
azure_resources_locks.ManagementLocks_ListByScope({
"scope": "",
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: 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. - $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation.
- scope required
Output
- output ManagementLockListResult
ManagementLocks_DeleteByScope
Delete a management lock by scope.
azure_resources_locks.ManagementLocks_DeleteByScope({
"scope": "",
"lockName": "",
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: The scope for the lock. - lockName required
string
: The name of lock. - api-version required
string
: The API version to use for the operation.
- scope required
Output
Output schema unknown
ManagementLocks_GetByScope
Get a management lock by scope.
azure_resources_locks.ManagementLocks_GetByScope({
"scope": "",
"lockName": "",
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: The scope for the lock. - lockName required
string
: The name of lock. - api-version required
string
: The API version to use for the operation.
- scope required
Output
- output ManagementLockObject
ManagementLocks_CreateOrUpdateByScope
Create or update a management lock by scope.
azure_resources_locks.ManagementLocks_CreateOrUpdateByScope({
"scope": "",
"lockName": "",
"parameters": null,
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: 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. - lockName required
string
: The name of lock. - parameters required ManagementLockObject
- api-version required
string
: The API version to use for the operation.
- scope required
Output
- output ManagementLockObject
Definitions
ManagementLockListResult
- ManagementLockListResult
object
: The list of locks.- nextLink
string
: The URL to use for getting the next set of results. - value
array
: The list of locks.- items ManagementLockObject
- nextLink
ManagementLockObject
- ManagementLockObject
object
: The lock information.- id
string
: The resource ID of the lock. - name
string
: The name of the lock. - properties required ManagementLockProperties
- type
string
: The resource type of the lock - Microsoft.Authorization/locks.
- id
ManagementLockOwner
- ManagementLockOwner
object
: Lock owner properties.- applicationId
string
: The application ID of the lock owner.
- applicationId
ManagementLockProperties
- ManagementLockProperties
object
: The lock properties.- level required
string
(values: NotSpecified, CanNotDelete, ReadOnly): 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. - notes
string
: Notes about the lock. Maximum of 512 characters. - owners
array
: The owners of the lock.- items ManagementLockOwner
- level required
Operation
- Operation
object
: Microsoft.Authorization operation- display
object
: The object that represents the operation.- operation
string
: Operation type: Read, write, delete, etc. - provider
string
: Service provider: Microsoft.Authorization - resource
string
: Resource on which the operation is performed: Profile, endpoint, etc.
- operation
- name
string
: Operation name: {provider}/{resource}/{operation}
- display
OperationListResult
- OperationListResult
object
: Result of the request to list Microsoft.Authorization operations. It contains a list of operations and a URL link to get the next set of results.- nextLink
string
: URL to get the next set of operation list results if there are any. - value
array
: List of Microsoft.Authorization operations.- items Operation
- nextLink