Skip to content

Commit 33dcbfe

Browse files
authored
Update azure manual (#2670)
#### Reference Issues/PRs <!--Example: Fixes #1234. See also #3456.--> https://man312219.monday.com/boards/7852509418/pulses/18021614937 #### What does this implement or fix? Improve azure manual with more examples #### Any other comments? #### Checklist <details> <summary> Checklist for code changes... </summary> - [ ] Have you updated the relevant docstrings, documentation and copyright notice? - [ ] Is this contribution tested against [all ArcticDB's features](../docs/mkdocs/docs/technical/contributing.md)? - [ ] Do all exceptions introduced raise appropriate [error messages](https://docs.arcticdb.io/error_messages/)? - [ ] Are API changes highlighted in the PR description? - [ ] Is the PR labelled as enhancement or bug so it appears in autogenerated release notes? </details> <!-- Thanks for contributing a Pull Request to ArcticDB! Please ensure you have taken a look at: - ArcticDB's Code of Conduct: https://github.com/man-group/ArcticDB/blob/master/CODE_OF_CONDUCT.md - ArcticDB's Contribution Licensing: https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/technical/contributing.md#contribution-licensing -->
1 parent 19671d2 commit 33dcbfe

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

docs/mkdocs/docs/api/arctic_uri.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,33 @@ Please refer to [Azure](https://learn.microsoft.com/en-us/azure/storage/common/s
3737

3838
`options` is a string that specifies connection specific options as `<name>=<value>` pairs joined with `;` (the final key value pair should not include a trailing `;`).
3939

40-
Additional options specific for ArcticDB:
41-
40+
### Notable options
41+
| Option | Description |
42+
|---------------|---------------|
43+
| DefaultEndpointsProtocol | Indicate whether the connection to the storage account through https or http |
44+
| AccountName | Name of the storage account |
45+
| AccountKey | Access key of the storage account |
46+
| BlobEndpoint | Endpoint of the storage account; Usually this should end with `blob.core.windows.net` |
47+
| SharedAccessSignature | Shared Access Signature for authentication |
48+
| EndpointSuffix | Suffix of the endpoint |
49+
50+
### Additional options specific for ArcticDB
4251
| Option | Description |
4352
|---------------|---------------|
4453
| Container | Azure container for blobs |
4554
| Path_prefix | Path within Azure container to use for data storage |
4655
| CA_cert_path | (Linux platform only) Azure CA certificate path. If not set, python ``ssl.get_default_verify_paths().cafile`` will be used. If the certificate cannot be found in the provided path, an Azure exception with no meaningful error code will be thrown. For more details, please see [here](https://github.com/Azure/azure-sdk-for-cpp/issues/4738). For example, `Failed to iterate azure blobs 'C' 0:`.|
4756
| CA_cert_dir | (Linux platform only) Azure CA certificate directory. If not set, python ``ssl.get_default_verify_paths().capath`` will be used. Certificates can only be used if corresponding hash files [exist](https://www.openssl.org/docs/man1.0.2/man3/SSL_CTX_load_verify_locations.html). If the certificate cannot be found in the provided path, an Azure exception with no meaningful error code will be thrown. For more details, please see [here](https://github.com/Azure/azure-sdk-for-cpp/issues/4738). For example, `Failed to iterate azure blobs 'C' 0:`.|
4857

58+
### Example
59+
60+
#### With Access Key Authentication
61+
`azure://DefaultEndpointsProtocol=https;AccountName=arcticdb;AccountKey=KEY;EndpointSuffix=core.windows.net;Container=test`
62+
63+
#### With Shared Access Signature Authentication
64+
`azure://BlobEndpoint=https://arcticdb.blob.core.windows.net/;SharedAccessSignature=KEY;Container=test`
65+
66+
### Notes
4967
For non-Linux platforms, neither `CA_cert_path` nor `CA_cert_dir` may be set. Please set CA certificate related options using operating system settings.
5068
For Windows, please see [here](https://learn.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate)
5169

docs/mkdocs/docs/azure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,5 @@ connection_string = '<CONNECTION_STRING>'
5454
ca_cert_path = '<CA_CERT_PATH>'
5555
arctic = adb.Arctic(f"azure://{connection_string};Container=data;CA_cert_path={ca_cert_path}")
5656
```
57+
58+
Please check the [URI manual](https://docs.arcticdb.io/latest/api/arctic_uri/#azure) for more details about Azure Connection String

0 commit comments

Comments
 (0)