Skip to content

Commit 1527621

Browse files
committed
docs: add links
1 parent 8d10752 commit 1527621

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -103,20 +103,20 @@ store = ObjectStore("az://<container-name>")
103103
The recommended url format is `az://<container>/<path>` and Azure always requieres
104104
`azure_storage_account_name` to be configured.
105105

106-
- master key
106+
- [shared key][azure-key]
107107
- `azure_storage_account_key`
108-
- service principal
108+
- [service principal][azure-ad]
109109
- `azure_client_id`
110110
- `azure_client_secret`
111111
- `azure_tenant_id`
112-
- shared access signature
112+
- [shared access signature][azure-sas]
113113
- `azure_storage_sas_key` (as provided by StorageExplorer)
114114
- bearer token
115115
- `azure_storage_token`
116-
- managed identity (with user assigned identity)
116+
- [managed identity][azure-managed]
117117
- if using user assigned identity one of `azure_client_id`, `azure_object_id`, `azure_msi_resource_id`
118118
- `use_managed_identity`
119-
- workload identity
119+
- [workload identity][azure-workload]
120120
- `azure_client_id`
121121
- `azure_tenant_id`
122122
- `azure_federated_token_file`
@@ -126,14 +126,14 @@ The recommended url format is `az://<container>/<path>` and Azure always requier
126126
The recommended url format is `s3://<bucket>/<path>` S3 storage always requires a
127127
region to be specified via one of `aws_region` or `aws_default_region`.
128128

129-
- access key
129+
- [access key][aws-key]
130130
- `aws_access_key_id`
131131
- `aws_secret_access_key`
132-
- session token
132+
- [session token][aws-sts]
133133
- `aws_session_token`
134-
- imds instance metadata
134+
- [imds instance metadata][aws-imds]
135135
- `aws_metadata_endpoint`
136-
- profile
136+
- [profile][aws-profile]
137137
- `aws_profile`
138138

139139
AWS supports [virtual hosting of buckets][aws-virtual], which can be configured by setting
@@ -208,3 +208,12 @@ just test
208208
[black-img]: https://img.shields.io/badge/code%20style-black-000000.svg
209209
[black-link]: https://github.com/psf/black
210210
[aws-virtual]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html
211+
[azure-managed]: https://learn.microsoft.com/en-gb/azure/app-service/overview-managed-identity
212+
[azure-sas]: https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview
213+
[azure-ad]: https://learn.microsoft.com/en-us/azure/storage/blobs/authorize-access-azure-active-directory
214+
[azure-key]: https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-shared-key
215+
[azure-workload]: https://learn.microsoft.com/en-us/azure/aks/workload-identity-overview
216+
[aws-imds]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html
217+
[aws-profile]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html
218+
[aws-sts]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
219+
[aws-key]: https://docs.aws.amazon.com/accounts/latest/reference/credentials-access-keys-best-practices.html

0 commit comments

Comments
 (0)