Skip to content

Commit

Permalink
Update modify.md with params for #6359
Browse files Browse the repository at this point in the history
iterative/dvc#6359 adds some additional parameters to the azure config. This PR is the documentation for those.
  • Loading branch information
meierale committed Jul 23, 2021
1 parent 88bc653 commit 4d1782e
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,23 @@ application. To use a custom authentication method, use the following parameters
```dvc
$ dvc remote modify myremote allow_anonymous_login true
```

* When using `dvc` on windows with authentication through `az cli`
some or all of the following exclude params may have to be set, depending on your setup.

See https://docs.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python for
further details.
* `exclude_environment_credential` - exclude an already configured service principal.
* `exclude_visual_studio_code_credential` - exclude credentials stored in VS Code.
* `exclude_shared_token_cache_credential` - exclude cached shared tokens.
* `exclude_managed_identity_credential` - exclude the managed identity from the credential.

```dvc
$ dvc remote modify --local myremote exclude_environment_credential true
$ dvc remote modify --local myremote exclude_visual_studio_code_credential true
$ dvc remote modify --local myremote exclude_shared_token_cache_credential true
$ dvc remote modify --local myremote exclude_managed_identity_credential true
```

Note that Azure remotes can also authenticate via environment variables (instead
of `dvc remote modify`). These are tried if none of the params above are set.
Expand Down

0 comments on commit 4d1782e

Please sign in to comment.