path

Creates, updates, deletes, gets or lists a path resource.

Overview

Name	path
Type	Resource
Id	azure.storage_file_datalake.path

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
lease	exec	x-ms-lease-action, x-ms-version, endpoint	x-ms-client-request-id, timeout, x-ms-lease-break-period, x-ms-lease-id, x-ms-proposed-lease-id, If-Match, If-None-Match, If-Modified-Since, If-Unmodified-Since, x-ms-lease-duration	Lease Path. Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations _.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
x-ms-lease-action	string	There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease. Known values are: "acquire", "break", "change", "renew", and "release". Required.
x-ms-version	string
If-Match	string
If-Modified-Since	string
If-None-Match	string
If-Unmodified-Since	string
timeout	integer	The timeout parameter is expressed in seconds. For more information, see
x-ms-client-request-id	string	Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. Default value is None.
x-ms-lease-break-period	integer	The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds. Default value is None.
x-ms-lease-duration	integer
x-ms-lease-id	string
x-ms-proposed-lease-id	string	Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. Default value is None.

Lifecycle Methods

lease

Lease Path. Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations _.

EXEC azure.storage_file_datalake.path.lease 
@x-ms-lease-action='{{ x-ms-lease-action }}' --required, 
@x-ms-version='{{ x-ms-version }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-request-id='{{ x-ms-client-request-id }}', 
@timeout='{{ timeout }}', 
@x-ms-lease-break-period='{{ x-ms-lease-break-period }}', 
@x-ms-lease-id='{{ x-ms-lease-id }}', 
@x-ms-proposed-lease-id='{{ x-ms-proposed-lease-id }}', 
@If-Match='{{ If-Match }}', 
@If-None-Match='{{ If-None-Match }}', 
@If-Modified-Since='{{ If-Modified-Since }}', 
@If-Unmodified-Since='{{ If-Unmodified-Since }}', 
@x-ms-lease-duration='{{ x-ms-lease-duration }}' 
@@json=
'{
"leaseId": "{{ leaseId }}"
}'
;