{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-resources-locks","description":"ManagementLockClient","version":"2016-09-01","base_url":"https://management.azure.com","endpoints":17,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ManagementLockClient\n@base https://management.azure.com\n@version 2016-09-01\n@auth OAuth2\n@common_fields {api-version: any # The API version to use for the operation.}\n@endpoints 17\n@toc providers(1), subscriptions(12), {scope}(4)\n\n@group providers\n@endpoint GET /providers/Microsoft.Authorization/operations\n@desc Lists all of the available Microsoft.Authorization REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group subscriptions\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Creates or updates a management lock at the resource group level.\n@required {resourceGroupName: any # The name of the resource group to lock., lockName: any # The lock name. The lock name can be a maximum of 260 characters. It cannot contain  %, &, :, \\, ?, /, or any control characters., parameters: any # The management lock parameters., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK - Returns information about the lock.\n@returns(201) Created - Returns information about the lock.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Deletes a management lock at the resource group level.\n@required {resourceGroupName: any # The name of the resource group containing the lock., lockName: any # The name of lock to delete., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK\n@returns(204) NoContent\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Gets a management lock at the resource group level.\n@required {resourceGroupName: any # The name of the locked resource group., lockName: any # The name of the lock to get., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK - Returns information about the lock.\n\n@endgroup\n\n@group {scope}\n@endpoint PUT /{scope}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Create or update a management lock by scope.\n@required {scope: any # 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: any # The name of lock., parameters: any # Create or update management lock parameters.}\n@returns(200) OK\n@returns(201) Created\n\n@endpoint DELETE /{scope}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Delete a management lock by scope.\n@required {scope: any # The scope for the lock., lockName: any # The name of lock.}\n@returns(200) OK\n@returns(204) NoContent\n\n@endpoint GET /{scope}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Get a management lock by scope.\n@required {scope: any # The scope for the lock., lockName: any # The name of lock.}\n@returns(200) OK\n\n@endgroup\n\n@group subscriptions\n@endpoint PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Creates or updates a management lock at the resource level or any level below the resource.\n@required {resourceGroupName: any # The name of the resource group containing the resource to lock., resourceProviderNamespace: any # The resource provider namespace of the resource to lock., parentResourcePath: any # The parent resource identity., resourceType: any # The resource type of the resource to lock., resourceName: any # The name of the resource to lock., lockName: any # The name of lock. The lock name can be a maximum of 260 characters. It cannot contain  %, &, :, \\, ?, /, or any control characters., parameters: any # Parameters for creating or updating a  management lock., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK - Returns information about the lock.\n@returns(201) Created - Returns information about the lock.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Deletes the management lock of a resource or any level below the resource.\n@required {resourceGroupName: any # The name of the resource group containing the resource with the lock to delete., resourceProviderNamespace: any # The resource provider namespace of the resource with the lock to delete., parentResourcePath: any # The parent resource identity., resourceType: any # The resource type of the resource with the lock to delete., resourceName: any # The name of the resource with the lock to delete., lockName: any # The name of the lock to delete., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK\n@returns(204) NoContent\n\n@endpoint GET /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Get the management lock of a resource or any level below resource.\n@required {resourceGroupName: any # The name of the resource group., resourceProviderNamespace: any # The namespace of the resource provider., parentResourcePath: any # An extra path parameter needed in some services, like SQL Databases., resourceType: any # The type of the resource., resourceName: any # The name of the resource., lockName: any # The name of lock., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Creates or updates a management lock at the subscription level.\n@required {lockName: any # The name of lock. The lock name can be a maximum of 260 characters. It cannot contain  %, &, :, \\, ?, /, or any control characters., parameters: any # The management lock parameters., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK - Returns information about the lock.\n@returns(201) Created - Returns information about the lock.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Deletes the management lock at the subscription level.\n@required {lockName: any # The name of lock to delete., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK\n@returns(204) NoContent\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}\n@desc Gets a management lock at the subscription level.\n@required {lockName: any # The name of the lock to get., subscriptionId: any # The ID of the target subscription.}\n@returns(200) OK - Returns information about the lock.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks\n@desc Gets all the management locks for a resource group.\n@required {resourceGroupName: any # The name of the resource group containing the locks to get., subscriptionId: any # The ID of the target subscription.}\n@optional {$filter: any # The filter to apply on the operation.}\n@returns(200) OK - Returns an array of resource locks.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks\n@desc Gets all the management locks for a resource or any level below resource.\n@required {resourceGroupName: any # The name of the resource group containing the locked resource. The name is case insensitive., resourceProviderNamespace: any # The namespace of the resource provider., parentResourcePath: any # The parent resource identity., resourceType: any # The resource type of the locked resource., resourceName: any # The name of the locked resource., subscriptionId: any # The ID of the target subscription.}\n@optional {$filter: any # The filter to apply on the operation.}\n@returns(200) OK - Returns an array of resource locks.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks\n@desc Gets all the management locks for a subscription.\n@required {subscriptionId: any # The ID of the target subscription.}\n@optional {$filter: any # The filter to apply on the operation.}\n@returns(200) OK - Returns an array of resource locks.\n\n@endgroup\n\n@group {scope}\n@endpoint GET /{scope}/providers/Microsoft.Authorization/locks\n@desc Gets all the management locks for a scope.\n@required {scope: any # 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.}\n@optional {$filter: any # The filter to apply on the operation.}\n@returns(200) OK - Returns an array of resource locks.\n\n@endgroup\n\n@end\n"}