Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Update README.md to exclude "properties" key from dataAddress and dataDestination #318

Merged
merged 1 commit into from
Feb 4, 2025
Merged

fix(docs): Update README.md to exclude "properties" key from dataAddress and dataDestination #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 21 additions & 30 deletions extensions/data-plane/data-plane-azure-storage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,23 @@ An example source address:
```json
{
"dataAddress": {
"properties": {
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"blobName": "test/blob.bin",
"keyName": "(see above)"
}
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"blobName": "test/blob.bin",
"keyName": "(see above)"
}
}
```
- Multiple blobs:
```json
{
"dataAddress": {
"properties": {
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"blobPrefix": "test/",
"keyName": "(see above)"
}
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"blobPrefix": "test/",
"keyName": "(see above)"
}
}
```
Expand All @@ -57,14 +53,12 @@ An example destination address:
```json
{
"dataDestination": {
"properties": {
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"folderName": "destinationFolder/",
"blobName": "new-name",
"keyName": "(see above)"
}
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"folderName": "destinationFolder/",
"blobName": "new-name",
"keyName": "(see above)"
}
}
```
Expand All @@ -73,20 +67,17 @@ An example destination address:
```json
{
"dataDestination": {
"properties": {
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"folderName": "destinationFolder/",
"keyName": "(see above)"
}
"type": "AzureStorage",
"container": "containerName",
"account": "accountName",
"folderName": "destinationFolder/",
"keyName": "(see above)"
}
}
```
The `folderName` and the `blobName` are optional properties in destination address.



### AzureStorage Transfer Configuration

The existing implementation takes under consideration transfer of files up to 200GB and that can be accomplished within the space of one hour. If your usage surpasses these limits or any other kind of additional tuning is needed, please [check this documentation](../../common/azure/azure-blob-core/README.md) containing the transfer configurations.
Expand Down