Skip to content

Commit

Permalink
Update Azure client docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rikhil-s committed Nov 15, 2023
1 parent 7c2fa8d commit 0ecb43b
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,13 +386,20 @@ config:
server_name: ""
insecure_skip_verify: false
disable_compression: false
msi_resource: ""
prefix: ""
```

If `msi_resource` is used, authentication is done via system-assigned managed identity. The value for Azure should be `https://<storage-account-name>.blob.core.windows.net`.
If `storage_account_key` is used, authentication is done via storage account key.

If `user_assigned_id` is used, authentication is done via user-assigned managed identity. When using `user_assigned_id` the `msi_resource` defaults to `https://<storage_account>.<endpoint>`
If `user_assigned_id` is used, authentication is done via user-assigned managed identity.

If `user_assigned_id` or `storage_account_key` is not passed, authentication is attempted with each of these credential types, in the following order, stopping when one provides a token:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- AzureCLICredential

For the first three authentication types, the correct environment variables must be set for authentication to be successful. More information about the required environment variables for each authentication type can be found in the [Azure Identity Client Module for Go documentation](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity).

The generic `max_retries` will be used as value for the `pipeline_config`'s `max_tries` and `reader_config`'s `max_retry_requests`. For more control, `max_retries` could be ignored (0) and one could set specific retry values.

Expand Down

0 comments on commit 0ecb43b

Please sign in to comment.