-
Notifications
You must be signed in to change notification settings - Fork 267
azcopy_doc
GitHub Action edited this page Feb 4, 2026
·
58 revisions
Generates documentation for the tool in Markdown format
Generates documentation for the tool in Markdown format, and stores them in the designated location.
By default, the files are stored in a folder named 'doc' inside the current directory.
azcopy doc [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--format |
string | default |
output format: 'default' (cobra standard) or 'wiki' (GitHub Wiki style with tables) |
-h, --help
|
bool | false |
help for doc |
--output-location |
string | ./doc |
where to put the generated markdown files |
These options are inherited from parent commands.
| Flag | Type | Default | Description |
|---|---|---|---|
--await-continue |
bool | false |
Used when debugging, to tell AzCopy to await continue on stdin before starting any work. Assists with debugging AzCopy via attach-to-process |
--await-open |
bool | false |
Used when debugging, to tell AzCopy to await open on stdin, after scanning but before opening the first file. Assists with testing cases around file modifications between scanning and usage |
--cap-mbps |
float64 | 0 |
Caps the transfer rate, in megabits per second. Moment-by-moment throughput might vary slightly from the cap. If this option is set to zero, or it is omitted, the throughput isn't capped. |
--check-version |
bool | false |
Check if a newer AzCopy version is available. |
--debug-skip-files |
string | `` | Used when debugging, to tell AzCopy to cancel the job midway. List of relative paths to skip in the STE. |
--log-level |
string | INFO |
Define the log verbosity for the log file, available levels: DEBUG(detailed trace), INFO(all requests/responses), WARNING(slow responses), ERROR(only failed requests), and NONE(no output logs). (default 'INFO'). |
--output-level |
string | default |
Define the output verbosity. Available levels: essential, quiet. |
--output-type |
string | text |
Format of the command's output. The choices include: text, json. The default value is 'text'. |
--trusted-microsoft-suffixes |
string | `` | Specifies additional domain suffixes where Azure Active Directory login tokens may be sent. The default is '.core.windows.net;.core.chinacloudapi.cn;.core.cloudapi.de;.core.usgovcloudapi.net;*.storage.azure.net'. Any listed here are added to the default. For security, you should only put Microsoft Azure domains here. Separate multiple entries with semi-colons. |
Parent command: azcopy