azcopy_doc

azcopy doc

Generates documentation for the tool in Markdown format

Synopsis

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]

Options

  -h, --help                     help for doc
      --output-location string   where to put the generated markdown files (default "./doc")

Options inherited from parent commands

      --await-continue continue             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 open                     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 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 is omitted, the throughput isn't capped.
      --check-version                       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                    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'). (default "INFO")
      --output-level string                 Define the output verbosity. Available levels: essential, quiet. (default "default")
      --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 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.

SEE ALSO

• azcopy - AzCopy is a command line tool that moves data into and out of Azure Storage.

Auto generated by spf13/cobra on 7-Oct-2025