files

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

Overview

Name	files
Type	Resource
Id	azure.support.files

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved file details.

Name	Datatype	Description
properties	object	Properties of the resource

list

Successfully retrieved files under a file workspace.

Name	Datatype	Description
properties	object	Properties of the resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	fileWorkspaceName, fileName, subscriptionId		Returns details of a specific file in a work space.
list	select	fileWorkspaceName, subscriptionId		Lists all the Files information under a workspace for an Azure subscription.
create	insert	fileWorkspaceName, fileName, subscriptionId		Creates a new file under a workspace for the specified subscription.
upload	exec	fileWorkspaceName, fileName, subscriptionId		This API allows you to upload content to a file

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
fileName	string	File Name
fileWorkspaceName	string	File WorkspaceName
subscriptionId	string	Azure subscription Id.

SELECT examples

get

Returns details of a specific file in a work space.

SELECT
properties
FROM azure.support.files
WHERE fileWorkspaceName = '{{ fileWorkspaceName }}' -- required
AND fileName = '{{ fileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the Files information under a workspace for an Azure subscription.

SELECT
properties
FROM azure.support.files
WHERE fileWorkspaceName = '{{ fileWorkspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new file under a workspace for the specified subscription.

INSERT INTO azure.support.files (
data__properties,
fileWorkspaceName,
fileName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ fileWorkspaceName }}',
'{{ fileName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: files
  props:
    - name: fileWorkspaceName
      value: string
      description: Required parameter for the files resource.
    - name: fileName
      value: string
      description: Required parameter for the files resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the files resource.
    - name: properties
      value: object
      description: |
        Properties of the resource

Lifecycle Methods

upload

This API allows you to upload content to a file

EXEC azure.support.files.upload 
@fileWorkspaceName='{{ fileWorkspaceName }}' --required, 
@fileName='{{ fileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"content": "{{ content }}", 
"chunkIndex": {{ chunkIndex }}
}'
;