title | description | author | ms.service | ms.topic | ms.date | ms.author | ms.subservice | ms.reviewer |
---|---|---|---|---|---|---|---|---|
azcopy doc |
This article provides reference information for the azcopy doc command. |
normesta |
azure-storage |
reference |
05/26/2022 |
normesta |
storage-common-concepts |
zezha-msft |
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]
-h
, --help
help for doc
--output-location
(string) where to put the generated markdown files (default "./doc")
--cap-mbps
(float) 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's omitted, the throughput isn't capped.
--output-type
(string) Format of the command's output. The choices include: text, json. The default value is 'text'. (default "text").
--trusted-microsoft-suffixes
(string) Specifies additional domain suffixes where Microsoft Entra login tokens may be sent. The default is '.core.windows.net;.core.chinacloudapi.cn;*.core.cloudapi.