Skip to content

Commit 65c8f0a

Browse files
Adding section in usage docs for setting custom timeout (#149)
* Adding section for setting custom timeout * Minor word change * Addressing PR feedback Co-authored-by: Kyle W. Rader <kyle.rader@microsoft.com> Co-authored-by: Kyle W. Rader <kyle.rader@microsoft.com>
1 parent 9eb0345 commit 65c8f0a

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ Use the option `--output` to get the token in the desired formats. Available cho
9696
3. `--output status` returns the status of the authentication and the cache.
9797
4. `--output none` returns nothing.
9898

99+
## Setting custom timeout
100+
Azureauth defaults to a 15 minute timeout. You can override this with a custom timeout value using `--timeout`. The value is interpreted as a decimal number of minutes. The example below will wait 10 minutes and 45 seconds.
101+
102+
Usage:
103+
```
104+
azureauth --alias alias1 --timeout 10.75
105+
```
106+
99107
Use the command `azureauth --help` to understand more available options.
100108
101109
### Examples

0 commit comments

Comments
 (0)