Skip to content

Microsoft Azure Data Lake Storage Connector Reference

The following operations allow you to work with the Microsoft Azure Data Lake Storage Connector. Click an operation name to see parameter details and samples on how to use it.


Initialize the connector

To use the Microsoft Azure Data Lake Storage connector, you need to initialize the configuration before carrying out any other Microsoft Azure Data Lake Storage operations.

To use the Microsoft Azure Storage connector, add the element in your configuration before carrying out any Azure Data Lake Storage operations. This Microsoft Azure Data Lake Storage configuration authenticates with Microsoft Azure Data Lake Storage by Access Key, Azure Active Directory(Oauth2), or Shared Access Signature(SAS) which are used for every operation.

Note: To work with the Microsoft Azure Data Lake Storage connector, you need to create a Storage Account in Microsoft Azure Data Lake Storage account. See Azure Storage Configuration documentation for more information.

MSAzureDataLake

The init operation is used to initialize the connection to Microsoft Azure.

Parameter Name Description Required
accountName The name of the Azure Data Lake storage account. Yes
accessType The method for accessing the Azure Data Lake storage account.(Access Key, Shared Access Signature, OAuth2) Yes
If you are using the Access Key method,
Parameter Name Description Required
accountKey The access key of the Azure Data Lake storage account. Yes
If you are using the OAuth2 method,
Parameter Name Description Required
clientId The client ID of the application. Yes
clientSecret The client secret of the application. Yes
tenantId The tenant ID of the application. Yes
If you are using the Shared Access Signature method,
Parameter Name Description Required
sasToken The sas token of the storage. Yes

Sample configuration

<msazuredatalakestorage.init>
    <accountName>{${payload.accountName}}</accountName>
    <accountKey>{${payload.accountKey}}</accountKey>
</msazuredatalakestorage.init>

File Systems

createFileSystem

The createFileSystem operation creates a file system into the storage. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName he name of the file system. Yes
timeout The timeout for the operation. No
metadata The path to the file to be uploaded. No
responseVariable Name of the variable to which the output of the operation should be assigned. No
overwriteBody Replace the Message Body in Message Context with the response of the operation. No

Sample configuration

<msazuredatalakestorage.createFileSystem configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <timeout></timeout>
    <metadata>[]</metadata>
    <accessType>NONE</accessType>
    <responseVariable>msazuredatalakestorage_createFileSystem_1</responseVariable>
    <overwriteBody>true</overwriteBody>
</msazuredatalakestorage.createFileSystem>

Sample request

{
    "fileSystemName": "customer-behavior-analytics"
}
deleteFileSystem

The deleteFileSystem operation delete the file system. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
responseVariable Name of the variable to which the output of the operation should be assigned No
overwriteBody Replace the Message Body in Message Context with the response of the operation. No
timeout The timeout for the operation. No
leaseId The lease ID of the file system. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.deleteFileSystem configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <responseVariable>msazuredatalakestorage_deleteFileSystem_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
</msazuredatalakestorage.deleteFileSystem>

Sample request

{
    "fileSystemName": "customer-behavior-analytics"
}
listFileSystems

The listFileSystems operation retrives all file systems from the storage. See the related API documentation for more information.

Parameter Name Description Required
responseVariable The name of the container. No
overwriteBody Replace the Message Body in Message Context with the response of the operation. No
retrieveMetadata Whether to retrieve metadata. No
retrieveDeleted Whether to retrieve deleted file systems. No
prefix The prefix of the file system name. No
timeout The timeout for the operation. No
maxResultsPerPage The maximum number of results per page. No

Sample configuration

<msazuredatalakestorage.listFileSystems configKey="con1">
    <responseVariable>msazuredatalakestorage_listFileSystems_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <retrieveMetadata>false</retrieveMetadata>
    <retrieveDeleted>false</retrieveDeleted>
    <maxResultsPerPage></maxResultsPerPage>
    <prefix></prefix>
    <timeout></timeout>
</msazuredatalakestorage.listFileSystems>

Directories

createDirectory

The createDirectory operation creates a directory in the storage. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
directoryName The name of the directory. Yes
responseVariable Name of the variable to which the output of the operation should be assigned No
overwriteBody Replace the Message Body in Message Context with the response of the operation. No
metadata The metadata to the directory. No
timeout The timeout for the operation. No
contentLanguage The language of the content. No
contentType The MIME content type of the content. No
contentEncoding Defines the encoding type. No
contentDisposition The value of the Content-Disposition response header. No
cacheControl The value of the Cache-Control response header. No
permissions The permissions of the directory. No
umask The umask of the directory. No
sourceLeaseId The lease ID of the source directory. No
group The group of the directory. No
owner The owner of the directory. No

Sample configuration

<msazuredatalakestorage.createDirectory configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <directoryName>{${payload.directoryName}}</directoryName>
    <responseVariable>msazuredatalakestorage_createDirectory_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <metadata>[]</metadata>
    <timeout></timeout>
    <contentLanguage></contentLanguage>
    <contentType></contentType>
    <contentEncoding></contentEncoding>
    <contentDisposition></contentDisposition>
    <cacheControl></cacheControl>
    <permissions></permissions>
    <umask></umask>
    <sourceLeaseId></sourceLeaseId>
    <group></group>
    <owner></owner>
</msazuredatalakestorage.createDirectory>

Sample request

{
    "fileSystemName": "sales",
    "directoryName": "section1/marketing",
}
deleteDirectory

The deleteDirectory operation deletes a directory from the storage. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
directoryName The name of the directory to be deleted. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
recursive Delete the contents of the directory. Yes
leaseId The lease ID of the directory. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.deleteDirectory configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <directoryName>{${payload.directoryName}}</directoryName>
    <responseVariable>msazuredatalakestorage_deleteDirectory_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <recursive>true</recursive>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
</msazuredatalakestorage.deleteDirectory>

Sample request

{
    "fileSystemName": "sales",
    "directoryName": "section1/marketing"
}

Files

readFile

The readFile operation retrives the file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePath The path of the file. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
count The number of bytes to read. No
offset The offset to start reading from. No
maxRetryRequests The maximum number of retry requests. No
leaseId This request will succeed only if the provided leaseId matches the actual lease on the resource. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.readFile configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <filePath>{${payload.filePath}}</filePath>
    <responseVariable>msazuredatalakestorage_readFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <count></count>
    <offset></offset>
    <maxRetryRequests></maxRetryRequests>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
</msazuredatalakestorage.readFile>

Sample request

{
    "fileSystemName": "sales",
    "filePath": "section1/marketing/sample.json"
}
uploadFile

The uploadFile operation uploads a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePathToUpload The destination path in the file system where the file will be uploaded. Yes
localFilePath The local file path of the file to be uploaded. No
textContent Text content to be uploaded instead of a file. No
metadata The metadata of the file. No
timeout The timeout for the operation. No
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
contentLanguage The language of the content. No
contentType The MIME content type of the content. No
contentEncoding Defines the encoding type. No
contentDisposition The value of the Content-Disposition response header. No
cacheControl The value of the Cache-Control response header. No
blockSize The size of the block in MB. No
maxSingleUploadSize The maximum size of a single upload in bytes. No
maxConcurrency The maximum number of blocks that can be uploaded in parallel. No
inputType The input type. Either 'local' or 'text.' Yes

Sample configuration

<msazuredatalakestorage.uploadFile configKey="con1">
    <fileSystemName>{$ctx:fileSystemName}</fileSystemName>
    <filePathToUpload>{$ctx:filePathToUpload}</filePathToUpload>
    <textContent>{$ctx:textContent}</textContent>
    <metadata>[]</metadata>
    <timeout></timeout>
    <responseVariable>msazuredatalakestorage_uploadFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <contentLanguage></contentLanguage>
    <contentType></contentType>
    <contentEncoding></contentEncoding>
    <contentDisposition></contentDisposition>
    <cacheControl></cacheControl>
    <blockSize></blockSize>
    <maxSingleUploadSize></maxSingleUploadSize>
    <maxConcurrency></maxConcurrency>
    <inputType>Text Content</inputType>
</msazuredatalakestorage.uploadFile>

Sample request

{
    "fileSystemName": "sales",
    "filePathToUpload": "section1/marketing/sample.json",
    "textContent": "This is a sample text content to be uploaded."
}
deleteFile

The deleteFile operation deletes a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
directoryName The name of the directory to be deleted. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
recursive Delete the contents of the directory. No
leaseId The lease ID of the directory. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.deleteFile configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <directoryName>{${payload.directoryName}}</directoryName>
    <responseVariable>msazuredatalakestorage_deleteFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
</msazuredatalakestorage.deleteFile>

Sample request

{
    "fileSystemName": "sales",
    "directoryName": "section1/marketing/sample.json"

}
flushFile

The flushFile operation flushes a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePathToFlush The path of the file in the file system to flush. Yes
fileLength The length of the file to flush. Yes
contentLanguage The content language of the file to flush. No
contentType The content type of the file to flush. No
contentEncoding The content encoding of the file to flush. No
contentDisposition The content disposition of the file to flush. No
cacheControl The cache control of the file to flush. No
leaseId The lease ID of the file to flush. No
ifUnmodifiedSince The time since which the file has not been modified. No
ifMatch The ETag value of the file to flush. No
ifModifiedSince The time since which the file has been modified. No
ifNoneMatch The ETag value of the file to flush. No
uncommittedDataRetained Whether to retain uncommitted data. No
leaseAction The lease action to perform. No
timeout The timeout for the operation. No
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
leaseDuration The duration of the lease. No
proposedLeaseId The proposed lease ID. No

Sample configuration

<msazuredatalakestorage.flushFile configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <filePathToFlush>{${payload.filePathToFlush}}</filePathToFlush>
    <fileLength>{${payload.fileLength}}</fileLength>
    <contentLanguage></contentLanguage>
    <contentType></contentType>
    <contentEncoding></contentEncoding>
    <contentDisposition></contentDisposition>
    <cacheControl></cacheControl>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
    <uncommittedDataRetained>false</uncommittedDataRetained>
    <leaseAction>None</leaseAction>
    <timeout></timeout>
    <responseVariable>msazuredatalakestorage_flushFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <leaseDuration></leaseDuration>
    <proposedLeaseId></proposedLeaseId>
</msazuredatalakestorage.flushFile>

Sample request

{
    "fileSystemName": "sales",
    "filePathToFlush": "section1/marketing/sample.json",
    "fileLength": 1024
}
downloadFile

The downloadFile operation downloads a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePathToDownload The path of the file. Yes
downloadLocation The destination path to save the downloaded file. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
leaseId The lease ID of the file. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No
blockSize The size of the block in MB. No
maxSingleDownloadSize The maximum size of a single download in bytes. No
maxConcurrency The maximum number of blocks that can be downloaded in parallel. No
offset The offset in bytes from where the download should start. No
count The number of bytes to be downloaded. No
maxRetryRequests The maximum number of retry requests. No
rangeGetContentMd5 Whether the contentMD5 for the specified file range should be returned. No

Sample configuration

<msazuredatalakestorage.downloadFile configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <filePathToDownload>{${payload.filePathToDownload}}</filePathToDownload>
    <downloadLocation>{${payload.downloadLocation}}</downloadLocation>
    <responseVariable>msazuredatalakestorage_downloadFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
    <blockSize></blockSize>
    <maxConcurrency></maxConcurrency>
    <offset></offset>
    <count></count>
    <maxRetryRequests></maxRetryRequests>
    <rangeGetContentMd5>false</rangeGetContentMd5>
</msazuredatalakestorage.downloadFile>

Sample request

{
    "fileSystemName": "sales",
    "filePathToDownload": "section1/marketing/sample.json",
    "downloadLocation": "/path/to/download/location/sample.json"
}
appendFile

The appendFile operation appends new content to the file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePathToAppend The path of the file in the file system where data will be appended. Yes
inputType The input type. Either 'local' or 'text.' Yes
localFilePath The local file path containing the data to be appended. Yes
textContent Text content to append directly instead of reading from a file. Yes
timeout The timeout for the operation. No
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
flush This request will succeed only if the provided leaseId matches the actual lease on the resource. Yes
leaseId The operation will be performed only if the resource has not been modified since the specified time. No
leaseAction The operation will be performed only if the resource's ETag matches the specified ETag value. No
leaseDuration The operation will be performed only if the resource has been modified since the specified time. No
proposedLeaseId A proposed lease ID that can be set when acquiring or changing a lease. No

Sample configuration

<msazuredatalakestorage.appendFile configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <filePathToAppend>{${payload.filePathToAppend}}</filePathToAppend>
    <inputType>Local File</inputType>
    <localFilePath>{${payload.localFilePath}}</localFilePath>
    <timeout></timeout>
    <responseVariable>msazuredatalakestorage_appendFile_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <flush>true</flush>
    <leaseId></leaseId>
    <leaseAction>None</leaseAction>
    <leaseDuration></leaseDuration>
    <proposedLeaseId></proposedLeaseId>
</msazuredatalakestorage.appendFile>

Sample request

{
    "fileSystemName": "sales",
    "filePathToAppend": "section1/marketing/sample.json",
    "localFilePath": "/path/to/local/file.txt",
}
getMetadata

The getMetadata operation retrives metadata of a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePath The path of the file. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the output of the operation (This will remove the payload from the above variable). Yes

Sample configuration

<msazuredatalakestorage.getMetadata configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <filePath>{${payload.filePath}}</filePath>
    <responseVariable>msazuredatalakestorage_getMetadata_1</responseVariable>
    <overwriteBody>true</overwriteBody>
</msazuredatalakestorage.getMetadata>

Sample request

{
    "fileSystemName": "sales",
    "filePath": "section1/marketing/sample.json"
}
updateMetadata

The updateMetadata operation updates metadata of a file. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
filePathToAddMetaData The path of the file where metadata will be added. Yes
metadata The metadata to be added. Yes
timeout The timeout for the operation. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
leaseId This request will succeed only if the provided leaseId matches the actual lease on the resource. No
ifUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
ifMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
ifModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
ifNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.updateMetadata configKey="con1">
    <fileSystemName>{${payload.fileName}}</fileSystemName>
    <filePathToAddMetaData>{${payload.filePathToAddMetaData}}</filePathToAddMetaData>
    <metadata>[["key1","${payload.key1}"],]</metadata>
    <timeout></timeout>
    <responseVariable>msazuredatalakestorage_updateMetadata_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <leaseId></leaseId>
    <ifUnmodifiedSince></ifUnmodifiedSince>
    <ifMatch></ifMatch>
    <ifModifiedSince></ifModifiedSince>
    <ifNoneMatch></ifNoneMatch>
</msazuredatalakestorage.updateMetadata>
Sample request

{
    "fileSystemName": "sales",
    "filePathToAddMetaData": "section1/marketing/sample.json",
    "key1": "value1"
}

Paths

listPaths

The listPaths operation lists all paths from a file sytem. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
path The path to list. Yes
recursive Whether to list recursively. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
maxResults The maximum number of results to return. No

Sample configuration

<msazuredatalakestorage.listPaths configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <path>{${payload.path}}</path>
    <recursive>true</recursive>
    <responseVariable>msazuredatalakestorage_listPaths_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <maxResults></maxResults>
</msazuredatalakestorage.listPaths>

Sample request

{
    "fileSystemName": "sales",
    "path": "section1/marketing"
}
renamePath

The renamePath operation renames a path. See the related API documentation for more information.

Parameter Name Description Required
fileSystemName The name of the file system. Yes
directoryName The name of the directory. Yes
newDirectoryName The new name of the directory. Yes
responseVariable Name of the variable to which the output of the operation should be assigned Yes
overwriteBody Replace the Message Body in Message Context with the response of the operation. Yes
timeout The timeout for the operation. No
newFileSystemName The name of the new file system. Yes
sourceLeaseId This request will succeed only if the provided leaseId matches the actual lease on the resource. No
sourceIfUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
sourceIfMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
sourceIfModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
sourceIfNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No
destinationLeaseId This request will succeed only if the provided leaseId matches the actual lease on the resource. No
destinationIfUnmodifiedSince The operation will be performed only if the resource has not been modified since the specified time. No
destinationIfMatch The operation will be performed only if the resource's ETag matches the specified ETag value. No
destinationIfModifiedSince The operation will be performed only if the resource has been modified since the specified time. No
destinationIfNoneMatch The operation will be performed only if the resource's ETag does not match the specified ETag value. No

Sample configuration

<msazuredatalakestorage.renamePath configKey="con1">
    <fileSystemName>{${payload.fileSystemName}}</fileSystemName>
    <directoryName>{${payload.directoryName}}</directoryName>
    <newDirectoryName>{${payload.newDirectoryName}}</newDirectoryName>
    <responseVariable>msazuredatalakestorage_renamePath_1</responseVariable>
    <overwriteBody>true</overwriteBody>
    <timeout></timeout>
    <newFileSystemName>{${payload.newFileSystemName}}</newFileSystemName>
    <sourceLeaseId></sourceLeaseId>
    <sourceIfUnmodifiedSince></sourceIfUnmodifiedSince>
    <sourceIfMatch></sourceIfMatch>
    <sourceIfModifiedSince></sourceIfModifiedSince>
    <sourceIfNoneMatch></sourceIfNoneMatch>
    <destinationLeaseId></destinationLeaseId>
    <destinationIfUnmodifiedSince></destinationIfUnmodifiedSince>
    <destinationIfMatch></destinationIfMatch>
    <destinationIfModifiedSince></destinationIfModifiedSince>
    <destinationIfNoneMatch></destinationIfNoneMatch>
</msazuredatalakestorage.renamePath>

Sample request

{
    "fileSystemName": "sales",
    "directoryName": "section1/marketing",
    "newDirectoryName": "section1/marketing_renamed",
    "newFileSystemName": "sales_renamed"
}
Error code Error message
710001 MS_AZURE_DATALAKE_GEN2:CONNECTION_ERROR
710002 MS_AZURE_DATALAKE_GEN2:INVALID_CONFIGURATION
710003 MS_AZURE_DATALAKE_GEN2:MISSING_PARAMETERS
710004 MS_AZURE_DATALAKE_GEN2:AUTHENTICATION_ERROR
710005 MS_AZURE_DATALAKE_GEN2:FILE_ALREADY_EXISTS_ERROR
710006 MS_AZURE_DATALAKE_GEN2:FILE_IO_ERROR
710007 MS_AZURE_DATALAKE_GEN2:DATA_LAKE_STORAGE_GEN2_ERROR
710008 MS_AZURE_DATALAKE_GEN2:FILE_PERMISSION_ERROR
710009 MS_AZURE_DATALAKE_GEN2:GENERAL_ERROR
710010 MS_AZURE_DATALAKE_GEN2:FILE_SYSTEM_DOES_NOT_EXIST
710011 MS_AZURE_DATALAKE_GEN2:INVALID_JSON
710012 MS_AZURE_DATALAKE_GEN2:TIMEOUT_ERROR
710013 MS_AZURE_DATALAKE_GEN2:DIRECTORY_NOT_FOUND_ERROR
710014 MS_AZURE_DATALAKE_GEN2:FILE_DOES_NOT_EXIST
710015 MS_AZURE_DATALAKE_GEN2:No_SUCH_ALGORITHM
710016 MS_AZURE_DATALAKE_GEN2:IO_EXCEPTION
700717 MS_AZURE_DATALAKE_GEN2:DIRECTORY_ALREADY_EXISTS_ERROR
710018 MS_AZURE_DATALAKE_GEN2:INVALID_MAX_RETRY_REQUESTS

In addition to the above ERROR_DETAIL property will contain detail information about the error. For more information, refer to Using Fault Sequences.