file_system

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

Overview

Name	file_system
Type	Resource
Id	azure.storage_file_datalake.file_system

Fields

The following fields are returned by SELECT queries:

list_paths

Name	Datatype	Description
paths	array	:vartype paths: list[~azure.storage.filedatalake.models.Path]

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_paths	select	recursive, x-ms-version, endpoint	x-ms-client-request-id, timeout, continuation, directory, maxResults, upn, beginFrom	List Paths. List FileSystem paths and their properties.
create	insert	x-ms-version, endpoint	x-ms-client-request-id, timeout, x-ms-properties	Create FileSystem. Create a FileSystem rooted at the specified location. If the FileSystem already exists, the operation fails. This operation does not support conditional HTTP requests.
delete	delete	x-ms-version, endpoint	x-ms-client-request-id, timeout, If-Modified-Since, If-Unmodified-Since	Delete FileSystem. Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations _.
get_properties	exec	x-ms-version, endpoint	x-ms-client-request-id, timeout	Get FileSystem Properties. All system and user-defined filesystem properties are specified in the response headers.
set_properties	exec	x-ms-version, endpoint	x-ms-client-request-id, timeout, x-ms-properties, If-Modified-Since, If-Unmodified-Since	Set FileSystem Properties. Set properties for the FileSystem. 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: )
recursive	boolean	Required. Required.
x-ms-version	string
If-Modified-Since	string
If-Unmodified-Since	string
beginFrom	string	Optional. A relative path within the specified directory where the listing will start from. For example, a recursive listing under directory folder1/folder2 with beginFrom as folder3/readmefile.txt will start listing from folder1/folder2/folder3/readmefile.txt. Please note that, multiple entity levels are supported for recursive listing. Non-recursive listing supports only one entity level. An error will appear if multiple entity levels are specified for non-recursive listing. Default value is None.
continuation	string	Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. Default value is None.
directory	string	Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist. Default value is None.
maxResults	integer	An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. Default value is None.
timeout	integer	The timeout parameter is expressed in seconds. For more information, see
upn	boolean	Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names. Default value is None.
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-properties	string	Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. Default value is None.

SELECT examples

list_paths

List Paths. List FileSystem paths and their properties.

SELECT
paths
FROM azure.storage_file_datalake.file_system
WHERE recursive = '{{ recursive }}' -- required
AND x-ms-version = '{{ x-ms-version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
AND timeout = '{{ timeout }}'
AND continuation = '{{ continuation }}'
AND directory = '{{ directory }}'
AND maxResults = '{{ maxResults }}'
AND upn = '{{ upn }}'
AND beginFrom = '{{ beginFrom }}'
;

INSERT examples

create

Create FileSystem. Create a FileSystem rooted at the specified location. If the FileSystem already exists, the operation fails. This operation does not support conditional HTTP requests.

INSERT INTO azure.storage_file_datalake.file_system (
x-ms-version,
endpoint,
x-ms-client-request-id,
timeout,
x-ms-properties
)
SELECT 
'{{ x-ms-version }}',
'{{ endpoint }}',
'{{ x-ms-client-request-id }}',
'{{ timeout }}',
'{{ x-ms-properties }}'
;

Manifest

# Description fields are for documentation purposes
- name: file_system
props:
  - name: x-ms-version
    value: "{{ x-ms-version }}"
    description: Required parameter for the file_system resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the file_system resource.
  - name: x-ms-client-request-id
    value: "{{ x-ms-client-request-id }}"
    description: 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.
    description: 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.
  - name: timeout
    value: {{ timeout }}
    description: The timeout parameter is expressed in seconds. For more information, see
    description: The timeout parameter is expressed in seconds. For more information, see
  - name: x-ms-properties
    value: "{{ x-ms-properties }}"
    description: Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. Default value is None.
    description: Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. Default value is None.

DELETE examples

delete

Delete FileSystem. Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations _.

DELETE FROM azure.storage_file_datalake.file_system
WHERE x-ms-version = '{{ x-ms-version }}' --required
AND endpoint = '{{ endpoint }}' --required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
AND timeout = '{{ timeout }}'
AND If-Modified-Since = '{{ If-Modified-Since }}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since }}'
;

Lifecycle Methods

get_properties

Get FileSystem Properties. All system and user-defined filesystem properties are specified in the response headers.

EXEC azure.storage_file_datalake.file_system.get_properties 
@x-ms-version='{{ x-ms-version }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-request-id='{{ x-ms-client-request-id }}', 
@timeout='{{ timeout }}'
;

set_properties

Set FileSystem Properties. Set properties for the FileSystem. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations _.

EXEC azure.storage_file_datalake.file_system.set_properties 
@x-ms-version='{{ x-ms-version }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-request-id='{{ x-ms-client-request-id }}', 
@timeout='{{ timeout }}', 
@x-ms-properties='{{ x-ms-properties }}', 
@If-Modified-Since='{{ If-Modified-Since }}', 
@If-Unmodified-Since='{{ If-Unmodified-Since }}' 
@@json=
'{
"ifModifiedSince": "{{ ifModifiedSince }}", 
"ifUnmodifiedSince": "{{ ifUnmodifiedSince }}", 
"ifMatch": "{{ ifMatch }}", 
"ifNoneMatch": "{{ ifNoneMatch }}"
}'
;