• Documentation
  • Reference
    Show / Hide Table of Contents
    • Cake.AzCopy
      • AzCopyAliases
      • AzCopyRunner
      • AzCopySettings
      • AzCopySettingsExtensions
      • BlobType
      • FileHandling
      • PayloadFormat

    Class AzCopySettings

    Inheritance
    System.Object
    Cake.Core.Tooling.ToolSettings
    AzCopySettings
    Inherited Members
    Cake.Core.Tooling.ToolSettings.ToolPath
    Cake.Core.Tooling.ToolSettings.ToolTimeout
    Cake.Core.Tooling.ToolSettings.WorkingDirectory
    Cake.Core.Tooling.ToolSettings.ArgumentCustomization
    Cake.Core.Tooling.ToolSettings.EnvironmentVariables
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Cake.AzCopy
    Assembly: Cake.AzCopy.dll
    Syntax
    public class AzCopySettings : ToolSettings

    Properties

    | Improve this Doc View Source

    BlobType

    Declaration
    public BlobType? BlobType { get; set; }
    Property Value
    Type Description
    System.Nullable<BlobType>
    | Improve this Doc View Source

    ConcurrentOperations

    Declaration
    public int ConcurrentOperations { get; set; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Delimiter

    Declaration
    public char ? Delimiter { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Char>
    | Improve this Doc View Source

    DestinationKey

    Declaration
    public string DestinationKey { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    DestinationSAS

    Declaration
    public string DestinationSAS { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    FileHandlingBehaviour

    Declaration
    public FileHandling? FileHandlingBehaviour { get; set; }
    Property Value
    Type Description
    System.Nullable<FileHandling>
    | Improve this Doc View Source

    LogFile

    Declaration
    public FilePath LogFile { get; set; }
    Property Value
    Type Description
    Cake.Core.IO.FilePath
    Remarks

    This value is ignored when running on Linux

    | Improve this Doc View Source

    ParameterFiles

    Declaration
    public List<FilePath> ParameterFiles { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<Cake.Core.IO.FilePath>
    | Improve this Doc View Source

    Pattern

    Declaration
    public string Pattern { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    PayloadFormat

    Declaration
    public PayloadFormat PayloadFormat { get; set; }
    Property Value
    Type Description
    PayloadFormat
    Remarks

    This value is ignored when running on Linux

    | Improve this Doc View Source

    Recursive

    Declaration
    public bool Recursive { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    SourceKey

    Declaration
    public string SourceKey { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    SourceSAS

    Declaration
    public string SourceSAS { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    TargetContentType

    Declaration
    public string TargetContentType { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    UseChecksum

    Declaration
    public bool UseChecksum { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    | Improve this Doc View Source

    BuildLinuxArguments(ProcessArgumentBuilder)

    Declaration
    public ProcessArgumentBuilder BuildLinuxArguments(ProcessArgumentBuilder args)
    Parameters
    Type Name Description
    Cake.Core.IO.ProcessArgumentBuilder args
    Returns
    Type Description
    Cake.Core.IO.ProcessArgumentBuilder
    | Improve this Doc View Source

    BuildWindowsArguments(ProcessArgumentBuilder)

    Declaration
    public ProcessArgumentBuilder BuildWindowsArguments(ProcessArgumentBuilder args)
    Parameters
    Type Name Description
    Cake.Core.IO.ProcessArgumentBuilder args
    Returns
    Type Description
    Cake.Core.IO.ProcessArgumentBuilder

    Extension Methods

    AzCopySettingsExtensions.UsePattern(AzCopySettings, String)
    AzCopySettingsExtensions.UseDestinationAccountKey(AzCopySettings, String)
    AzCopySettingsExtensions.UseSourceAccountKey(AzCopySettings, String)
    AzCopySettingsExtensions.UseDestinationSignature(AzCopySettings, String)
    AzCopySettingsExtensions.UseSourceSignature(AzCopySettings, String)
    AzCopySettingsExtensions.CopyRecursively(AzCopySettings, Boolean)
    AzCopySettingsExtensions.SetBlobType(AzCopySettings, String)
    AzCopySettingsExtensions.SetBlobType(AzCopySettings, BlobType)
    AzCopySettingsExtensions.EnableChecksums(AzCopySettings, Boolean)
    AzCopySettingsExtensions.LogToFile(AzCopySettings, FilePath)
    AzCopySettingsExtensions.AddResponseFile(AzCopySettings, FilePath)
    AzCopySettingsExtensions.SetFileBehaviour(AzCopySettings, FileHandling)
    AzCopySettingsExtensions.UseDelimiter(AzCopySettings, Char)
    AzCopySettingsExtensions.SetConcurrentOperationsCount(AzCopySettings, Int32)
    AzCopySettingsExtensions.SetContentType(AzCopySettings, String)
    AzCopySettingsExtensions.SetPayloadFormat(AzCopySettings, PayloadFormat)
    AzCopySettingsExtensions.SetPayloadFormat(AzCopySettings, String)
    • Improve this Doc
    • View Source
    Back to top This addin is © 2017 Alistair Chapman, and released under the terms of the MIT License