target/azure: document what it does
Signed-off-by: Ondřej Budai <ondrej@budai.cz>
This commit is contained in:
parent
fa9fc890c9
commit
7ae557ea22
1 changed files with 10 additions and 0 deletions
|
|
@ -9,6 +9,16 @@ type AzureTargetOptions struct {
|
|||
|
||||
func (AzureTargetOptions) isTargetOptions() {}
|
||||
|
||||
// NewAzureTarget creates org.osbuild.azure target
|
||||
//
|
||||
// This target uploads a Page Blob to Azure Storage.
|
||||
//
|
||||
// The target uses Azure Storage keys for authentication, see:
|
||||
// https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage
|
||||
// The credentials are defined inside the target options.
|
||||
//
|
||||
// If you need to upload an Azure Image instead, see the
|
||||
// org.osbuild.azure.image target.
|
||||
func NewAzureTarget(options *AzureTargetOptions) *Target {
|
||||
return newTarget("org.osbuild.azure", options)
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue