generated

package
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 9, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const ServiceVersion = version20261206

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicy 

type AccessPolicy struct {
	// The date-time the policy expires.
	Expiry *time.Time `xml:"Expiry"`

	// The permissions for the policy.
	Permission *string `xml:"Permission"`

	// The date-time the policy is active.
	Start *time.Time `xml:"Start"`
}

AccessPolicy - Represents an access policy.

func (AccessPolicy) MarshalXML 

func (a AccessPolicy) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type AccessPolicy.

func (*AccessPolicy) UnmarshalXML 

func (a *AccessPolicy) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type AccessPolicy.

type AccessTier 

type AccessTier string

AccessTier - The access tiers. 

const (
	// AccessTierArchive - The Archive access tier.
	AccessTierArchive AccessTier = "Archive"
	// AccessTierCold - The Cold access tier.
	AccessTierCold AccessTier = "Cold"
	// AccessTierCool - The Cool access tier.
	AccessTierCool AccessTier = "Cool"
	// AccessTierHot - The Hot access tier.
	AccessTierHot AccessTier = "Hot"
	// AccessTierP10 - The P10 access tier.
	AccessTierP10 AccessTier = "P10"
	// AccessTierP15 - The P15 access tier.
	AccessTierP15 AccessTier = "P15"
	// AccessTierP20 - The P20 access tier.
	AccessTierP20 AccessTier = "P20"
	// AccessTierP30 - The P30 access tier.
	AccessTierP30 AccessTier = "P30"
	// AccessTierP4 - The P4 access tier.
	AccessTierP4 AccessTier = "P4"
	// AccessTierP40 - The P40 access tier.
	AccessTierP40 AccessTier = "P40"
	// AccessTierP50 - The P50 access tier.
	AccessTierP50 AccessTier = "P50"
	// AccessTierP6 - The P6 access tier.
	AccessTierP6 AccessTier = "P6"
	// AccessTierP60 - The P60 access tier.
	AccessTierP60 AccessTier = "P60"
	// AccessTierP70 - The P70 access tier.
	AccessTierP70 AccessTier = "P70"
	// AccessTierP80 - The P80 access tier.
	AccessTierP80 AccessTier = "P80"
	// AccessTierPremium - The Premium access tier.
	AccessTierPremium AccessTier = "Premium"
	// AccessTierSmart - The Smart access tier.
	AccessTierSmart AccessTier = "Smart"
)

func PossibleAccessTierValues 

func PossibleAccessTierValues() []AccessTier

PossibleAccessTierValues returns the possible values for the AccessTier const type.

type AccountKind 

type AccountKind string

AccountKind - The account kind. 

const (
	// AccountKindBlobStorage - A blob storage account.
	AccountKindBlobStorage AccountKind = "BlobStorage"
	// AccountKindBlockBlobStorage - A block blob storage account.
	AccountKindBlockBlobStorage AccountKind = "BlockBlobStorage"
	// AccountKindFileStorage - A file storage account.
	AccountKindFileStorage AccountKind = "FileStorage"
	// AccountKindStorage - A general-purpose account.
	AccountKindStorage AccountKind = "Storage"
	// AccountKindStorageV2 - A storage V2 account.
	AccountKindStorageV2 AccountKind = "StorageV2"
)

func PossibleAccountKindValues 

func PossibleAccountKindValues() []AccountKind

PossibleAccountKindValues returns the possible values for the AccountKind const type.

type AppendBlobClient 

type AppendBlobClient struct {
	// contains filtered or unexported fields
}

AppendBlobClient contains the methods for the AppendBlob group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewAppendBlobClient 

func NewAppendBlobClient(endpoint string, azClient *azcore.Client) *AppendBlobClient

NewAppendBlobClient creates a new instance of AppendBlobClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*AppendBlobClient) AppendBlock 

func (client *AppendBlobClient) AppendBlock(ctx context.Context, body io.ReadSeekCloser, contentLength int64, options *AppendBlobClientAppendBlockOptions) (AppendBlobClientAppendBlockResponse, error)

AppendBlock - Uploads a new block of data to the end of an append blob. If the operation fails it returns an *azcore.ResponseError type.

  • body - The body of the request.
  • contentLength - The length of the request.
  • options - AppendBlobClientAppendBlockOptions contains the optional parameters for the AppendBlobClient.AppendBlock method.

func (*AppendBlobClient) AppendBlockFromURL 

func (client *AppendBlobClient) AppendBlockFromURL(ctx context.Context, sourceURL string, contentLength int64, options *AppendBlobClientAppendBlockFromURLOptions) (AppendBlobClientAppendBlockFromURLResponse, error)

AppendBlockFromURL - Uploads a new block of data from the specified URL to the end of an append blob. If the operation fails it returns an *azcore.ResponseError type.

  • sourceURL - Specifies the URL of the source.
  • contentLength - The length of the request.
  • options - AppendBlobClientAppendBlockFromURLOptions contains the optional parameters for the AppendBlobClient.AppendBlockFromURL method.

func (*AppendBlobClient) Create 

func (client *AppendBlobClient) Create(ctx context.Context, options *AppendBlobClientCreateOptions) (AppendBlobClientCreateResponse, error)

Create - Creates a new append blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - AppendBlobClientCreateOptions contains the optional parameters for the AppendBlobClient.Create method.

func (*AppendBlobClient) Endpoint 

func (client *AppendBlobClient) Endpoint() string

func (*AppendBlobClient) InternalClient added in v1.2.0 

func (client *AppendBlobClient) InternalClient() *azcore.Client

func (*AppendBlobClient) Seal 

func (client *AppendBlobClient) Seal(ctx context.Context, options *AppendBlobClientSealOptions) (AppendBlobClientSealResponse, error)

Seal - Seals the append blob to make it read-only. If the operation fails it returns an *azcore.ResponseError type.

  • options - AppendBlobClientSealOptions contains the optional parameters for the AppendBlobClient.Seal method.

type AppendBlobClientAppendBlockFromURLOptions 

type AppendBlobClientAppendBlockFromURLOptions struct {
	// A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with
	// AppendPositionConditionNotMet.
	AppendPosition *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.
	CopySourceAuthorization *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specifies the file request token intent.
	FileRequestIntent *FileShareTokenIntent

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The max length of the blob. If the operation would cause the blob to exceed that limit or if the blob size is already greater
	// than the value specified, the request will fail with MaxBlobSizeConditionNotMet.
	MaxSize *int64

	// Specifies the CRC64 calculated for the range of bytes that must be read from the source.
	SourceContentCRC64 []byte

	// Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.
	SourceContentMD5 []byte

	// The algorithm used to produce the source encryption key hash. Must be provided if the source encryption key is provided.
	SourceEncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to decrypt the source data provided in the request.
	SourceEncryptionKey *string

	// The SHA-256 hash of the provided source encryption key. Must be provided if the source encryption key is provided.
	SourceEncryptionKeySHA256 *string

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// Specifies the bytes of the source.
	SourceRange *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

AppendBlobClientAppendBlockFromURLOptions contains the optional parameters for the AppendBlobClient.AppendBlockFromURL method.

func (*AppendBlobClientAppendBlockFromURLOptions) SetSourceContentCRC64 added in v0.6.0 

func (a *AppendBlobClientAppendBlockFromURLOptions) SetSourceContentCRC64(v []byte)

func (*AppendBlobClientAppendBlockFromURLOptions) SetSourceContentMD5 added in v0.6.0 

func (a *AppendBlobClientAppendBlockFromURLOptions) SetSourceContentMD5(v []byte)

type AppendBlobClientAppendBlockFromURLResponse 

type AppendBlobClientAppendBlockFromURLResponse struct {
	// The offset at which the block was committed, in bytes.
	BlobAppendOffset *string

	// The number of committed blocks present in the blob.
	BlobCommittedBlockCount *int32

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

AppendBlobClientAppendBlockFromURLResponse contains the response from method AppendBlobClient.AppendBlockFromURL.

type AppendBlobClientAppendBlockOptions 

type AppendBlobClientAppendBlockOptions struct {
	// A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with
	// AppendPositionConditionNotMet.
	AppendPosition *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The max length of the blob. If the operation would cause the blob to exceed that limit or if the blob size is already greater
	// than the value specified, the request will fail with MaxBlobSizeConditionNotMet.
	MaxSize *int64

	// Required if the request body is a structured message. Specifies the message schema version and properties.
	StructuredBodyType *string

	// Required if the request body is a structured message. Specifies the length of the blob/file content inside the message
	// body. Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

AppendBlobClientAppendBlockOptions contains the optional parameters for the AppendBlobClient.AppendBlock method.

func (*AppendBlobClientAppendBlockOptions) SetCRC64 added in v0.6.0 

func (a *AppendBlobClientAppendBlockOptions) SetCRC64(v []byte)

func (*AppendBlobClientAppendBlockOptions) SetMD5 added in v0.6.0 

func (a *AppendBlobClientAppendBlockOptions) SetMD5(v []byte)

func (*AppendBlobClientAppendBlockOptions) SetStructuredBody 

func (a *AppendBlobClientAppendBlockOptions) SetStructuredBody(bodyType string, contentLength int64)

type AppendBlobClientAppendBlockResponse 

type AppendBlobClientAppendBlockResponse struct {
	// The offset at which the block was committed, in bytes.
	BlobAppendOffset *string

	// The number of committed blocks present in the blob.
	BlobCommittedBlockCount *int32

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Indicates if the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

AppendBlobClientAppendBlockResponse contains the response from method AppendBlobClient.AppendBlock.

type AppendBlobClientCreateOptions 

type AppendBlobClientCreateOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

AppendBlobClientCreateOptions contains the optional parameters for the AppendBlobClient.Create method.

type AppendBlobClientCreateResponse 

type AppendBlobClientCreateResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

AppendBlobClientCreateResponse contains the response from method AppendBlobClient.Create.

type AppendBlobClientSealOptions 

type AppendBlobClientSealOptions struct {
	// A byte offset where the operation will only succeed if the append position is equal. If not, the request will fail with
	// AppendPositionConditionNotMet.
	AppendPosition *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

AppendBlobClientSealOptions contains the optional parameters for the AppendBlobClient.Seal method.

type AppendBlobClientSealResponse 

type AppendBlobClientSealResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// Whether the blob is sealed.
	IsSealed *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

AppendBlobClientSealResponse contains the response from method AppendBlobClient.Seal.

type AppendPositionAccessConditions 

type AppendPositionAccessConditions struct {
	// Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare.
	// Append Block will succeed only if the append position is equal to this number. If
	// it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).
	AppendPosition *int64

	// Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would
	// cause the blob to exceed that limit or if the blob size is already greater than
	// the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 -
	// Precondition Failed).
	MaxSize *int64
}

AppendPositionAccessConditions contains a group of parameters for the AppendBlobClient.AppendBlock method.

type ArchiveStatus 

type ArchiveStatus string

ArchiveStatus - The archive status. 

const (
	// ArchiveStatusRehydratePendingToCold - The archive status is rehydrating pending to Cold.
	ArchiveStatusRehydratePendingToCold ArchiveStatus = "rehydrate-pending-to-cold"
	// ArchiveStatusRehydratePendingToCool - The archive status is rehydrating pending to Cool.
	ArchiveStatusRehydratePendingToCool ArchiveStatus = "rehydrate-pending-to-cool"
	// ArchiveStatusRehydratePendingToHot - The archive status is rehydrating pending to Hot.
	ArchiveStatusRehydratePendingToHot ArchiveStatus = "rehydrate-pending-to-hot"
	// ArchiveStatusRehydratePendingToSmart - The archive status is rehydrating pending to Smart.
	ArchiveStatusRehydratePendingToSmart ArchiveStatus = "rehydrate-pending-to-smart"
)

func PossibleArchiveStatusValues 

func PossibleArchiveStatusValues() []ArchiveStatus

PossibleArchiveStatusValues returns the possible values for the ArchiveStatus const type.

type ArrowConfiguration 

type ArrowConfiguration struct {
	// REQUIRED; The Apache Arrow schema.
	Schema []*ArrowField `xml:"Schema>Field"`
}

ArrowConfiguration - Represents the Apache Arrow configuration.

func (ArrowConfiguration) MarshalXML 

func (a ArrowConfiguration) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ArrowConfiguration.

type ArrowField 

type ArrowField struct {
	// REQUIRED; The arrow field type.
	Type *string `xml:"Type"`

	// The arrow field name.
	Name *string `xml:"Name"`

	// The arrow field precision.
	Precision *int32 `xml:"Precision"`

	// The arrow field scale.
	Scale *int32 `xml:"Scale"`
}

ArrowField - Represents an Apache Arrow field.

func (ArrowField) MarshalXML 

func (a ArrowField) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ArrowField.

type BlobClient 

type BlobClient struct {
	// contains filtered or unexported fields
}

BlobClient contains the methods for the Blob group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewBlobClient 

func NewBlobClient(endpoint string, azClient *azcore.Client) *BlobClient

NewBlobClient creates a new instance of BlobClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*BlobClient) AbortCopyFromURL 

func (client *BlobClient) AbortCopyFromURL(ctx context.Context, copyID string, options *BlobClientAbortCopyFromURLOptions) (BlobClientAbortCopyFromURLResponse, error)

AbortCopyFromURL - Aborts a pending asynchronous copy operation and leaves a destination blob with zero length and full metadata. If the operation fails it returns an *azcore.ResponseError type.

  • copyID - The ID of the copy to be aborted.
  • options - BlobClientAbortCopyFromURLOptions contains the optional parameters for the BlobClient.AbortCopyFromURL method.

func (*BlobClient) AcquireLease 

func (client *BlobClient) AcquireLease(ctx context.Context, duration int32, options *BlobClientAcquireLeaseOptions) (BlobClientAcquireLeaseResponse, error)

AcquireLease - Requests a new lease on the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • duration - Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds.
  • options - BlobClientAcquireLeaseOptions contains the optional parameters for the BlobClient.AcquireLease method.

func (*BlobClient) BreakLease 

func (client *BlobClient) BreakLease(ctx context.Context, options *BlobClientBreakLeaseOptions) (BlobClientBreakLeaseResponse, error)

BreakLease - Ends a lease and ensures that another client can't acquire a new lease until the current lease period has expired. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientBreakLeaseOptions contains the optional parameters for the BlobClient.BreakLease method.

func (*BlobClient) ChangeLease 

func (client *BlobClient) ChangeLease(ctx context.Context, leaseID string, proposedLeaseID string, options *BlobClientChangeLeaseOptions) (BlobClientChangeLeaseResponse, error)

ChangeLease - Change the ID of an existing lease. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • proposedLeaseID - The proposed lease ID for the lease.
  • options - BlobClientChangeLeaseOptions contains the optional parameters for the BlobClient.ChangeLease method.

func (*BlobClient) CopyFromURL 

func (client *BlobClient) CopyFromURL(ctx context.Context, copySource string, options *BlobClientCopyFromURLOptions) (BlobClientCopyFromURLResponse, error)

CopyFromURL - Synchronously copies a blob from a source URL to the destination blob. If the operation fails it returns an *azcore.ResponseError type.

  • copySource - Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.
  • options - BlobClientCopyFromURLOptions contains the optional parameters for the BlobClient.CopyFromURL method.

func (*BlobClient) CreateSnapshot 

func (client *BlobClient) CreateSnapshot(ctx context.Context, options *BlobClientCreateSnapshotOptions) (BlobClientCreateSnapshotResponse, error)

CreateSnapshot - Creates a read-only snapshot of the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientCreateSnapshotOptions contains the optional parameters for the BlobClient.CreateSnapshot method.

func (*BlobClient) Delete 

func (client *BlobClient) Delete(ctx context.Context, options *BlobClientDeleteOptions) (BlobClientDeleteResponse, error)

Delete - Deletes the specified blob. If blob soft delete is enabled, the blob is marked for deletion and can be recovered until the retention period expires. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientDeleteOptions contains the optional parameters for the BlobClient.Delete method.

func (*BlobClient) DeleteCreateRequest added in v1.1.0 

func (client *BlobClient) DeleteCreateRequest(ctx context.Context, options *BlobClientDeleteOptions) (*policy.Request, error)

func (*BlobClient) DeleteImmutabilityPolicy 

func (client *BlobClient) DeleteImmutabilityPolicy(ctx context.Context, options *BlobClientDeleteImmutabilityPolicyOptions) (BlobClientDeleteImmutabilityPolicyResponse, error)

DeleteImmutabilityPolicy - Deletes the immutability policy on the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientDeleteImmutabilityPolicyOptions contains the optional parameters for the BlobClient.DeleteImmutabilityPolicy method.

func (*BlobClient) Download 

func (client *BlobClient) Download(ctx context.Context, options *BlobClientDownloadOptions) (BlobClientDownloadResponseInternal, error)

Download - Downloads the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientDownloadOptions contains the optional parameters for the BlobClient.Download method.

func (*BlobClient) Endpoint 

func (client *BlobClient) Endpoint() string

func (*BlobClient) GetAccountInfo 

func (client *BlobClient) GetAccountInfo(ctx context.Context, options *BlobClientGetAccountInfoOptions) (BlobClientGetAccountInfoResponse, error)

GetAccountInfo - Returns information about the storage account. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientGetAccountInfoOptions contains the optional parameters for the BlobClient.GetAccountInfo method.

func (*BlobClient) GetProperties 

func (client *BlobClient) GetProperties(ctx context.Context, options *BlobClientGetPropertiesOptions) (BlobClientGetPropertiesResponse, error)

GetProperties - Returns all user-defined metadata, standard HTTP properties, and system properties for the specified blob. It does not return the content of the blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientGetPropertiesOptions contains the optional parameters for the BlobClient.GetProperties method.

func (*BlobClient) GetTags 

func (client *BlobClient) GetTags(ctx context.Context, options *BlobClientGetTagsOptions) (BlobClientGetTagsResponse, error)

GetTags - Gets the tags of the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientGetTagsOptions contains the optional parameters for the BlobClient.GetTags method.

func (*BlobClient) InternalClient added in v1.2.0 

func (client *BlobClient) InternalClient() *azcore.Client

func (*BlobClient) ReleaseLease 

func (client *BlobClient) ReleaseLease(ctx context.Context, leaseID string, options *BlobClientReleaseLeaseOptions) (BlobClientReleaseLeaseResponse, error)

ReleaseLease - Frees the lease if it's no longer needed, so that another client can immediately acquire a lease against the blob. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • options - BlobClientReleaseLeaseOptions contains the optional parameters for the BlobClient.ReleaseLease method.

func (*BlobClient) RenewLease 

func (client *BlobClient) RenewLease(ctx context.Context, leaseID string, options *BlobClientRenewLeaseOptions) (BlobClientRenewLeaseResponse, error)

RenewLease - Renews an existing lease. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • options - BlobClientRenewLeaseOptions contains the optional parameters for the BlobClient.RenewLease method.

func (*BlobClient) SetExpiry 

func (client *BlobClient) SetExpiry(ctx context.Context, expiryOptions ExpiryOptions, options *BlobClientSetExpiryOptions) (BlobClientSetExpiryResponse, error)

SetExpiry - Set the expiration time of the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • expiryOptions - Indicates the mode of the expiry time.
  • options - BlobClientSetExpiryOptions contains the optional parameters for the BlobClient.SetExpiry method.

func (*BlobClient) SetHTTPHeaders 

func (client *BlobClient) SetHTTPHeaders(ctx context.Context, options *BlobClientSetHTTPHeadersOptions) (BlobClientSetHTTPHeadersResponse, error)

SetHTTPHeaders - Sets system properties on the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientSetHTTPHeadersOptions contains the optional parameters for the BlobClient.SetHTTPHeaders method.

func (*BlobClient) SetImmutabilityPolicy 

func (client *BlobClient) SetImmutabilityPolicy(ctx context.Context, expiry time.Time, options *BlobClientSetImmutabilityPolicyOptions) (BlobClientSetImmutabilityPolicyResponse, error)

SetImmutabilityPolicy - Set the immutability policy on the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • expiry - The date-time that indicates the time at which the blob immutability policy will expire.
  • options - BlobClientSetImmutabilityPolicyOptions contains the optional parameters for the BlobClient.SetImmutabilityPolicy method.

func (*BlobClient) SetLegalHold 

func (client *BlobClient) SetLegalHold(ctx context.Context, legalHold bool, options *BlobClientSetLegalHoldOptions) (BlobClientSetLegalHoldResponse, error)

SetLegalHold - Sets a legal hold on the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • legalHold - Indicates whether the blob has a legal hold.
  • options - BlobClientSetLegalHoldOptions contains the optional parameters for the BlobClient.SetLegalHold method.

func (*BlobClient) SetMetadata 

func (client *BlobClient) SetMetadata(ctx context.Context, options *BlobClientSetMetadataOptions) (BlobClientSetMetadataResponse, error)

SetMetadata - Sets user-defined metadata for the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientSetMetadataOptions contains the optional parameters for the BlobClient.SetMetadata method.

func (*BlobClient) SetTags 

func (client *BlobClient) SetTags(ctx context.Context, tags BlobTags, options *BlobClientSetTagsOptions) (BlobClientSetTagsResponse, error)

SetTags - Sets the tags of the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • tags - The blob tags.
  • options - BlobClientSetTagsOptions contains the optional parameters for the BlobClient.SetTags method.

func (*BlobClient) SetTier 

func (client *BlobClient) SetTier(ctx context.Context, tier AccessTier, options *BlobClientSetTierOptions) (BlobClientSetTierResponse, error)

SetTier - Sets the tier of the specified blob. If the operation fails it returns an *azcore.ResponseError type.

  • tier - Indicates the tier to be set on the blob.
  • options - BlobClientSetTierOptions contains the optional parameters for the BlobClient.SetTier method.

func (*BlobClient) SetTierCreateRequest added in v1.1.0 

func (client *BlobClient) SetTierCreateRequest(ctx context.Context, tier AccessTier, options *BlobClientSetTierOptions) (*policy.Request, error)

func (*BlobClient) StartCopyFromURL 

func (client *BlobClient) StartCopyFromURL(ctx context.Context, copySource string, options *BlobClientStartCopyFromURLOptions) (BlobClientStartCopyFromURLResponse, error)

StartCopyFromURL - Starts an asynchronous copy from a source URL to a destination blob. If the operation fails it returns an *azcore.ResponseError type.

  • copySource - Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.
  • options - BlobClientStartCopyFromURLOptions contains the optional parameters for the BlobClient.StartCopyFromURL method.

func (*BlobClient) Undelete 

func (client *BlobClient) Undelete(ctx context.Context, options *BlobClientUndeleteOptions) (BlobClientUndeleteResponse, error)

Undelete - Undelete the specified previously soft deleted blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - BlobClientUndeleteOptions contains the optional parameters for the BlobClient.Undelete method.

type BlobClientAbortCopyFromURLOptions 

type BlobClientAbortCopyFromURLOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientAbortCopyFromURLOptions contains the optional parameters for the BlobClient.AbortCopyFromURL method.

type BlobClientAbortCopyFromURLResponse 

type BlobClientAbortCopyFromURLResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientAbortCopyFromURLResponse contains the response from method BlobClient.AbortCopyFromURL.

type BlobClientAcquireLeaseOptions 

type BlobClientAcquireLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The proposed lease ID for the lease.
	ProposedLeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientAcquireLeaseOptions contains the optional parameters for the BlobClient.AcquireLease method.

type BlobClientAcquireLeaseResponse 

type BlobClientAcquireLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientAcquireLeaseResponse contains the response from method BlobClient.AcquireLease.

type BlobClientBreakLeaseOptions 

type BlobClientBreakLeaseOptions struct {
	// Proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only
	// used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used.
	BreakPeriod *int32

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientBreakLeaseOptions contains the optional parameters for the BlobClient.BreakLease method.

type BlobClientBreakLeaseResponse 

type BlobClientBreakLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Approximate time remaining in the lease period, in seconds.
	LeaseTime *int32

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientBreakLeaseResponse contains the response from method BlobClient.BreakLease.

type BlobClientChangeLeaseOptions 

type BlobClientChangeLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientChangeLeaseOptions contains the optional parameters for the BlobClient.ChangeLease method.

type BlobClientChangeLeaseResponse 

type BlobClientChangeLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientChangeLeaseResponse contains the response from method BlobClient.ChangeLease.

type BlobClientCopyFromURLOptions 

type BlobClientCopyFromURLOptions struct {
	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.
	CopySourceAuthorization *string

	// Indicates if source tags should be copied or replaced with the tags specified. Default is 'Replace'.
	CopySourceTags *BlobCopySourceTags

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specifies the file request token intent.
	FileRequestIntent *FileShareTokenIntent

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.
	SourceContentMD5 []byte

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// The tier to be set on the blob.
	Tier *AccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientCopyFromURLOptions contains the optional parameters for the BlobClient.CopyFromURL method.

type BlobClientCopyFromURLResponse 

type BlobClientCopyFromURLResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Identifier for this copy operation.
	CopyID *string

	// State of the copy operation.
	CopyStatus *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientCopyFromURLResponse contains the response from method BlobClient.CopyFromURL.

type BlobClientCreateSnapshotOptions 

type BlobClientCreateSnapshotOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The metadata headers.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientCreateSnapshotOptions contains the optional parameters for the BlobClient.CreateSnapshot method.

type BlobClientCreateSnapshotResponse 

type BlobClientCreateSnapshotResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Uniquely identifies the snapshot and indicates the snapshot version.
	Snapshot *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientCreateSnapshotResponse contains the response from method BlobClient.CreateSnapshot.

type BlobClientDeleteImmutabilityPolicyOptions 

type BlobClientDeleteImmutabilityPolicyOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientDeleteImmutabilityPolicyOptions contains the optional parameters for the BlobClient.DeleteImmutabilityPolicy method.

type BlobClientDeleteImmutabilityPolicyResponse 

type BlobClientDeleteImmutabilityPolicyResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientDeleteImmutabilityPolicyResponse contains the response from method BlobClient.DeleteImmutabilityPolicy.

type BlobClientDeleteOptions 

type BlobClientDeleteOptions struct {
	// Specify this header value to operate only on a blob if the access-tier has been modified since the specified date-time.
	AccessTierIfModifiedSince *time.Time

	// Specify this header value to operate only on a blob if the access-tier has not been modified since the specified date-time.
	AccessTierIfUnmodifiedSince *time.Time

	// The delete type.
	BlobDeleteType *DeleteType

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Required if the blob has associated snapshots. Specifies the delete behavior.
	DeleteSnapshots *DeleteSnapshotsOptionType

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientDeleteOptions contains the optional parameters for the BlobClient.Delete method.

type BlobClientDeleteResponse 

type BlobClientDeleteResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientDeleteResponse contains the response from method BlobClient.Delete.

type BlobClientDownloadOptions 

type BlobClientDownloadOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the range of the blob to operate on.
	Range *string

	// When set to true and the request includes a Range header, the service returns the CRC64 hash for the range, as long as
	// the range is less than or equal to 4 MiB in size.
	RangeGetContentCRC64 *bool

	// When set to true and specified together with the `Range` header, the service returns the MD5 hash for the range, as long
	// as the range is less than or equal to 4 MiB in size.
	RangeGetContentMD5 *bool

	// Specifies the snapshot of the blob.
	Snapshot *string

	// Specifies the response content should be returned as a structured message and specifies the message schema version and
	// properties.
	StructuredBodyType *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientDownloadOptions contains the optional parameters for the BlobClient.Download method.

type BlobClientDownloadResponse 

type BlobClientDownloadResponse struct {
	// Indicates that the service supports requests for partial blob content.
	AcceptRanges *string

	// The access tier of the blob.
	AccessTier *string

	// The time the tier was changed on the blob. This is only returned if the tier on the blob was ever set.
	AccessTierChangeTime *time.Time

	// The number of committed blocks present in the blob. This header is returned only for append blobs.
	BlobCommittedBlockCount *int32

	// If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned
	// with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header,
	// with the latter calculated from the requested range
	BlobContentMD5 []byte

	// The current sequence number for a page blob. This header is not returned for block blobs or append blobs.
	BlobSequenceNumber *int64

	// The type of the blob.
	BlobType *BlobType

	// Body contains the streaming response.
	Body io.ReadCloser

	// This header is returned if it was previously specified for the blob.
	CacheControl *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// This response header is returned so that the client can check for the integrity of the copied content.
	ContentCRC64 []byte

	// This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition
	// response header field conveys additional information about how to process the response payload, and also can be used to
	// attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the
	// response, but instead show a Save As dialog with a filename other than the blob name specified.
	ContentDisposition *string

	// This header returns the value that was specified for the Content-Encoding request header
	ContentEncoding *string

	// This header returns the value that was specified for the Content-Language request header.
	ContentLanguage *string

	// The number of bytes present in the response body.
	ContentLength *int64

	// If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client
	// can check for message content integrity.
	ContentMD5 []byte

	// Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range'
	// request header.
	ContentRange *string

	// The media type of the body of the response.
	ContentType *string

	// Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify
	// the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob
	// has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob
	// operation using Set Blob Properties, Put Blob, or Put Block List.
	CopyCompletionTime *time.Time

	// String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or
	// pass to Abort Copy Blob to abort a pending copy.
	CopyID *string

	// Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this
	// blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this
	// blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy
	// Blob operation using Set Blob Properties, Put Blob, or Put Block List
	CopyProgress *string

	// URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this
	// blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation,
	// or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block
	// List.
	CopySource *string

	// State of the copy operation identified by x-ms-copy-id.
	CopyStatus *CopyStatusType

	// Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation
	// failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob
	// has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List
	CopyStatusDescription *string

	// Returns the date and time the blob was created.
	CreationTime *time.Time

	// UTC date/time value generated by the service that indicates the time at which the response was initiated
	Date *time.Time

	// ErrorCode contains the information returned from the x-ms-error-code header response.
	ErrorCode *string

	// The ETag contains a value that you can use to perform operations conditionally.
	ETag *azcore.ETag

	// The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted
	// with a customer-provided key.
	EncryptionKeySHA256 *string

	// If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned
	// with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header,
	// with the latter calculated from the requested range
	EncryptionScope *string

	// UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiresOn *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode

	// The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.
	IsCurrentVersion *bool

	// If this blob has been sealed
	IsSealed *bool

	// The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm,
	// and false otherwise.
	IsServerEncrypted *bool

	// UTC date/time value generated by the service that indicates the time at which the blob was last read or written to
	LastAccessed *time.Time

	// The date/time that the container was last modified.
	LastModified *time.Time

	// Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease
	// can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change.
	LeaseDuration *LeaseDurationType

	// Lease state of the blob.
	LeaseState *LeaseStateType

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.
	ObjectReplicationPolicyID *string

	// Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication.
	// When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and
	// the value will be the status of the replication (e.g. complete, failed).
	ObjectReplicationRules map[string]*string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Indicates the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// The length of the blob/file content inside the message body when the response body is returned as a structured message.
	// Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The number of tags associated with the blob
	TagCount *int64

	// Specifies the version of the operation to use for this request.
	Version *string

	// A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob
	// version, and may be used in subsequent requests to access this version of the blob.
	VersionID *string
}

BlobClientDownloadResponse contains the response from method BlobClient.Download.

type BlobClientDownloadResponseInternal 

type BlobClientDownloadResponseInternal struct {
	// Indicates that the service supports requests for partial blob content.
	AcceptRanges *string

	// The access tier of the blob.
	AccessTier *string

	// The time the tier was changed on the blob. This is only returned if the tier on the blob was ever set.
	AccessTierChangeTime *time.Time

	// Included if the access tier is inferred.
	AccessTierInferred *bool

	// The number of committed blocks present in the blob.
	BlobCommittedBlockCount *int32

	// MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested
	// range.
	BlobContentMD5 []byte

	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// The type of the blob.
	BlobType *BlobType

	// Body contains the streaming response.
	Body io.ReadCloser

	// The Cache-Control of the blob.
	CacheControl *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The Content-Disposition of the blob.
	ContentDisposition *string

	// The Content-Encoding of the blob.
	ContentEncoding *string

	// The Content-Language of the blob.
	ContentLanguage *string

	// The number of bytes present in the response body.
	ContentLength *int64

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Indicates the range of bytes returned in this response.
	ContentRange *string

	// The content type of the body of the response.
	ContentType *string

	// If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation.
	CopyCompletionTime *time.Time

	// Identifier for this copy operation.
	CopyID *string

	// If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source.
	CopyProgress *string

	// If this blob was the destination of a copy, specifies the source URL.
	CopySource *string

	// Status of the copy operation.
	CopyStatus *CopyStatusType

	// If this blob was the destination of a copy, specifies the cause of the copy operation failure.
	CopyStatusDescription *string

	// The date-time the blob was created.
	CreationTime *time.Time

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiresOn *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode

	// Indicates whether this is the current version of the blob.
	IsCurrentVersion *bool

	// Whether the blob is sealed.
	IsSealed *bool

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time value that indicates the time at which the blob was last read or written.
	LastAccessed *time.Time

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Specifies the duration of the lease.
	LeaseDuration *LeaseDurationType

	// The lease state of the blob.
	LeaseState *LeaseStateType

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// The object replication policy ID.
	ObjectReplicationPolicyID *string

	// The object replication status headers.
	ObjectReplicationRules map[string]*string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// The underlying tier of a smart tier blob. Only returned if the blob is in Smart tier.
	SmartAccessTier *string

	// Indicates if the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// The length of the blob/file content inside the message body when the response body is returned as a structured message.
	// Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The number of tags associated with the blob.
	TagCount *int64

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientDownloadResponseInternal contains the response from method BlobClient.Download.

type BlobClientGetAccountInfoOptions 

type BlobClientGetAccountInfoOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientGetAccountInfoOptions contains the optional parameters for the BlobClient.GetAccountInfo method.

type BlobClientGetAccountInfoResponse 

type BlobClientGetAccountInfoResponse struct {
	// The account kind.
	AccountKind *AccountKind

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// Indicates if the account has a hierarchical namespace enabled.
	IsHierarchicalNamespaceEnabled *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// The SKU name of the account.
	SKUName *SKUName

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientGetAccountInfoResponse contains the response from method BlobClient.GetAccountInfo.

type BlobClientGetPropertiesOptions 

type BlobClientGetPropertiesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientGetPropertiesOptions contains the optional parameters for the BlobClient.GetProperties method.

type BlobClientGetPropertiesResponse 

type BlobClientGetPropertiesResponse struct {
	// Indicates that the service supports requests for partial blob content.
	AcceptRanges *string

	// The access tier of the blob.
	AccessTier *string

	// The time the tier was changed on the blob. This is only returned if the tier on the blob was ever set.
	AccessTierChangeTime *time.Time

	// Included if the access tier is inferred.
	AccessTierInferred *bool

	// Included if the blob rehydrate operation is pending. Indicates the destination tier.
	ArchiveStatus *string

	// The number of committed blocks present in the blob.
	BlobCommittedBlockCount *int32

	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// The type of the blob.
	BlobType *BlobType

	// The Cache-Control of the blob.
	CacheControl *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The Content-Disposition of the blob.
	ContentDisposition *string

	// The Content-Encoding of the blob.
	ContentEncoding *string

	// The Content-Language of the blob.
	ContentLanguage *string

	// The number of bytes present in the response body.
	ContentLength *int64

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Content-type.
	ContentType *string

	// If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation.
	CopyCompletionTime *time.Time

	// Identifier for this copy operation.
	CopyID *string

	// If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source.
	CopyProgress *string

	// If this blob was the destination of a copy, specifies the source URL.
	CopySource *string

	// Status of the copy operation.
	CopyStatus *CopyStatusType

	// If this blob was the destination of a copy, specifies the cause of the copy operation failure.
	CopyStatusDescription *string

	// The date-time the blob was created.
	CreationTime *time.Time

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success.
	DestinationSnapshot *string

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// The date-time this blob will expire.
	ExpiresOn *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiresOn *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode

	// Indicates whether this is the current version of the blob.
	IsCurrentVersion *bool

	// Included if the blob is incremental copy blob.
	IsIncrementalCopy *bool

	// Whether the blob is sealed.
	IsSealed *bool

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time value that indicates the time at which the blob was last read or written.
	LastAccessed *time.Time

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Specifies the duration of the lease.
	LeaseDuration *LeaseDurationType

	// The lease state of the blob.
	LeaseState *LeaseStateType

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// The object replication policy ID.
	ObjectReplicationPolicyID *string

	// The object replication status headers.
	ObjectReplicationRules map[string]*string

	// The priority of the rehydration operation.
	RehydratePriority *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// The underlying tier of a smart tier blob. Only returned if the blob is in Smart tier.
	SmartAccessTier *string

	// The number of tags associated with the blob.
	TagCount *int64

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientGetPropertiesResponse contains the response from method BlobClient.GetProperties.

type BlobClientGetTagsOptions 

type BlobClientGetTagsOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientGetTagsOptions contains the optional parameters for the BlobClient.GetTags method.

type BlobClientGetTagsResponse 

type BlobClientGetTagsResponse struct {
	// A list of blob tags.
	BlobTags

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientGetTagsResponse contains the response from method BlobClient.GetTags.

type BlobClientReleaseLeaseOptions 

type BlobClientReleaseLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientReleaseLeaseOptions contains the optional parameters for the BlobClient.ReleaseLease method.

type BlobClientReleaseLeaseResponse 

type BlobClientReleaseLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientReleaseLeaseResponse contains the response from method BlobClient.ReleaseLease.

type BlobClientRenewLeaseOptions 

type BlobClientRenewLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientRenewLeaseOptions contains the optional parameters for the BlobClient.RenewLease method.

type BlobClientRenewLeaseResponse 

type BlobClientRenewLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientRenewLeaseResponse contains the response from method BlobClient.RenewLease.

type BlobClientSetExpiryOptions 

type BlobClientSetExpiryOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The date-time this blob will expire.
	ExpiresOn *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientSetExpiryOptions contains the optional parameters for the BlobClient.SetExpiry method.

type BlobClientSetExpiryResponse 

type BlobClientSetExpiryResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetExpiryResponse contains the response from method BlobClient.SetExpiry.

type BlobClientSetHTTPHeadersOptions 

type BlobClientSetHTTPHeadersOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientSetHTTPHeadersOptions contains the optional parameters for the BlobClient.SetHTTPHeaders method.

type BlobClientSetHTTPHeadersResponse 

type BlobClientSetHTTPHeadersResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetHTTPHeadersResponse contains the response from method BlobClient.SetHTTPHeaders.

type BlobClientSetImmutabilityPolicyOptions 

type BlobClientSetImmutabilityPolicyOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientSetImmutabilityPolicyOptions contains the optional parameters for the BlobClient.SetImmutabilityPolicy method.

type BlobClientSetImmutabilityPolicyResponse 

type BlobClientSetImmutabilityPolicyResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetImmutabilityPolicyResponse contains the response from method BlobClient.SetImmutabilityPolicy.

type BlobClientSetLegalHoldOptions 

type BlobClientSetLegalHoldOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientSetLegalHoldOptions contains the optional parameters for the BlobClient.SetLegalHold method.

type BlobClientSetLegalHoldResponse 

type BlobClientSetLegalHoldResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetLegalHoldResponse contains the response from method BlobClient.SetLegalHold.

type BlobClientSetMetadataOptions 

type BlobClientSetMetadataOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The metadata headers.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientSetMetadataOptions contains the optional parameters for the BlobClient.SetMetadata method.

type BlobClientSetMetadataResponse 

type BlobClientSetMetadataResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientSetMetadataResponse contains the response from method BlobClient.SetMetadata.

type BlobClientSetTagsOptions 

type BlobClientSetTagsOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientSetTagsOptions contains the optional parameters for the BlobClient.SetTags method.

type BlobClientSetTagsResponse 

type BlobClientSetTagsResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetTagsResponse contains the response from method BlobClient.SetTags.

type BlobClientSetTierOptions 

type BlobClientSetTierOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The priority of the rehydration operation.
	RehydratePriority *RehydratePriority

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the version ID of the blob.
	VersionID *string
}

BlobClientSetTierOptions contains the optional parameters for the BlobClient.SetTier method.

type BlobClientSetTierResponse 

type BlobClientSetTierResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientSetTierResponse contains the response from method BlobClient.SetTier.

type BlobClientStartCopyFromURLOptions 

type BlobClientStartCopyFromURLOptions struct {
	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// The priority of the rehydration operation.
	RehydratePriority *RehydratePriority

	// Overrides the sealed state of the destination blob.
	SealBlob *bool

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a source blob with matching tags.
	SourceIfTags *string

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// The tier to be set on the blob.
	Tier *AccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientStartCopyFromURLOptions contains the optional parameters for the BlobClient.StartCopyFromURL method.

type BlobClientStartCopyFromURLResponse 

type BlobClientStartCopyFromURLResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Identifier for this copy operation.
	CopyID *string

	// Status of the copy operation.
	CopyStatus *CopyStatusType

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlobClientStartCopyFromURLResponse contains the response from method BlobClient.StartCopyFromURL.

type BlobClientUndeleteOptions 

type BlobClientUndeleteOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlobClientUndeleteOptions contains the optional parameters for the BlobClient.Undelete method.

type BlobClientUndeleteResponse 

type BlobClientUndeleteResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlobClientUndeleteResponse contains the response from method BlobClient.Undelete.

type BlobCopySourceTags added in v1.2.0 

type BlobCopySourceTags string

BlobCopySourceTags - The blob copy source tags types. 

const (
	// BlobCopySourceTagsCOPY - The blob tags will be copied from the source.
	BlobCopySourceTagsCOPY BlobCopySourceTags = "COPY"
	// BlobCopySourceTagsREPLACE - The blob tags will be replaced.
	BlobCopySourceTagsREPLACE BlobCopySourceTags = "REPLACE"
)

func PossibleBlobCopySourceTagsValues added in v1.2.0 

func PossibleBlobCopySourceTagsValues() []BlobCopySourceTags

PossibleBlobCopySourceTagsValues returns the possible values for the BlobCopySourceTags const type.

type BlobFlatListSegment 

type BlobFlatListSegment struct {
	// REQUIRED; The blob items.
	BlobItems []*BlobItem `xml:"Blob"`
}

BlobFlatListSegment - The blob flat list segment.

func (BlobFlatListSegment) MarshalXML 

func (b BlobFlatListSegment) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlobFlatListSegment.

type BlobGeoReplicationStatus 

type BlobGeoReplicationStatus string

BlobGeoReplicationStatus - The geo-replication status. 

const (
	// BlobGeoReplicationStatusBootstrap - Geo-replication is bootstrap.
	BlobGeoReplicationStatusBootstrap BlobGeoReplicationStatus = "bootstrap"
	// BlobGeoReplicationStatusLive - Geo-replication is live.
	BlobGeoReplicationStatusLive BlobGeoReplicationStatus = "live"
	// BlobGeoReplicationStatusUnavailable - Geo-replication is unavailable.
	BlobGeoReplicationStatusUnavailable BlobGeoReplicationStatus = "unavailable"
)

func PossibleBlobGeoReplicationStatusValues 

func PossibleBlobGeoReplicationStatusValues() []BlobGeoReplicationStatus

PossibleBlobGeoReplicationStatusValues returns the possible values for the BlobGeoReplicationStatus const type.

type BlobHTTPHeaders 

type BlobHTTPHeaders struct {
	// Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Optional. Sets the blob's Content-Disposition header.
	BlobContentDisposition *string

	// Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentEncoding *string

	// Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentLanguage *string

	// Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks
	// were validated when each was uploaded.
	BlobContentMD5 []byte

	// Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string
}

BlobHTTPHeaders contains a group of parameters for the BlobClient.SetHTTPHeaders method.

type BlobHierarchyListSegment 

type BlobHierarchyListSegment struct {
	// REQUIRED; The blob items.
	BlobItems []*BlobItem `xml:"Blob"`

	// The blob prefixes.
	BlobPrefixes []*BlobPrefix `xml:"BlobPrefix"`
}

BlobHierarchyListSegment - Represents an array of blobs.

func (BlobHierarchyListSegment) MarshalXML 

func (b BlobHierarchyListSegment) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlobHierarchyListSegment.

type BlobItem added in v0.6.0 

type BlobItem struct {
	// REQUIRED; Whether the blob is deleted.
	Deleted *bool `xml:"Deleted"`

	// REQUIRED; The name of the blob.
	Name *string `xml:"Name"`

	// REQUIRED; The properties of the blob.
	Properties *BlobProperties `xml:"Properties"`

	// REQUIRED; The snapshot of the blob.
	Snapshot *string `xml:"Snapshot"`

	// The tags of the blob.
	BlobTags *BlobTags `xml:"Tags"`

	// Whether the blob has versions only.
	HasVersionsOnly *bool `xml:"HasVersionsOnly"`

	// Whether the blob is the current version.
	IsCurrentVersion *bool `xml:"IsCurrentVersion"`

	// The metadata of the blob.
	Metadata map[string]*string `xml:"Metadata"`

	// The object replication metadata of the blob.
	OrMetadata map[string]*string `xml:"OrMetadata"`

	// The version ID of the blob.
	VersionID *string `xml:"VersionId"`
}

BlobItem - Represents a blob.

func (*BlobItem) UnmarshalXML added in v0.6.0 

func (b *BlobItem) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type BlobItem.

type BlobModifiedAccessConditions added in v1.6.4 

type BlobModifiedAccessConditions struct {
	// Specify an ETag value to operate only on blobs with a matching value.
	IfMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has been modified since the specified date/time.
	IfModifiedSince *time.Time

	// Specify an ETag value to operate only on blobs without a matching value.
	IfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
	IfUnmodifiedSince *time.Time
}

BlobModifiedAccessConditions contains a group of parameters for the BlobClient.GetTags method.

type BlobName added in v1.2.0 

type BlobName struct {
	// The name of the blob.
	Content *string `xml:",chardata"`

	// Indicates if the blob name is encoded.
	Encoded *bool `xml:"Encoded,attr"`
}

type BlobPrefix 

type BlobPrefix struct {
	// REQUIRED; The blob name.
	Name *string `xml:"Name"`

	// REQUIRED
	Properties *BlobProperties `xml:"Properties"`
}

BlobPrefix - Represents a blob prefix.

func (*BlobPrefix) UnmarshalXML added in v1.2.0 

func (b *BlobPrefix) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type BlobPrefix.

type BlobProperties added in v0.6.0 

type BlobProperties struct {
	// REQUIRED; The blob ETag.
	ETag *azcore.ETag `xml:"Etag"`

	// REQUIRED; The date-time the blob was last modified in RFC1123 format.
	LastModified *time.Time `xml:"Last-Modified"`
	ACL          *string    `xml:"Acl"`

	// The access tier of the blob.
	AccessTier *AccessTier `xml:"AccessTier"`

	// The access tier change time of the blob.
	AccessTierChangeTime *time.Time `xml:"AccessTierChangeTime"`

	// Whether the access tier is inferred.
	AccessTierInferred *bool `xml:"AccessTierInferred"`

	// The archive status of the blob.
	ArchiveStatus *ArchiveStatus `xml:"ArchiveStatus"`

	// The sequence number of the blob.
	BlobSequenceNumber *int64 `xml:"x-ms-blob-sequence-number"`

	// The blob type.
	BlobType *BlobType `xml:"BlobType"`

	// The cache control of the blob.
	CacheControl *string `xml:"Cache-Control"`

	// The content disposition of the blob.
	ContentDisposition *string `xml:"Content-Disposition"`

	// The content encoding of the blob.
	ContentEncoding *string `xml:"Content-Encoding"`

	// The content language of the blob.
	ContentLanguage *string `xml:"Content-Language"`

	// The content length of the blob.
	ContentLength *int64 `xml:"Content-Length"`

	// The content MD5 of the blob.
	ContentMD5 []byte `xml:"Content-MD5"`

	// The content type of the blob.
	ContentType *string `xml:"Content-Type"`

	// The copy completion time of the blob.
	CopyCompletionTime *time.Time `xml:"CopyCompletionTime"`

	// The copy ID of the blob.
	CopyID *string `xml:"CopyId"`

	// The copy progress of the blob.
	CopyProgress *string `xml:"CopyProgress"`

	// The copy source of the blob.
	CopySource *string `xml:"CopySource"`

	// The copy status of the blob.
	CopyStatus *CopyStatusType `xml:"CopyStatus"`

	// The copy status description of the blob.
	CopyStatusDescription *string `xml:"CopyStatusDescription"`

	// The date-time the blob was created in RFC1123 format.
	CreationTime *time.Time `xml:"Creation-Time"`

	// Customer provided key sha256
	CustomerProvidedKeySHA256 *string `xml:"CustomerProvidedKeySha256"`

	// The time the blob was deleted.
	DeletedTime *time.Time `xml:"DeletedTime"`

	// The name of the destination snapshot.
	DestinationSnapshot *string `xml:"DestinationSnapshot"`

	// The encryption scope of the blob.
	EncryptionScope *string `xml:"EncryptionScope"`

	// The expire time of the blob.
	ExpiresOn *time.Time `xml:"Expiry-Time"`
	Group     *string    `xml:"Group"`

	// The immutability policy until time of the blob.
	ImmutabilityPolicyExpiresOn *time.Time `xml:"ImmutabilityPolicyUntilDate"`

	// The immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode `xml:"ImmutabilityPolicyMode"`

	// Whether the blob is incremental copy.
	IncrementalCopy *bool `xml:"IncrementalCopy"`

	// Whether the blob is sealed.
	IsSealed *bool `xml:"Sealed"`

	// The last access time of the blob.
	LastAccessedOn *time.Time `xml:"LastAccessTime"`

	// The lease duration of the blob.
	LeaseDuration *LeaseDurationType `xml:"LeaseDuration"`

	// The lease state of the blob.
	LeaseState *LeaseStateType `xml:"LeaseState"`

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType `xml:"LeaseStatus"`

	// Whether the blob is under legal hold.
	LegalHold   *bool   `xml:"LegalHold"`
	Owner       *string `xml:"Owner"`
	Permissions *string `xml:"Permissions"`

	// The rehydrate priority of the blob.
	RehydratePriority *RehydratePriority `xml:"RehydratePriority"`

	// The remaining retention days of the blob.
	RemainingRetentionDays *int32  `xml:"RemainingRetentionDays"`
	ResourceType           *string `xml:"ResourceType"`

	// Whether the blob is encrypted on the server.
	ServerEncrypted *bool `xml:"ServerEncrypted"`

	// The smart access tier of the blob.
	SmartAccessTier *AccessTier `xml:"SmartAccessTier"`

	// The number of tags for the blob.
	TagCount *int32 `xml:"TagCount"`
}

BlobProperties - The properties of a blob.

func (BlobProperties) MarshalXML added in v0.6.0 

func (b BlobProperties) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlobProperties.

func (*BlobProperties) UnmarshalXML added in v0.6.0 

func (b *BlobProperties) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type BlobProperties.

type BlobTag 

type BlobTag struct {
	// REQUIRED; The key of the tag.
	Key *string `xml:"Key"`

	// REQUIRED; The value of the tag.
	Value *string `xml:"Value"`
}

BlobTag - A key-value pair associated with a blob.

func (BlobTag) MarshalXML 

func (b BlobTag) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlobTag.

type BlobTags 

type BlobTags struct {
	// REQUIRED; A list of blob tags.
	BlobTagSet []*BlobTag `xml:"TagSet>Tag"`
}

BlobTags - A list of blob tags.

func (BlobTags) MarshalXML 

func (b BlobTags) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlobTags.

type BlobType 

type BlobType string

BlobType - The blob type. 

const (
	// BlobTypeAppendBlob - The blob is an append blob.
	BlobTypeAppendBlob BlobType = "AppendBlob"
	// BlobTypeBlockBlob - The blob is a block blob.
	BlobTypeBlockBlob BlobType = "BlockBlob"
	// BlobTypePageBlob - The blob is a page blob.
	BlobTypePageBlob BlobType = "PageBlob"
)

func PossibleBlobTypeValues 

func PossibleBlobTypeValues() []BlobType

PossibleBlobTypeValues returns the possible values for the BlobType const type.

type Block 

type Block struct {
	// REQUIRED; The base64 encoded block ID.
	Name *string `xml:"Name"`

	// REQUIRED; The block size in bytes.
	Size *int64 `xml:"Size"`
}

Block - Represents a single block in a block blob.

type BlockBlobClient 

type BlockBlobClient struct {
	// contains filtered or unexported fields
}

BlockBlobClient contains the methods for the BlockBlob group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewBlockBlobClient 

func NewBlockBlobClient(endpoint string, azClient *azcore.Client) *BlockBlobClient

NewBlockBlobClient creates a new instance of BlockBlobClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*BlockBlobClient) CommitBlockList 

func (client *BlockBlobClient) CommitBlockList(ctx context.Context, blocks BlockLookupList, options *BlockBlobClientCommitBlockListOptions) (BlockBlobClientCommitBlockListResponse, error)

CommitBlockList - Writes to the block blob by specifying the list of block IDs that make up the blob. If the operation fails it returns an *azcore.ResponseError type.

  • blocks - Blob blocks.
  • options - BlockBlobClientCommitBlockListOptions contains the optional parameters for the BlockBlobClient.CommitBlockList method.

func (*BlockBlobClient) Endpoint 

func (client *BlockBlobClient) Endpoint() string

func (*BlockBlobClient) GetBlockList 

func (client *BlockBlobClient) GetBlockList(ctx context.Context, listType BlockListType, options *BlockBlobClientGetBlockListOptions) (BlockBlobClientGetBlockListResponse, error)

GetBlockList - Retrieves the list of blocks that have been uploaded as part of the block blob. If the operation fails it returns an *azcore.ResponseError type.

  • listType - Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.
  • options - BlockBlobClientGetBlockListOptions contains the optional parameters for the BlockBlobClient.GetBlockList method.

func (*BlockBlobClient) Internal added in v1.2.0 

func (client *BlockBlobClient) Internal() *azcore.Client

func (*BlockBlobClient) Query 

func (client *BlockBlobClient) Query(ctx context.Context, queryRequest QueryRequest, options *BlockBlobClientQueryOptions) (BlockBlobClientQueryResponse, error)

Query - Queries the data of the specified blob with the provided query expressions. If the operation fails it returns an *azcore.ResponseError type.

  • queryRequest - The query request.
  • options - BlockBlobClientQueryOptions contains the optional parameters for the BlockBlobClient.Query method.

func (*BlockBlobClient) StageBlock 

func (client *BlockBlobClient) StageBlock(ctx context.Context, blockID string, contentLength int64, body io.ReadSeekCloser, options *BlockBlobClientStageBlockOptions) (BlockBlobClientStageBlockResponse, error)

StageBlock - Creates a new block of data to be committed as part of a blob. If the operation fails it returns an *azcore.ResponseError type.

  • blockID - A Base64 value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block.
  • contentLength - The length of the request.
  • body - The body of the request.
  • options - BlockBlobClientStageBlockOptions contains the optional parameters for the BlockBlobClient.StageBlock method.

func (*BlockBlobClient) StageBlockFromURL 

func (client *BlockBlobClient) StageBlockFromURL(ctx context.Context, blockID string, contentLength int64, sourceURL string, options *BlockBlobClientStageBlockFromURLOptions) (BlockBlobClientStageBlockFromURLResponse, error)

StageBlockFromURL - Creates a new block of data from the specified URL to be committed as part of a blob. If the operation fails it returns an *azcore.ResponseError type.

  • blockID - A Base64 value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block.
  • contentLength - The length of the request.
  • sourceURL - Specifies the URL of the source.
  • options - BlockBlobClientStageBlockFromURLOptions contains the optional parameters for the BlockBlobClient.StageBlockFromURL method.

func (*BlockBlobClient) Upload 

func (client *BlockBlobClient) Upload(ctx context.Context, body io.ReadSeekCloser, contentLength int64, options *BlockBlobClientUploadOptions) (BlockBlobClientUploadResponse, error)

Upload - Uploads the content to the specified block blob. If the blob already exists, the data and any existing metadata will be overwritten. If the operation fails it returns an *azcore.ResponseError type.

  • body - The body of the request.
  • contentLength - The length of the request.
  • options - BlockBlobClientUploadOptions contains the optional parameters for the BlockBlobClient.Upload method.

func (*BlockBlobClient) UploadBlobFromURL 

func (client *BlockBlobClient) UploadBlobFromURL(ctx context.Context, copySource string, options *BlockBlobClientUploadBlobFromURLOptions) (BlockBlobClientUploadBlobFromURLResponse, error)

UploadBlobFromURL - Uploads the content from the specified URL to the block blob. If the blob already exists, the data and any existing metadata will be overwritten. If the operation fails it returns an *azcore.ResponseError type.

  • copySource - Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.
  • options - BlockBlobClientUploadBlobFromURLOptions contains the optional parameters for the BlockBlobClient.UploadBlobFromURL method.

type BlockBlobClientCommitBlockListOptions 

type BlockBlobClientCommitBlockListOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// The tier to be set on the blob.
	Tier *AccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

BlockBlobClientCommitBlockListOptions contains the optional parameters for the BlockBlobClient.CommitBlockList method.

type BlockBlobClientCommitBlockListResponse 

type BlockBlobClientCommitBlockListResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlockBlobClientCommitBlockListResponse contains the response from method BlockBlobClient.CommitBlockList.

type BlockBlobClientGetBlockListOptions 

type BlockBlobClientGetBlockListOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlockBlobClientGetBlockListOptions contains the optional parameters for the BlockBlobClient.GetBlockList method.

type BlockBlobClientGetBlockListResponse 

type BlockBlobClientGetBlockListResponse struct {
	// Contains the committed and uncommitted blocks in a block blob.
	BlockList

	// The size of the blob in bytes.
	BlobContentLength *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlockBlobClientGetBlockListResponse contains the response from method BlockBlobClient.GetBlockList.

type BlockBlobClientQueryOptions 

type BlockBlobClientQueryOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlockBlobClientQueryOptions contains the optional parameters for the BlockBlobClient.Query method.

type BlockBlobClientQueryResponse 

type BlockBlobClientQueryResponse struct {
	// Indicates that the service supports requests for partial blob content.
	AcceptRanges *string

	// The number of committed blocks present in the blob.
	BlobCommittedBlockCount *int32

	// MD5 hash of the full blob content only returned for ranged reads. This is the hash of the complete blob, not just the requested
	// range.
	BlobContentMD5 []byte

	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// The type of the blob.
	BlobType *BlobType

	// Body contains the streaming response.
	Body io.ReadCloser

	// The Cache-Control of the blob.
	CacheControl *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The Content-Disposition of the blob.
	ContentDisposition *string

	// The Content-Encoding of the blob.
	ContentEncoding *string

	// The Content-Language of the blob.
	ContentLanguage *string

	// The number of bytes present in the response body.
	ContentLength *int64

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Indicates the range of bytes returned in this response.
	ContentRange *string

	// Content-Type header
	ContentType *string

	// If this blob was the destination of a copy, specifies the completion time of the last attempted copy operation.
	CopyCompletionTime *time.Time

	// Identifier for this copy operation.
	CopyID *string

	// If this blob was the destination of a copy, specifies the number of bytes copied and the total bytes in the source.
	CopyProgress *string

	// If this blob was the destination of a copy, specifies the source URL.
	CopySource *string

	// Status of the copy operation.
	CopyStatus *CopyStatusType

	// If this blob was the destination of a copy, specifies the cause of the copy operation failure.
	CopyStatusDescription *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Specifies the duration of the lease.
	LeaseDuration *LeaseDurationType

	// The lease state of the blob.
	LeaseState *LeaseStateType

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType

	// The metadata headers.
	Metadata map[string]*string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlockBlobClientQueryResponse contains the response from method BlockBlobClient.Query.

type BlockBlobClientStageBlockFromURLOptions 

type BlockBlobClientStageBlockFromURLOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.
	CopySourceAuthorization *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specifies the file request token intent.
	FileRequestIntent *FileShareTokenIntent

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the CRC64 calculated for the range of bytes that must be read from the source.
	SourceContentCRC64 []byte

	// Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.
	SourceContentMD5 []byte

	// The algorithm used to produce the source encryption key hash. Must be provided if the source encryption key is provided.
	SourceEncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to decrypt the source data provided in the request.
	SourceEncryptionKey *string

	// The SHA-256 hash of the provided source encryption key. Must be provided if the source encryption key is provided.
	SourceEncryptionKeySHA256 *string

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// Specifies the bytes of the source.
	SourceRange *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

BlockBlobClientStageBlockFromURLOptions contains the optional parameters for the BlockBlobClient.StageBlockFromURL method.

func (*BlockBlobClientStageBlockFromURLOptions) SetSourceContentCRC64 added in v0.6.0 

func (b *BlockBlobClientStageBlockFromURLOptions) SetSourceContentCRC64(v []byte)

func (*BlockBlobClientStageBlockFromURLOptions) SetSourceContentMD5 added in v0.6.0 

func (b *BlockBlobClientStageBlockFromURLOptions) SetSourceContentMD5(v []byte)

type BlockBlobClientStageBlockFromURLResponse 

type BlockBlobClientStageBlockFromURLResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlockBlobClientStageBlockFromURLResponse contains the response from method BlockBlobClient.StageBlockFromURL.

type BlockBlobClientStageBlockOptions 

type BlockBlobClientStageBlockOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Required if the request body is a structured message. Specifies the message schema version and properties.
	StructuredBodyType *string

	// Required if the request body is a structured message. Specifies the length of the blob/file content inside the message
	// body. Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

BlockBlobClientStageBlockOptions contains the optional parameters for the BlockBlobClient.StageBlock method.

func (*BlockBlobClientStageBlockOptions) SetCRC64 added in v0.6.0 

func (b *BlockBlobClientStageBlockOptions) SetCRC64(v []byte)

func (*BlockBlobClientStageBlockOptions) SetMD5 added in v0.6.0 

func (b *BlockBlobClientStageBlockOptions) SetMD5(v []byte)

func (*BlockBlobClientStageBlockOptions) SetStructuredBody 

func (b *BlockBlobClientStageBlockOptions) SetStructuredBody(bodyType string, contentLength int64)

type BlockBlobClientStageBlockResponse 

type BlockBlobClientStageBlockResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Indicates if the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

BlockBlobClientStageBlockResponse contains the response from method BlockBlobClient.StageBlock.

type BlockBlobClientUploadBlobFromURLOptions 

type BlockBlobClientUploadBlobFromURLOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.
	CopySourceAuthorization *string

	// Indicates if properties from the source blob should be copied. Default is true.
	CopySourceBlobProperties *bool

	// Indicates if source tags should be copied or replaced with the tags specified. Default is 'Replace'.
	CopySourceTags *BlobCopySourceTags

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specifies the file request token intent.
	FileRequestIntent *FileShareTokenIntent

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The metadata headers.
	Metadata map[string]*string

	// Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.
	SourceContentMD5 []byte

	// The algorithm used to produce the source encryption key hash. Must be provided if the source encryption key is provided.
	SourceEncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to decrypt the source data provided in the request.
	SourceEncryptionKey *string

	// The SHA-256 hash of the provided source encryption key. Must be provided if the source encryption key is provided.
	SourceEncryptionKeySHA256 *string

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a source blob with matching tags.
	SourceIfTags *string

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// The tier to be set on the blob.
	Tier *AccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

BlockBlobClientUploadBlobFromURLOptions contains the optional parameters for the BlockBlobClient.UploadBlobFromURL method.

type BlockBlobClientUploadBlobFromURLResponse 

type BlockBlobClientUploadBlobFromURLResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlockBlobClientUploadBlobFromURLResponse contains the response from method BlockBlobClient.UploadBlobFromURL.

type BlockBlobClientUploadOptions 

type BlockBlobClientUploadOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// Required if the request body is a structured message. Specifies the message schema version and properties.
	StructuredBodyType *string

	// Required if the request body is a structured message. Specifies the length of the blob/file content inside the message
	// body. Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The tier to be set on the blob.
	Tier *AccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

BlockBlobClientUploadOptions contains the optional parameters for the BlockBlobClient.Upload method.

func (*BlockBlobClientUploadOptions) SetCRC64 added in v1.2.0 

func (b *BlockBlobClientUploadOptions) SetCRC64(v []byte)

func (*BlockBlobClientUploadOptions) SetMD5 added in v1.2.0 

func (b *BlockBlobClientUploadOptions) SetMD5(v []byte)

func (*BlockBlobClientUploadOptions) SetStructuredBody 

func (b *BlockBlobClientUploadOptions) SetStructuredBody(bodyType string, contentLength int64)

type BlockBlobClientUploadResponse 

type BlockBlobClientUploadResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Indicates if the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

BlockBlobClientUploadResponse contains the response from method BlockBlobClient.Upload.

type BlockList 

type BlockList struct {
	// The list of committed blocks.
	CommittedBlocks []*Block `xml:"CommittedBlocks>Block"`

	// The list of uncommitted blocks.
	UncommittedBlocks []*Block `xml:"UncommittedBlocks>Block"`
}

BlockList - Contains the committed and uncommitted blocks in a block blob.

func (BlockList) MarshalXML 

func (b BlockList) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlockList.

type BlockListType 

type BlockListType string

BlockListType - The block list types. 

const (
	// BlockListTypeAll - Both committed and uncommitted blocks.
	BlockListTypeAll BlockListType = "all"
	// BlockListTypeCommitted - Committed blocks.
	BlockListTypeCommitted BlockListType = "committed"
	// BlockListTypeUncommitted - Uncommitted blocks.
	BlockListTypeUncommitted BlockListType = "uncommitted"
)

func PossibleBlockListTypeValues 

func PossibleBlockListTypeValues() []BlockListType

PossibleBlockListTypeValues returns the possible values for the BlockListType const type.

type BlockLookupList 

type BlockLookupList struct {
	// The committed blocks.
	Committed []*string `xml:"Committed"`

	// The latest blocks.
	Latest []*string `xml:"Latest"`

	// The uncommitted blocks.
	Uncommitted []*string `xml:"Uncommitted"`
}

BlockLookupList - The block lookup list.

func (BlockLookupList) MarshalXML 

func (b BlockLookupList) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type BlockLookupList.

type CORSRule added in v1.0.0 

type CORSRule struct {
	// REQUIRED; The allowed headers.
	AllowedHeaders *string `xml:"AllowedHeaders"`

	// REQUIRED; The allowed methods.
	AllowedMethods *string `xml:"AllowedMethods"`

	// REQUIRED; The allowed origins.
	AllowedOrigins *string `xml:"AllowedOrigins"`

	// REQUIRED; The exposed headers.
	ExposedHeaders *string `xml:"ExposedHeaders"`

	// REQUIRED; The maximum age in seconds.
	MaxAgeInSeconds *int32 `xml:"MaxAgeInSeconds"`
}

CORSRule - A Cross-Origin Resource Sharing (CORS) rule.

func (CORSRule) MarshalXML 

func (c CORSRule) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type CORSRule.

type CPKInfo added in v1.0.0 

type CPKInfo struct {
	// The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided
	// if the x-ms-encryption-key header is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption
	// is performed with the root account encryption key. For more information, see
	// Encryption at Rest for Azure Storage Services.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.
	EncryptionKeySHA256 *string
}

CPKInfo contains a group of parameters for the BlobClient.Download method.

type CPKScopeInfo added in v1.0.0 

type CPKScopeInfo struct {
	// Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided
	// in the request. If not specified, encryption is performed with the default
	// account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.
	EncryptionScope *string
}

CPKScopeInfo contains a group of parameters for the BlobClient.SetMetadata method.

type ClearRange 

type ClearRange struct {
	// REQUIRED; The end of the byte range.
	End *int64 `xml:"End"`

	// REQUIRED; The start of the byte range.
	Start *int64 `xml:"Start"`
}

ClearRange - A clear range.

type ContainerCPKScopeInfo added in v1.0.0 

type ContainerCPKScopeInfo struct {
	// Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all
	// future writes.
	DefaultEncryptionScope *string

	// Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than
	// the scope set on the container.
	PreventEncryptionScopeOverride *bool
}

ContainerCPKScopeInfo contains a group of parameters for the ContainerClient.Create method.

type ContainerClient 

type ContainerClient struct {
	// contains filtered or unexported fields
}

ContainerClient contains the methods for the Container group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewContainerClient 

func NewContainerClient(endpoint string, azClient *azcore.Client) *ContainerClient

func (*ContainerClient) AcquireLease 

func (client *ContainerClient) AcquireLease(ctx context.Context, duration int32, options *ContainerClientAcquireLeaseOptions) (ContainerClientAcquireLeaseResponse, error)

AcquireLease - Requests a new lease on the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • duration - Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds.
  • options - ContainerClientAcquireLeaseOptions contains the optional parameters for the ContainerClient.AcquireLease method.

func (*ContainerClient) BreakLease 

func (client *ContainerClient) BreakLease(ctx context.Context, options *ContainerClientBreakLeaseOptions) (ContainerClientBreakLeaseResponse, error)

BreakLease - Ends a lease and ensures that another client can't acquire a new lease until the current lease period has expired. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientBreakLeaseOptions contains the optional parameters for the ContainerClient.BreakLease method.

func (*ContainerClient) ChangeLease 

func (client *ContainerClient) ChangeLease(ctx context.Context, leaseID string, proposedLeaseID string, options *ContainerClientChangeLeaseOptions) (ContainerClientChangeLeaseResponse, error)

ChangeLease - Change the ID of an existing lease. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • proposedLeaseID - The proposed lease ID for the lease.
  • options - ContainerClientChangeLeaseOptions contains the optional parameters for the ContainerClient.ChangeLease method.

func (*ContainerClient) Create 

func (client *ContainerClient) Create(ctx context.Context, options *ContainerClientCreateOptions) (ContainerClientCreateResponse, error)

Create - Creates a new container in the specified account. If the container with the same name already exists, the operation fails. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientCreateOptions contains the optional parameters for the ContainerClient.Create method.

func (*ContainerClient) Delete 

func (client *ContainerClient) Delete(ctx context.Context, options *ContainerClientDeleteOptions) (ContainerClientDeleteResponse, error)

Delete - Deletes the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientDeleteOptions contains the optional parameters for the ContainerClient.Delete method.

func (*ContainerClient) Endpoint 

func (client *ContainerClient) Endpoint() string

func (*ContainerClient) FilterBlobs added in v1.2.0 

func (client *ContainerClient) FilterBlobs(ctx context.Context, filterExpression string, options *ContainerClientFilterBlobsOptions) (ContainerClientFilterBlobsResponse, error)

FilterBlobs - Lists blobs in the specified container whose tags match a given search expression. If the operation fails it returns an *azcore.ResponseError type.

  • filterExpression - Filters the results to return only blobs whose tags match the specified expression.
  • options - ContainerClientFilterBlobsOptions contains the optional parameters for the ContainerClient.FilterBlobs method.

func (*ContainerClient) GetAccessPolicy 

func (client *ContainerClient) GetAccessPolicy(ctx context.Context, options *ContainerClientGetAccessPolicyOptions) (ContainerClientGetAccessPolicyResponse, error)

GetAccessPolicy - Gets the permissions for the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientGetAccessPolicyOptions contains the optional parameters for the ContainerClient.GetAccessPolicy method.

func (*ContainerClient) GetAccountInfo 

func (client *ContainerClient) GetAccountInfo(ctx context.Context, options *ContainerClientGetAccountInfoOptions) (ContainerClientGetAccountInfoResponse, error)

GetAccountInfo - Returns information about the storage account. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientGetAccountInfoOptions contains the optional parameters for the ContainerClient.GetAccountInfo method.

func (*ContainerClient) GetProperties 

func (client *ContainerClient) GetProperties(ctx context.Context, options *ContainerClientGetPropertiesOptions) (ContainerClientGetPropertiesResponse, error)

GetProperties - Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientGetPropertiesOptions contains the optional parameters for the ContainerClient.GetProperties method.

func (*ContainerClient) InternalClient added in v1.2.0 

func (client *ContainerClient) InternalClient() *azcore.Client

func (*ContainerClient) ListBlobFlatSegment 

func (client *ContainerClient) ListBlobFlatSegment(ctx context.Context, options *ContainerClientListBlobFlatSegmentOptions) (ContainerClientListBlobFlatSegmentResponse, error)

ListBlobFlatSegment - Returns a list of the blobs in the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientListBlobFlatSegmentOptions contains the optional parameters for the ContainerClient.ListBlobFlatSegment method.

func (*ContainerClient) ListBlobFlatSegmentApacheArrow 

func (client *ContainerClient) ListBlobFlatSegmentApacheArrow(ctx context.Context, options *ContainerClientListBlobFlatSegmentApacheArrowOptions) (ContainerClientListBlobFlatSegmentApacheArrowResponse, error)

ListBlobFlatSegmentApacheArrow - Returns a list of the blobs in Apache Arrow format as raw data, to be deserialized by the client. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientListBlobFlatSegmentApacheArrowOptions contains the optional parameters for the ContainerClient.ListBlobFlatSegmentApacheArrow method.

func (*ContainerClient) ListBlobFlatSegmentApacheArrowCreateRequest 

func (client *ContainerClient) ListBlobFlatSegmentApacheArrowCreateRequest(ctx context.Context, options *ContainerClientListBlobFlatSegmentApacheArrowOptions) (*policy.Request, error)

NewContainerClient creates a new instance of ContainerClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • pl - the pipeline used for sending requests and handling responses.

func (*ContainerClient) ListBlobFlatSegmentApacheArrowHandleResponse 

func (client *ContainerClient) ListBlobFlatSegmentApacheArrowHandleResponse(resp *http.Response) (ContainerClientListBlobFlatSegmentApacheArrowResponse, error)

func (*ContainerClient) ListBlobFlatSegmentCreateRequest 

func (client *ContainerClient) ListBlobFlatSegmentCreateRequest(ctx context.Context, options *ContainerClientListBlobFlatSegmentOptions) (*policy.Request, error)

ListBlobFlatSegmentCreateRequest creates the ListBlobFlatSegment request.

func (*ContainerClient) ListBlobFlatSegmentHandleResponse 

func (client *ContainerClient) ListBlobFlatSegmentHandleResponse(resp *http.Response, successCodes ...int) (ContainerClientListBlobFlatSegmentResponse, error)

ListBlobFlatSegmentHandleResponse handles the ListBlobFlatSegment response.

func (*ContainerClient) ListBlobHierarchySegmentApacheArrow 

func (client *ContainerClient) ListBlobHierarchySegmentApacheArrow(ctx context.Context, delimiter string, options *ContainerClientListBlobHierarchySegmentApacheArrowOptions) (ContainerClientListBlobHierarchySegmentApacheArrowResponse, error)

ListBlobHierarchySegmentApacheArrow - Returns a list of the blobs in Apache Arrow format as raw data, to be deserialized by the client. A delimiter can be used to traverse a virtual hierarchy of blobs as though it were a file system. If the operation fails it returns an *azcore.ResponseError type.

  • delimiter - If specified, the operation returns a BlobPrefix element that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
  • options - ContainerClientListBlobHierarchySegmentApacheArrowOptions contains the optional parameters for the ContainerClient.ListBlobHierarchySegmentApacheArrow method.

func (*ContainerClient) ListBlobHierarchySegmentApacheArrowCreateRequest 

func (client *ContainerClient) ListBlobHierarchySegmentApacheArrowCreateRequest(ctx context.Context, delimiter string, options *ContainerClientListBlobHierarchySegmentApacheArrowOptions) (*policy.Request, error)

func (*ContainerClient) ListBlobHierarchySegmentApacheArrowHandleResponse 

func (client *ContainerClient) ListBlobHierarchySegmentApacheArrowHandleResponse(resp *http.Response) (ContainerClientListBlobHierarchySegmentApacheArrowResponse, error)

func (*ContainerClient) ListBlobHierarchySegmentCreateRequest 

func (client *ContainerClient) ListBlobHierarchySegmentCreateRequest(ctx context.Context, delimiter string, options *ContainerClientListBlobHierarchySegmentOptions) (*policy.Request, error)

ListBlobHierarchySegmentCreateRequest creates the ListBlobHierarchySegment request.

func (*ContainerClient) ListBlobHierarchySegmentHandleResponse 

func (client *ContainerClient) ListBlobHierarchySegmentHandleResponse(resp *http.Response, successCodes ...int) (ContainerClientListBlobHierarchySegmentResponse, error)

ListBlobHierarchySegmentHandleResponse handles the ListBlobHierarchySegment response.

func (*ContainerClient) NewListBlobHierarchySegmentPager 

func (client *ContainerClient) NewListBlobHierarchySegmentPager(delimiter string, options *ContainerClientListBlobHierarchySegmentOptions) *runtime.Pager[ContainerClientListBlobHierarchySegmentResponse]

NewListBlobHierarchySegmentPager - Returns a list of the blobs in the specified container. A delimiter can be used to traverse a virtual hierarchy of blobs as though it were a file system.

  • delimiter - If specified, the operation returns a BlobPrefix element that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
  • options - ContainerClientListBlobHierarchySegmentOptions contains the optional parameters for the ContainerClient.NewListBlobHierarchySegmentPager method.

func (*ContainerClient) ReleaseLease 

func (client *ContainerClient) ReleaseLease(ctx context.Context, leaseID string, options *ContainerClientReleaseLeaseOptions) (ContainerClientReleaseLeaseResponse, error)

ReleaseLease - Frees the lease if it's no longer needed, so that another client can immediately acquire a lease against the container. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • options - ContainerClientReleaseLeaseOptions contains the optional parameters for the ContainerClient.ReleaseLease method.

func (*ContainerClient) Rename 

func (client *ContainerClient) Rename(ctx context.Context, sourceContainerName string, options *ContainerClientRenameOptions) (ContainerClientRenameResponse, error)

Rename - Renames the specified existing container. If the operation fails it returns an *azcore.ResponseError type.

  • sourceContainerName - Specifies the name of the container to rename.
  • options - ContainerClientRenameOptions contains the optional parameters for the ContainerClient.Rename method.

func (*ContainerClient) RenewLease 

func (client *ContainerClient) RenewLease(ctx context.Context, leaseID string, options *ContainerClientRenewLeaseOptions) (ContainerClientRenewLeaseResponse, error)

RenewLease - Renews an existing lease. If the operation fails it returns an *azcore.ResponseError type.

  • leaseID - A lease ID for the resource. The resource must have an active lease and the lease ID must match.
  • options - ContainerClientRenewLeaseOptions contains the optional parameters for the ContainerClient.RenewLease method.

func (*ContainerClient) Restore 

func (client *ContainerClient) Restore(ctx context.Context, options *ContainerClientRestoreOptions) (ContainerClientRestoreResponse, error)

Restore - Restores the specified previously-deleted container. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientRestoreOptions contains the optional parameters for the ContainerClient.Restore method.

func (*ContainerClient) SetAccessPolicy 

func (client *ContainerClient) SetAccessPolicy(ctx context.Context, containerACL []*SignedIdentifier, options *ContainerClientSetAccessPolicyOptions) (ContainerClientSetAccessPolicyResponse, error)

SetAccessPolicy - Sets the permissions for the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • containerACL - The access control list for the container.
  • options - ContainerClientSetAccessPolicyOptions contains the optional parameters for the ContainerClient.SetAccessPolicy method.

func (*ContainerClient) SetMetadata 

func (client *ContainerClient) SetMetadata(ctx context.Context, options *ContainerClientSetMetadataOptions) (ContainerClientSetMetadataResponse, error)

SetMetadata - Sets user-defined metadata for the specified container. If the operation fails it returns an *azcore.ResponseError type.

  • options - ContainerClientSetMetadataOptions contains the optional parameters for the ContainerClient.SetMetadata method.

func (*ContainerClient) SubmitBatch 

func (client *ContainerClient) SubmitBatch(ctx context.Context, multipartContentType string, contentLength int64, body io.ReadSeekCloser, options *ContainerClientSubmitBatchOptions) (ContainerClientSubmitBatchResponse, error)

SubmitBatch - Allows multiple API calls to be embedded into a single HTTP request. If the operation fails it returns an *azcore.ResponseError type.

  • multipartContentType - The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
  • contentLength - The length of the request.
  • body - The body of the request.
  • options - ContainerClientSubmitBatchOptions contains the optional parameters for the ContainerClient.SubmitBatch method.

type ContainerClientAcquireLeaseOptions 

type ContainerClientAcquireLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The proposed lease ID for the lease.
	ProposedLeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientAcquireLeaseOptions contains the optional parameters for the ContainerClient.AcquireLease method.

type ContainerClientAcquireLeaseResponse 

type ContainerClientAcquireLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientAcquireLeaseResponse contains the response from method ContainerClient.AcquireLease.

type ContainerClientBreakLeaseOptions 

type ContainerClientBreakLeaseOptions struct {
	// Proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only
	// used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used.
	BreakPeriod *int32

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientBreakLeaseOptions contains the optional parameters for the ContainerClient.BreakLease method.

type ContainerClientBreakLeaseResponse 

type ContainerClientBreakLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Approximate time remaining in the lease period, in seconds.
	LeaseTime *int32

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientBreakLeaseResponse contains the response from method ContainerClient.BreakLease.

type ContainerClientChangeLeaseOptions 

type ContainerClientChangeLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientChangeLeaseOptions contains the optional parameters for the ContainerClient.ChangeLease method.

type ContainerClientChangeLeaseResponse 

type ContainerClientChangeLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientChangeLeaseResponse contains the response from method ContainerClient.ChangeLease.

type ContainerClientCreateOptions 

type ContainerClientCreateOptions struct {
	// The public access setting for the container.
	Access *PublicAccessType

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies the default encryption scope to set on the container and use for all future requests.
	DefaultEncryptionScope *string

	// The metadata headers.
	Metadata map[string]*string

	// Whether to prevent encryption scope override.
	PreventEncryptionScopeOverride *bool

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientCreateOptions contains the optional parameters for the ContainerClient.Create method.

type ContainerClientCreateResponse 

type ContainerClientCreateResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientCreateResponse contains the response from method ContainerClient.Create.

type ContainerClientDeleteOptions 

type ContainerClientDeleteOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientDeleteOptions contains the optional parameters for the ContainerClient.Delete method.

type ContainerClientDeleteResponse 

type ContainerClientDeleteResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientDeleteResponse contains the response from method ContainerClient.Delete.

type ContainerClientFilterBlobsOptions added in v1.2.0 

type ContainerClientFilterBlobsOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify to include additional, optional information.
	Include []FilterBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientFilterBlobsOptions contains the optional parameters for the ContainerClient.FilterBlobs method.

type ContainerClientFilterBlobsResponse added in v1.2.0 

type ContainerClientFilterBlobsResponse struct {
	// The result of the Find Blobs by Tags API.
	FilterBlobSegment

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientFilterBlobsResponse contains the response from method ContainerClient.FilterBlobs.

type ContainerClientGetAccessPolicyOptions 

type ContainerClientGetAccessPolicyOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientGetAccessPolicyOptions contains the optional parameters for the ContainerClient.GetAccessPolicy method.

type ContainerClientGetAccessPolicyResponse 

type ContainerClientGetAccessPolicyResponse struct {
	// The public access setting for the container.
	BlobPublicAccess *PublicAccessType

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID         *string
	SignedIdentifiers []*SignedIdentifier `xml:"SignedIdentifier"`

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientGetAccessPolicyResponse contains the response from method ContainerClient.GetAccessPolicy.

type ContainerClientGetAccountInfoOptions 

type ContainerClientGetAccountInfoOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientGetAccountInfoOptions contains the optional parameters for the ContainerClient.GetAccountInfo method.

type ContainerClientGetAccountInfoResponse 

type ContainerClientGetAccountInfoResponse struct {
	// The account kind.
	AccountKind *AccountKind

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// Indicates if the account has a hierarchical namespace enabled.
	IsHierarchicalNamespaceEnabled *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// The SKU name of the account.
	SKUName *SKUName

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientGetAccountInfoResponse contains the response from method ContainerClient.GetAccountInfo.

type ContainerClientGetPropertiesOptions 

type ContainerClientGetPropertiesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientGetPropertiesOptions contains the optional parameters for the ContainerClient.GetProperties method.

type ContainerClientGetPropertiesResponse 

type ContainerClientGetPropertiesResponse struct {
	// The public access setting for the container.
	BlobPublicAccess *PublicAccessType

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// The default encryption scope for the container.
	DefaultEncryptionScope *string

	// Whether to prevent encryption scope override.
	DenyEncryptionScopeOverride *bool

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// Indicates whether the container has an immutability policy set on it.
	HasImmutabilityPolicy *bool

	// Indicates whether the container has a legal hold.
	HasLegalHold *bool

	// Indicates whether version level WORM (Write Once, Read Many) is enabled on a container.
	IsImmutableStorageWithVersioningEnabled *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Specifies the duration of the lease.
	LeaseDuration *LeaseDurationType

	// The lease state of the blob.
	LeaseState *LeaseStateType

	// The lease status of the blob.
	LeaseStatus *LeaseStatusType

	// The metadata headers.
	Metadata map[string]*string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientGetPropertiesResponse contains the response from method ContainerClient.GetProperties.

type ContainerClientListBlobFlatSegmentApacheArrowOptions 

type ContainerClientListBlobFlatSegmentApacheArrowOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Filters the results to return only names that are ordered before this value. Currently only applies to Apache Arrow scenario.
	EndBefore *string

	// Specify to include additional, optional information.
	Include []ListBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Filters the results to return only resources whose name begins with the specified prefix.
	Prefix *string

	// Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; for recursive
	// list, multiple entity levels are supported. (Inclusive)
	StartFrom *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientListBlobFlatSegmentApacheArrowOptions contains the optional parameters for the ContainerClient.ListBlobFlatSegmentApacheArrow method.

type ContainerClientListBlobFlatSegmentApacheArrowResponse 

type ContainerClientListBlobFlatSegmentApacheArrowResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *ListBlobFlatSegmentApacheArrowResponseContentType

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientListBlobFlatSegmentApacheArrowResponse contains the response from method ContainerClient.ListBlobFlatSegmentApacheArrow.

type ContainerClientListBlobFlatSegmentOptions 

type ContainerClientListBlobFlatSegmentOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify to include additional, optional information.
	Include []ListBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Filters the results to return only resources whose name begins with the specified prefix.
	Prefix *string

	// Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; for recursive
	// list, multiple entity levels are supported. (Inclusive)
	StartFrom *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientListBlobFlatSegmentOptions contains the optional parameters for the ContainerClient.ListBlobFlatSegment method.

type ContainerClientListBlobFlatSegmentResponse 

type ContainerClientListBlobFlatSegmentResponse struct {
	// The result of the List Blobs API.
	ListBlobsFlatSegmentResponse

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientListBlobFlatSegmentResponse contains the response from method ContainerClient.ListBlobFlatSegment.

type ContainerClientListBlobHierarchySegmentApacheArrowOptions 

type ContainerClientListBlobHierarchySegmentApacheArrowOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Filters the results to return only names that are ordered before this value. Currently only applies to Apache Arrow scenario.
	EndBefore *string

	// Specify to include additional, optional information.
	Include []ListBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Filters the results to return only resources whose name begins with the specified prefix.
	Prefix *string

	// Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; for recursive
	// list, multiple entity levels are supported. (Inclusive)
	StartFrom *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientListBlobHierarchySegmentApacheArrowOptions contains the optional parameters for the ContainerClient.ListBlobHierarchySegmentApacheArrow method.

type ContainerClientListBlobHierarchySegmentApacheArrowResponse 

type ContainerClientListBlobHierarchySegmentApacheArrowResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *ListBlobHierarchySegmentApacheArrowResponseContentType

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientListBlobHierarchySegmentApacheArrowResponse contains the response from method ContainerClient.ListBlobHierarchySegmentApacheArrow.

type ContainerClientListBlobHierarchySegmentOptions 

type ContainerClientListBlobHierarchySegmentOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify to include additional, optional information.
	Include []ListBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Filters the results to return only resources whose name begins with the specified prefix.
	Prefix *string

	// Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; for recursive
	// list, multiple entity levels are supported. (Inclusive)
	StartFrom *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientListBlobHierarchySegmentOptions contains the optional parameters for the ContainerClient.NewListBlobHierarchySegmentPager method.

type ContainerClientListBlobHierarchySegmentResponse 

type ContainerClientListBlobHierarchySegmentResponse struct {
	// The result of the List Blobs Hierarchical API.
	ListBlobsHierarchySegmentResponse

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientListBlobHierarchySegmentResponse contains the response from method ContainerClient.NewListBlobHierarchySegmentPager.

type ContainerClientReleaseLeaseOptions 

type ContainerClientReleaseLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientReleaseLeaseOptions contains the optional parameters for the ContainerClient.ReleaseLease method.

type ContainerClientReleaseLeaseResponse 

type ContainerClientReleaseLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientReleaseLeaseResponse contains the response from method ContainerClient.ReleaseLease.

type ContainerClientRenameOptions 

type ContainerClientRenameOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match.
	SourceLeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientRenameOptions contains the optional parameters for the ContainerClient.Rename method.

type ContainerClientRenameResponse 

type ContainerClientRenameResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientRenameResponse contains the response from method ContainerClient.Rename.

type ContainerClientRenewLeaseOptions 

type ContainerClientRenewLeaseOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientRenewLeaseOptions contains the optional parameters for the ContainerClient.RenewLease method.

type ContainerClientRenewLeaseResponse 

type ContainerClientRenewLeaseResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// Uniquely identifies a blob's lease.
	LeaseID *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientRenewLeaseResponse contains the response from method ContainerClient.RenewLease.

type ContainerClientRestoreOptions 

type ContainerClientRestoreOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specifies the name of the deleted container to restore.
	DeletedContainerName *string

	// Specifies the version of the deleted container to restore.
	DeletedContainerVersion *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientRestoreOptions contains the optional parameters for the ContainerClient.Restore method.

type ContainerClientRestoreResponse 

type ContainerClientRestoreResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientRestoreResponse contains the response from method ContainerClient.Restore.

type ContainerClientSetAccessPolicyOptions 

type ContainerClientSetAccessPolicyOptions struct {
	// The public access setting for the container.
	Access *PublicAccessType

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientSetAccessPolicyOptions contains the optional parameters for the ContainerClient.SetAccessPolicy method.

type ContainerClientSetAccessPolicyResponse 

type ContainerClientSetAccessPolicyResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientSetAccessPolicyResponse contains the response from method ContainerClient.SetAccessPolicy.

type ContainerClientSetMetadataOptions 

type ContainerClientSetMetadataOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The metadata headers.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientSetMetadataOptions contains the optional parameters for the ContainerClient.SetMetadata method.

type ContainerClientSetMetadataResponse 

type ContainerClientSetMetadataResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientSetMetadataResponse contains the response from method ContainerClient.SetMetadata.

type ContainerClientSubmitBatchOptions 

type ContainerClientSubmitBatchOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ContainerClientSubmitBatchOptions contains the optional parameters for the ContainerClient.SubmitBatch method.

type ContainerClientSubmitBatchResponse 

type ContainerClientSubmitBatchResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser

	// The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
	ContentType *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ContainerClientSubmitBatchResponse contains the response from method ContainerClient.SubmitBatch.

type ContainerItem 

type ContainerItem struct {
	// REQUIRED; The name of the container.
	Name *string `xml:"Name"`

	// REQUIRED; The properties of the container.
	Properties *ContainerProperties `xml:"Properties"`

	// Whether the container is soft-deleted.
	Deleted *bool `xml:"Deleted"`

	// The metadata of the container.
	Metadata map[string]*string `xml:"Metadata"`

	// The version of the container.
	Version *string `xml:"Version"`
}

ContainerItem - Represents a container.

func (ContainerItem) MarshalXML 

func (c ContainerItem) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ContainerItem.

func (*ContainerItem) UnmarshalXML 

func (c *ContainerItem) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type ContainerItem.

type ContainerProperties 

type ContainerProperties struct {
	// REQUIRED; The ETag of the container.
	ETag *azcore.ETag `xml:"Etag"`

	// REQUIRED; The date-time that the container was last modified.
	LastModified *time.Time `xml:"Last-Modified"`

	// The default encryption scope of the container.
	DefaultEncryptionScope *string `xml:"DefaultEncryptionScope"`

	// The date-time the container was deleted.
	DeletedTime *time.Time `xml:"DeletedTime"`

	// Whether the container has an immutability policy.
	HasImmutabilityPolicy *bool `xml:"HasImmutabilityPolicy"`

	// Whether the container has a legal hold.
	HasLegalHold *bool `xml:"HasLegalHold"`

	// Whether immutable storage with versioning is enabled.
	IsImmutableStorageWithVersioningEnabled *bool `xml:"ImmutableStorageWithVersioningEnabled"`

	// The lease duration of the container.
	LeaseDuration *LeaseDurationType `xml:"LeaseDuration"`

	// The lease state of the container.
	LeaseState *LeaseStateType `xml:"LeaseState"`

	// The lease status of the container.
	LeaseStatus *LeaseStatusType `xml:"LeaseStatus"`

	// Whether to prevent encryption scope override.
	PreventEncryptionScopeOverride *bool `xml:"DenyEncryptionScopeOverride"`

	// The public access type of the container.
	PublicAccess *PublicAccessType `xml:"PublicAccess"`

	// The remaining retention days of the container.
	RemainingRetentionDays *int32 `xml:"RemainingRetentionDays"`
}

ContainerProperties - The properties of a container.

func (ContainerProperties) MarshalXML 

func (c ContainerProperties) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ContainerProperties.

func (*ContainerProperties) UnmarshalXML 

func (c *ContainerProperties) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type ContainerProperties.

type CopyStatusType 

type CopyStatusType string

CopyStatusType - The copy status. 

const (
	// CopyStatusTypeAborted - The copy operation was aborted.
	CopyStatusTypeAborted CopyStatusType = "aborted"
	// CopyStatusTypeFailed - The copy operation failed.
	CopyStatusTypeFailed CopyStatusType = "failed"
	// CopyStatusTypePending - The copy operation is pending.
	CopyStatusTypePending CopyStatusType = "pending"
	// CopyStatusTypeSuccess - The copy operation succeeded.
	CopyStatusTypeSuccess CopyStatusType = "success"
)

func PossibleCopyStatusTypeValues 

func PossibleCopyStatusTypeValues() []CopyStatusType

PossibleCopyStatusTypeValues returns the possible values for the CopyStatusType const type.

type DeleteSnapshotsOptionType 

type DeleteSnapshotsOptionType string

DeleteSnapshotsOptionType - Specifies the delete behavior of blob snapshots. 

const (
	// DeleteSnapshotsOptionTypeInclude - Delete the blob and snapshots.
	DeleteSnapshotsOptionTypeInclude DeleteSnapshotsOptionType = "include"
	// DeleteSnapshotsOptionTypeOnly - Only delete the snapshots.
	DeleteSnapshotsOptionTypeOnly DeleteSnapshotsOptionType = "only"
)

func PossibleDeleteSnapshotsOptionTypeValues 

func PossibleDeleteSnapshotsOptionTypeValues() []DeleteSnapshotsOptionType

PossibleDeleteSnapshotsOptionTypeValues returns the possible values for the DeleteSnapshotsOptionType const type.

type DeleteType 

type DeleteType string

DeleteType - The type of blob deletions. 

const (
	// DeleteTypeNone - None.
	DeleteTypeNone DeleteType = "None"
	// DeleteTypePermanent - Permanently delete the blob.
	DeleteTypePermanent DeleteType = "Permanent"
)

func PossibleDeleteTypeValues 

func PossibleDeleteTypeValues() []DeleteType

PossibleDeleteTypeValues returns the possible values for the DeleteType const type.

type DelimitedTextConfiguration 

type DelimitedTextConfiguration struct {
	// The string used to separate columns.
	ColumnSeparator *string `xml:"ColumnSeparator"`

	// The string used to escape a quote character in a field.
	EscapeChar *string `xml:"EscapeChar"`

	// The string used to quote a specific field.
	FieldQuote *string `xml:"FieldQuote"`

	// Represents whether the data has headers.
	HeadersPresent *bool `xml:"HasHeaders"`

	// The string used to separate records.
	RecordSeparator *string `xml:"RecordSeparator"`
}

DelimitedTextConfiguration - Represents the delimited text configuration.

type EncryptionAlgorithmType 

type EncryptionAlgorithmType string

EncryptionAlgorithmType - The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided. 

const (
	// EncryptionAlgorithmTypeAES256 - AES256
	EncryptionAlgorithmTypeAES256 EncryptionAlgorithmType = "AES256"
	// EncryptionAlgorithmTypeNone - Deprecated
	EncryptionAlgorithmTypeNone EncryptionAlgorithmType = "None"
)

func PossibleEncryptionAlgorithmTypeValues 

func PossibleEncryptionAlgorithmTypeValues() []EncryptionAlgorithmType

PossibleEncryptionAlgorithmTypeValues returns the possible values for the EncryptionAlgorithmType const type.

type ExpiryOptions 

type ExpiryOptions string

ExpiryOptions - The blob expiry options. 

const (
	// ExpiryOptionsAbsolute - Absolute time.
	ExpiryOptionsAbsolute ExpiryOptions = "Absolute"
	// ExpiryOptionsNeverExpire - Never expire.
	ExpiryOptionsNeverExpire ExpiryOptions = "NeverExpire"
	// ExpiryOptionsRelativeToCreation - Relative to creation time.
	ExpiryOptionsRelativeToCreation ExpiryOptions = "RelativeToCreation"
	// ExpiryOptionsRelativeToNow - Relative to now.
	ExpiryOptionsRelativeToNow ExpiryOptions = "RelativeToNow"
)

func PossibleExpiryOptionsValues 

func PossibleExpiryOptionsValues() []ExpiryOptions

PossibleExpiryOptionsValues returns the possible values for the ExpiryOptions const type.

type FileShareTokenIntent added in v1.6.2 

type FileShareTokenIntent string

FileShareTokenIntent - The file share token intent types. 

const (
	// FileShareTokenIntentBackup - The file share token intent is backup.
	FileShareTokenIntentBackup FileShareTokenIntent = "backup"
)

func PossibleFileShareTokenIntentValues added in v1.6.2 

func PossibleFileShareTokenIntentValues() []FileShareTokenIntent

PossibleFileShareTokenIntentValues returns the possible values for the FileShareTokenIntent const type.

type FilterBlobItem 

type FilterBlobItem struct {
	// REQUIRED; The name of the container.
	ContainerName *string `xml:"ContainerName"`

	// REQUIRED; The name of the blob.
	Name *string `xml:"Name"`

	// Whether it is the current version of the blob.
	IsCurrentVersion *bool `xml:"IsCurrentVersion"`

	// The tags of the blob.
	Tags *BlobTags `xml:"Tags"`

	// The version ID of the blob.
	VersionID *string `xml:"VersionId"`
}

FilterBlobItem - The filtered blob item.

func (FilterBlobItem) MarshalXML 

func (f FilterBlobItem) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type FilterBlobItem.

type FilterBlobSegment 

type FilterBlobSegment struct {
	// REQUIRED; The list of filtered blobs.
	Blobs []*FilterBlobItem `xml:"Blobs>Blob"`

	// REQUIRED; The service endpoint.
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`

	// REQUIRED; The filter expression for the blobs.
	Where *string `xml:"Where"`

	// An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value
	// in the next request to continue the listing operation.
	NextMarker *string `xml:"NextMarker"`
}

FilterBlobSegment - The result of the Find Blobs by Tags API.

func (FilterBlobSegment) MarshalXML 

func (f FilterBlobSegment) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type FilterBlobSegment.

type FilterBlobsIncludeItem added in v1.2.0 

type FilterBlobsIncludeItem string

FilterBlobsIncludeItem - Specifies what type of blobs should be returned as part of the filter operation. 

const (
	// FilterBlobsIncludeItemNone - The filter includes no versions.
	FilterBlobsIncludeItemNone FilterBlobsIncludeItem = "none"
	// FilterBlobsIncludeItemVersions - The filter includes versions.
	FilterBlobsIncludeItemVersions FilterBlobsIncludeItem = "versions"
)

func PossibleFilterBlobsIncludeItemValues added in v1.2.0 

func PossibleFilterBlobsIncludeItemValues() []FilterBlobsIncludeItem

PossibleFilterBlobsIncludeItemValues returns the possible values for the FilterBlobsIncludeItem const type.

type GeoReplication 

type GeoReplication struct {
	// REQUIRED; A date-time value that indicates where all primary writes preceding this value are guaranteed to be available
	// for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.
	LastSyncTime *time.Time `xml:"LastSyncTime"`

	// REQUIRED; The status of the secondary location.
	Status *BlobGeoReplicationStatus `xml:"Status"`
}

GeoReplication - Geo-replication information for the secondary storage service.

func (GeoReplication) MarshalXML 

func (g GeoReplication) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type GeoReplication.

func (*GeoReplication) UnmarshalXML 

func (g *GeoReplication) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type GeoReplication.

type ImmutabilityPolicyMode 

type ImmutabilityPolicyMode string

ImmutabilityPolicyMode - The immutability policy mode. 

const (
	// ImmutabilityPolicyModeLocked - The immutability policy is locked.
	ImmutabilityPolicyModeLocked ImmutabilityPolicyMode = "locked"
	// ImmutabilityPolicyModeMutable - Response only. The immutability policy is mutable.
	ImmutabilityPolicyModeMutable ImmutabilityPolicyMode = "mutable"
	// ImmutabilityPolicyModeUnlocked - The immutability policy is unlocked.
	ImmutabilityPolicyModeUnlocked ImmutabilityPolicyMode = "unlocked"
)

func PossibleImmutabilityPolicyModeValues 

func PossibleImmutabilityPolicyModeValues() []ImmutabilityPolicyMode

PossibleImmutabilityPolicyModeValues returns the possible values for the ImmutabilityPolicyMode const type.

type ImmutabilityPolicySetting 

type ImmutabilityPolicySetting string

ImmutabilityPolicySetting - The immutability policy mode used in requests and responses. 

const (
	// ImmutabilityPolicySettingLocked - The immutability policy is locked.
	ImmutabilityPolicySettingLocked ImmutabilityPolicySetting = "Locked"
	// ImmutabilityPolicySettingUnlocked - The immutability policy is unlocked.
	ImmutabilityPolicySettingUnlocked ImmutabilityPolicySetting = "Unlocked"
)

func PossibleImmutabilityPolicySettingValues 

func PossibleImmutabilityPolicySettingValues() []ImmutabilityPolicySetting

PossibleImmutabilityPolicySettingValues returns the possible values for the ImmutabilityPolicySetting const type.

type JSONTextConfiguration 

type JSONTextConfiguration struct {
	// The string used to separate records.
	RecordSeparator *string `xml:"RecordSeparator"`
}

JSONTextConfiguration - Represents the JSON text configuration.

func (JSONTextConfiguration) MarshalXML 

func (j JSONTextConfiguration) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type JSONTextConfiguration.

type KeyInfo 

type KeyInfo struct {
	// REQUIRED; The date-time the key expires.
	Expiry *string `xml:"Expiry"`

	// REQUIRED; The date-time the key is active.
	Start *string `xml:"Start"`

	// The delegated user tenant ID in Entra ID.
	DelegatedUserTenantID *string `xml:"DelegatedUserTid"`
}

KeyInfo - Key information.

type LeaseAccessConditions 

type LeaseAccessConditions struct {
	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string
}

LeaseAccessConditions contains a group of parameters for the ContainerClient.GetProperties method.

type LeaseDurationType 

type LeaseDurationType string

LeaseDurationType - The lease duration. 

const (
	// LeaseDurationTypeFixed - The lease is of fixed duration.
	LeaseDurationTypeFixed LeaseDurationType = "fixed"
	// LeaseDurationTypeInfinite - The lease is of infinite duration.
	LeaseDurationTypeInfinite LeaseDurationType = "infinite"
)

func PossibleLeaseDurationTypeValues 

func PossibleLeaseDurationTypeValues() []LeaseDurationType

PossibleLeaseDurationTypeValues returns the possible values for the LeaseDurationType const type.

type LeaseStateType 

type LeaseStateType string

LeaseStateType - The lease state. 

const (
	// LeaseStateTypeAvailable - The lease is available.
	LeaseStateTypeAvailable LeaseStateType = "available"
	// LeaseStateTypeBreaking - The lease is breaking.
	LeaseStateTypeBreaking LeaseStateType = "breaking"
	// LeaseStateTypeBroken - The lease is broken.
	LeaseStateTypeBroken LeaseStateType = "broken"
	// LeaseStateTypeExpired - The lease is expired.
	LeaseStateTypeExpired LeaseStateType = "expired"
	// LeaseStateTypeLeased - The lease is currently leased.
	LeaseStateTypeLeased LeaseStateType = "leased"
)

func PossibleLeaseStateTypeValues 

func PossibleLeaseStateTypeValues() []LeaseStateType

PossibleLeaseStateTypeValues returns the possible values for the LeaseStateType const type.

type LeaseStatusType 

type LeaseStatusType string

LeaseStatusType - The lease status. 

const (
	// LeaseStatusTypeLocked - The lease is locked.
	LeaseStatusTypeLocked LeaseStatusType = "locked"
	// LeaseStatusTypeUnlocked - The lease is unlocked.
	LeaseStatusTypeUnlocked LeaseStatusType = "unlocked"
)

func PossibleLeaseStatusTypeValues 

func PossibleLeaseStatusTypeValues() []LeaseStatusType

PossibleLeaseStatusTypeValues returns the possible values for the LeaseStatusType const type.

type ListBlobFlatSegmentApacheArrowResponseContentType 

type ListBlobFlatSegmentApacheArrowResponseContentType string
const (
	ListBlobFlatSegmentApacheArrowResponseContentTypeApplicationVndApacheArrowStream ListBlobFlatSegmentApacheArrowResponseContentType = "application/vnd.apache.arrow.stream"
	ListBlobFlatSegmentApacheArrowResponseContentTypeApplicationXML                  ListBlobFlatSegmentApacheArrowResponseContentType = "application/xml"
)

func PossibleListBlobFlatSegmentApacheArrowResponseContentTypeValues 

func PossibleListBlobFlatSegmentApacheArrowResponseContentTypeValues() []ListBlobFlatSegmentApacheArrowResponseContentType

PossibleListBlobFlatSegmentApacheArrowResponseContentTypeValues returns the possible values for the ListBlobFlatSegmentApacheArrowResponseContentType const type.

type ListBlobHierarchySegmentApacheArrowResponseContentType 

type ListBlobHierarchySegmentApacheArrowResponseContentType string
const (
	ListBlobHierarchySegmentApacheArrowResponseContentTypeApplicationVndApacheArrowStream ListBlobHierarchySegmentApacheArrowResponseContentType = "application/vnd.apache.arrow.stream"
	ListBlobHierarchySegmentApacheArrowResponseContentTypeApplicationXML                  ListBlobHierarchySegmentApacheArrowResponseContentType = "application/xml"
)

func PossibleListBlobHierarchySegmentApacheArrowResponseContentTypeValues 

func PossibleListBlobHierarchySegmentApacheArrowResponseContentTypeValues() []ListBlobHierarchySegmentApacheArrowResponseContentType

PossibleListBlobHierarchySegmentApacheArrowResponseContentTypeValues returns the possible values for the ListBlobHierarchySegmentApacheArrowResponseContentType const type.

type ListBlobsFlatSegmentResponse 

type ListBlobsFlatSegmentResponse struct {
	// REQUIRED; The container name.
	ContainerName *string `xml:"ContainerName,attr"`

	// REQUIRED; The list of blobs.
	Segment *BlobFlatListSegment `xml:"Blobs"`

	// REQUIRED; The service endpoint.
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`

	// An opaque string value that identifies the portion of the result set returned with this operation.
	Marker *string `xml:"Marker"`

	// The maximum number of blobs to be returned with this operation.
	MaxResults *int32 `xml:"MaxResults"`

	// An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value
	// in the next request to continue the listing operation.
	NextMarker *string `xml:"NextMarker"`

	// The prefix of the list operation.
	Prefix *string `xml:"Prefix"`
}

ListBlobsFlatSegmentResponse - The result of the List Blobs API.

func (ListBlobsFlatSegmentResponse) MarshalXML 

func (l ListBlobsFlatSegmentResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListBlobsFlatSegmentResponse.

type ListBlobsHierarchySegmentResponse 

type ListBlobsHierarchySegmentResponse struct {
	// REQUIRED; The container name.
	ContainerName *string `xml:"ContainerName,attr"`

	// REQUIRED; The list of hierarchical blobs.
	Segment *BlobHierarchyListSegment `xml:"Blobs"`

	// REQUIRED; The service endpoint.
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`

	// The delimiter of the blobs.
	Delimiter *string `xml:"Delimiter"`

	// An opaque string value that identifies the portion of the result set returned with this operation.
	Marker *string `xml:"Marker"`

	// The maximum number of blobs to be returned with this operation.
	MaxResults *int32 `xml:"MaxResults"`

	// An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value
	// in the next request to continue the listing operation.
	NextMarker *string `xml:"NextMarker"`

	// The prefix of the blobs.
	Prefix *string `xml:"Prefix"`
}

ListBlobsHierarchySegmentResponse - The result of the List Blobs Hierarchical API.

func (ListBlobsHierarchySegmentResponse) MarshalXML 

func (l ListBlobsHierarchySegmentResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListBlobsHierarchySegmentResponse.

type ListBlobsIncludeItem 

type ListBlobsIncludeItem string

ListBlobsIncludeItem - The list blob includes parameter values. 

const (
	// ListBlobsIncludeItemCopy - The include copies.
	ListBlobsIncludeItemCopy ListBlobsIncludeItem = "copy"
	// ListBlobsIncludeItemDeleted - The include deleted blobs.
	ListBlobsIncludeItemDeleted ListBlobsIncludeItem = "deleted"
	// ListBlobsIncludeItemDeletedWithVersions - The include deleted with versions.
	ListBlobsIncludeItemDeletedWithVersions ListBlobsIncludeItem = "deletedwithversions"
	// ListBlobsIncludeItemImmutabilityPolicy - The include immutable policy.
	ListBlobsIncludeItemImmutabilityPolicy ListBlobsIncludeItem = "immutabilitypolicy"
	// ListBlobsIncludeItemLegalHold - The include legal hold.
	ListBlobsIncludeItemLegalHold ListBlobsIncludeItem = "legalhold"
	// ListBlobsIncludeItemMetadata - The include metadata.
	ListBlobsIncludeItemMetadata ListBlobsIncludeItem = "metadata"
	// ListBlobsIncludeItemPermissions - Deprecated
	ListBlobsIncludeItemPermissions ListBlobsIncludeItem = "permissions"
	// ListBlobsIncludeItemSnapshots - The include snapshots.
	ListBlobsIncludeItemSnapshots ListBlobsIncludeItem = "snapshots"
	// ListBlobsIncludeItemTags - The include tags.
	ListBlobsIncludeItemTags ListBlobsIncludeItem = "tags"
	// ListBlobsIncludeItemUncommittedBlobs - The include uncommitted blobs.
	ListBlobsIncludeItemUncommittedBlobs ListBlobsIncludeItem = "uncommittedblobs"
	// ListBlobsIncludeItemVersions - The include versions.
	ListBlobsIncludeItemVersions ListBlobsIncludeItem = "versions"
)

func PossibleListBlobsIncludeItemValues 

func PossibleListBlobsIncludeItemValues() []ListBlobsIncludeItem

PossibleListBlobsIncludeItemValues returns the possible values for the ListBlobsIncludeItem const type.

type ListContainersIncludeType 

type ListContainersIncludeType string

ListContainersIncludeType - Specifies what additional information should be returned as part of the list operation. 

const (
	// ListContainersIncludeTypeDeleted - Include soft-deleted containers.
	ListContainersIncludeTypeDeleted ListContainersIncludeType = "deleted"
	// ListContainersIncludeTypeMetadata - Include metadata.
	ListContainersIncludeTypeMetadata ListContainersIncludeType = "metadata"
	// ListContainersIncludeTypeSystem - Include system containers.
	ListContainersIncludeTypeSystem ListContainersIncludeType = "system"
)

func PossibleListContainersIncludeTypeValues 

func PossibleListContainersIncludeTypeValues() []ListContainersIncludeType

PossibleListContainersIncludeTypeValues returns the possible values for the ListContainersIncludeType const type.

type ListContainersSegmentResponse 

type ListContainersSegmentResponse struct {
	// REQUIRED; The list of containers.
	ContainerItems []*ContainerItem `xml:"Containers>Container"`

	// REQUIRED; The service endpoint.
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`

	// An opaque string value that identifies the portion of the result set returned with this operation.
	Marker *string `xml:"Marker"`

	// The maximum number of containers to be returned with this operation.
	MaxResults *int32 `xml:"MaxResults"`

	// An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value
	// in the next request to continue the listing operation.
	NextMarker *string `xml:"NextMarker"`

	// The prefix of the containers.
	Prefix *string `xml:"Prefix"`
}

ListContainersSegmentResponse - The result of the List Containers API.

func (ListContainersSegmentResponse) MarshalXML 

func (l ListContainersSegmentResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListContainersSegmentResponse.

type Logging 

type Logging struct {
	// REQUIRED; Whether delete operation is logged.
	Delete *bool `xml:"Delete"`

	// REQUIRED; Whether read operation is logged.
	Read *bool `xml:"Read"`

	// REQUIRED; The retention policy of the logs.
	RetentionPolicy *RetentionPolicy `xml:"RetentionPolicy"`

	// REQUIRED; The version of the logging properties.
	Version *string `xml:"Version"`

	// REQUIRED; Whether write operation is logged.
	Write *bool `xml:"Write"`
}

Logging - Azure Analytics logging settings.

type Metrics 

type Metrics struct {
	// REQUIRED; Whether the metrics are enabled.
	Enabled *bool `xml:"Enabled"`

	// Whether to include API in the metrics.
	IncludeAPIs *bool `xml:"IncludeAPIs"`

	// The retention policy of the metrics.
	RetentionPolicy *RetentionPolicy `xml:"RetentionPolicy"`

	// The version of the metrics properties.
	Version *string `xml:"Version"`
}

Metrics - The metrics properties.

type ModifiedAccessConditions 

type ModifiedAccessConditions struct {
	// Specify an ETag value to operate only on blobs with a matching value.
	IfMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has been modified since the specified date/time.
	IfModifiedSince *time.Time

	// Specify an ETag value to operate only on blobs without a matching value.
	IfNoneMatch *azcore.ETag

	// Specify a SQL where clause on blob tags to operate only on blobs with a matching value.
	IfTags *string

	// Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
	IfUnmodifiedSince *time.Time
}

ModifiedAccessConditions contains a group of parameters for the ContainerClient.Delete method.

type PageBlobClient 

type PageBlobClient struct {
	// contains filtered or unexported fields
}

PageBlobClient contains the methods for the PageBlob group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewPageBlobClient 

func NewPageBlobClient(endpoint string, azClient *azcore.Client) *PageBlobClient

NewPageBlobClient creates a new instance of PageBlobClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*PageBlobClient) ClearPages 

func (client *PageBlobClient) ClearPages(ctx context.Context, rangeParam string, options *PageBlobClientClearPagesOptions) (PageBlobClientClearPagesResponse, error)

ClearPages - Clears a range of pages from the specified page blob. If the operation fails it returns an *azcore.ResponseError type.

  • rangeParam - Specifies the range of the blob to operate on.
  • options - PageBlobClientClearPagesOptions contains the optional parameters for the PageBlobClient.ClearPages method.

func (*PageBlobClient) CopyIncremental 

func (client *PageBlobClient) CopyIncremental(ctx context.Context, copySource string, options *PageBlobClientCopyIncrementalOptions) (PageBlobClientCopyIncrementalResponse, error)

CopyIncremental - Copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. If the operation fails it returns an *azcore.ResponseError type.

  • copySource - Specifies the name of the source URL for the copy operation. The value should be URL-encoded as it would appear in a request URI.
  • options - PageBlobClientCopyIncrementalOptions contains the optional parameters for the PageBlobClient.CopyIncremental method.

func (*PageBlobClient) Create 

func (client *PageBlobClient) Create(ctx context.Context, size int64, options *PageBlobClientCreateOptions) (PageBlobClientCreateResponse, error)

Create - Creates a new page blob. If the operation fails it returns an *azcore.ResponseError type.

  • size - The maximum size for the page blob. Must be aligned to a 512-byte boundary.
  • options - PageBlobClientCreateOptions contains the optional parameters for the PageBlobClient.Create method.

func (*PageBlobClient) Endpoint 

func (client *PageBlobClient) Endpoint() string

func (*PageBlobClient) GetPageRanges 

func (client *PageBlobClient) GetPageRanges(ctx context.Context, options *PageBlobClientGetPageRangesOptions) (PageBlobClientGetPageRangesResponse, error)

GetPageRanges - Returns the list of valid page ranges for the specified page blob. If the operation fails it returns an *azcore.ResponseError type.

  • options - PageBlobClientGetPageRangesOptions contains the optional parameters for the PageBlobClient.GetPageRanges method.

func (*PageBlobClient) GetPageRangesCreateRequest 

func (client *PageBlobClient) GetPageRangesCreateRequest(ctx context.Context, options *PageBlobClientGetPageRangesOptions) (*policy.Request, error)

GetPageRangesCreateRequest creates the GetPageRanges request.

func (*PageBlobClient) GetPageRangesDiff 

func (client *PageBlobClient) GetPageRangesDiff(ctx context.Context, options *PageBlobClientGetPageRangesDiffOptions) (PageBlobClientGetPageRangesDiffResponse, error)

GetPageRangesDiff - Returns the list of page ranges in the diff between the specified page blob and the specified previous snapshot. If the operation fails it returns an *azcore.ResponseError type.

  • options - PageBlobClientGetPageRangesDiffOptions contains the optional parameters for the PageBlobClient.GetPageRangesDiff method.

func (*PageBlobClient) GetPageRangesDiffCreateRequest 

func (client *PageBlobClient) GetPageRangesDiffCreateRequest(ctx context.Context, options *PageBlobClientGetPageRangesDiffOptions) (*policy.Request, error)

GetPageRangesDiffCreateRequest creates the GetPageRangesDiff request.

func (*PageBlobClient) GetPageRangesDiffHandleResponse 

func (client *PageBlobClient) GetPageRangesDiffHandleResponse(resp *http.Response, successCodes ...int) (PageBlobClientGetPageRangesDiffResponse, error)

GetPageRangesDiffHandleResponse handles the GetPageRangesDiff response.

func (*PageBlobClient) GetPageRangesHandleResponse 

func (client *PageBlobClient) GetPageRangesHandleResponse(resp *http.Response, successCodes ...int) (PageBlobClientGetPageRangesResponse, error)

GetPageRangesHandleResponse handles the GetPageRanges response.

func (*PageBlobClient) InternalClient added in v1.2.0 

func (client *PageBlobClient) InternalClient() *azcore.Client

func (*PageBlobClient) Resize 

func (client *PageBlobClient) Resize(ctx context.Context, size int64, options *PageBlobClientResizeOptions) (PageBlobClientResizeResponse, error)

Resize - Changes the size of the specified page blob. If the operation fails it returns an *azcore.ResponseError type.

  • size - The maximum size for the page blob. Must be aligned to a 512-byte boundary.
  • options - PageBlobClientResizeOptions contains the optional parameters for the PageBlobClient.Resize method.

func (*PageBlobClient) UpdateSequenceNumber 

func (client *PageBlobClient) UpdateSequenceNumber(ctx context.Context, sequenceNumberAction SequenceNumberActionType, options *PageBlobClientUpdateSequenceNumberOptions) (PageBlobClientUpdateSequenceNumberResponse, error)

UpdateSequenceNumber - Updates the sequence number of the specified page blob. The operation will fail if the specified sequence number is less than the current sequence number of the blob. If the operation fails it returns an *azcore.ResponseError type.

  • sequenceNumberAction - Required if the blob sequence number is provided. This property indicates how the service should modify the blob's sequence number.
  • options - PageBlobClientUpdateSequenceNumberOptions contains the optional parameters for the PageBlobClient.UpdateSequenceNumber method.

func (*PageBlobClient) UploadPages 

func (client *PageBlobClient) UploadPages(ctx context.Context, body io.ReadSeekCloser, contentLength int64, rangeParam string, options *PageBlobClientUploadPagesOptions) (PageBlobClientUploadPagesResponse, error)

UploadPages - Writes a range of pages to the specified page blob. If the operation fails it returns an *azcore.ResponseError type.

  • body - The body of the request.
  • contentLength - The length of the request.
  • rangeParam - Specifies the range of the blob to operate on.
  • options - PageBlobClientUploadPagesOptions contains the optional parameters for the PageBlobClient.UploadPages method.

func (*PageBlobClient) UploadPagesFromURL 

func (client *PageBlobClient) UploadPagesFromURL(ctx context.Context, sourceURL string, sourceRange string, contentLength int64, rangeParam string, options *PageBlobClientUploadPagesFromURLOptions) (PageBlobClientUploadPagesFromURLResponse, error)

UploadPagesFromURL - Writes a range of pages to the specified page blob where the contents are read from a URL. If the operation fails it returns an *azcore.ResponseError type.

  • sourceURL - Specifies the URL of the source.
  • sourceRange - Specifies the bytes of the source.
  • contentLength - The length of the request.
  • rangeParam - Specifies the range of the blob to operate on.
  • options - PageBlobClientUploadPagesFromURLOptions contains the optional parameters for the PageBlobClient.UploadPagesFromURL method.

type PageBlobClientClearPagesOptions 

type PageBlobClientClearPagesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has the specified sequence number.
	IfSequenceNumberEqualTo *int64

	// Specify this value to operate only on a blob if it has a sequence number less than the specified.
	IfSequenceNumberLessThan *int64

	// Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.
	IfSequenceNumberLessThanOrEqualTo *int64

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientClearPagesOptions contains the optional parameters for the PageBlobClient.ClearPages method.

type PageBlobClientClearPagesResponse 

type PageBlobClientClearPagesResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientClearPagesResponse contains the response from method PageBlobClient.ClearPages.

type PageBlobClientCopyIncrementalOptions 

type PageBlobClientCopyIncrementalOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientCopyIncrementalOptions contains the optional parameters for the PageBlobClient.CopyIncremental method.

type PageBlobClientCopyIncrementalResponse 

type PageBlobClientCopyIncrementalResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Identifier for this copy operation.
	CopyID *string

	// Status of the copy operation.
	CopyStatus *CopyStatusType

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientCopyIncrementalResponse contains the response from method PageBlobClient.CopyIncremental.

type PageBlobClientCreateOptions 

type PageBlobClientCreateOptions struct {
	// Specifies the blob's Cache-Control. If specified, this property is stored with the blob and returned with a read request.
	BlobCacheControl *string

	// Specifies the blob's Content-Disposition. If specified, this property is stored with the blob and returned with a read
	// request.
	BlobContentDisposition *string

	// Specifies the blob's Content-Encoding. If specified, this property is stored with the blob and returned with a read request.
	BlobContentEncoding *string

	// Specifies the blob's Content-Language. If specified, this property is stored with the blob and returned with a read request.
	BlobContentLanguage *string

	// The MD5 hash of the blob content that is stored as a property on the blob. Note: This hash is not validated.
	BlobContentMD5 []byte

	// Specifies the blob's Content-Type. If specified, this property is stored with the blob and returned with a read request.
	BlobContentType *string

	// A value that can be used to track the request. The value of the sequence number must be between 0 and 2^63 - 1.
	BlobSequenceNumber *int64

	// The blob tags.
	BlobTagsString *string

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// The date-time that indicates the time at which the blob immutability policy will expire.
	ImmutabilityPolicyExpiry *time.Time

	// Indicates the immutability policy mode of the blob.
	ImmutabilityPolicyMode *ImmutabilityPolicySetting

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Indicates whether the blob has a legal hold.
	LegalHold *bool

	// The metadata headers.
	Metadata map[string]*string

	// Indicates the tier to be set on the page blob.
	Tier *PremiumPageBlobAccessTier

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientCreateOptions contains the optional parameters for the PageBlobClient.Create method.

type PageBlobClientCreateResponse 

type PageBlobClientCreateResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string

	// The version ID of the blob.
	VersionID *string
}

PageBlobClientCreateResponse contains the response from method PageBlobClient.Create.

type PageBlobClientGetPageRangesDiffOptions 

type PageBlobClientGetPageRangesDiffOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Specifies the previous snapshot URL to be compared in the diff.
	PrevSnapshotURL *string

	// Specifies the previous snapshot to be compared in the diff.
	Prevsnapshot *string

	// Specifies the range of the blob to operate on.
	Range *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientGetPageRangesDiffOptions contains the optional parameters for the PageBlobClient.GetPageRangesDiff method.

type PageBlobClientGetPageRangesDiffResponse 

type PageBlobClientGetPageRangesDiffResponse struct {
	// The result of the Get Pages API.
	PageList

	// The size of the blob in bytes.
	BlobContentLength *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientGetPageRangesDiffResponse contains the response from method PageBlobClient.GetPageRangesDiff.

type PageBlobClientGetPageRangesOptions 

type PageBlobClientGetPageRangesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Specifies the range of the blob to operate on.
	Range *string

	// Specifies the snapshot of the blob.
	Snapshot *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientGetPageRangesOptions contains the optional parameters for the PageBlobClient.GetPageRanges method.

type PageBlobClientGetPageRangesResponse 

type PageBlobClientGetPageRangesResponse struct {
	// The result of the Get Pages API.
	PageList

	// The size of the blob in bytes.
	BlobContentLength *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientGetPageRangesResponse contains the response from method PageBlobClient.GetPageRanges.

type PageBlobClientResizeOptions 

type PageBlobClientResizeOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientResizeOptions contains the optional parameters for the PageBlobClient.Resize method.

type PageBlobClientResizeResponse 

type PageBlobClientResizeResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientResizeResponse contains the response from method PageBlobClient.Resize.

type PageBlobClientUpdateSequenceNumberOptions 

type PageBlobClientUpdateSequenceNumberOptions struct {
	// A value that can be used to track the request. The value of the sequence number must be between 0 and 2^63 - 1.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientUpdateSequenceNumberOptions contains the optional parameters for the PageBlobClient.UpdateSequenceNumber method.

type PageBlobClientUpdateSequenceNumberResponse 

type PageBlobClientUpdateSequenceNumberResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientUpdateSequenceNumberResponse contains the response from method PageBlobClient.UpdateSequenceNumber.

type PageBlobClientUploadPagesFromURLOptions 

type PageBlobClientUploadPagesFromURLOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Only the Bearer authorization scheme is supported, and the value must be a valid OAuth access token for the copy source.
	CopySourceAuthorization *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specifies the file request token intent.
	FileRequestIntent *FileShareTokenIntent

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has the specified sequence number.
	IfSequenceNumberEqualTo *int64

	// Specify this value to operate only on a blob if it has a sequence number less than the specified.
	IfSequenceNumberLessThan *int64

	// Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.
	IfSequenceNumberLessThanOrEqualTo *int64

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Specifies the CRC64 calculated for the range of bytes that must be read from the source.
	SourceContentCRC64 []byte

	// Specifies the MD5 hash calculated for the range of bytes that must be read from the copy source.
	SourceContentMD5 []byte

	// The algorithm used to produce the source encryption key hash. Must be provided if the source encryption key is provided.
	SourceEncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to decrypt the source data provided in the request.
	SourceEncryptionKey *string

	// The SHA-256 hash of the provided source encryption key. Must be provided if the source encryption key is provided.
	SourceEncryptionKeySHA256 *string

	// Specify this value to operate only on a source blob with a matching Etag value.
	SourceIfMatch *azcore.ETag

	// Specify this value to operate only on a source blob if it has been modified since the specified date-time.
	SourceIfModifiedSince *time.Time

	// Specify this value to operate only on a source blob with a non-matching Etag value.
	SourceIfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date-time.
	SourceIfUnmodifiedSince *time.Time

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

PageBlobClientUploadPagesFromURLOptions contains the optional parameters for the PageBlobClient.UploadPagesFromURL method.

func (*PageBlobClientUploadPagesFromURLOptions) SetSourceContentCRC64 added in v0.6.0 

func (p *PageBlobClientUploadPagesFromURLOptions) SetSourceContentCRC64(v []byte)

func (*PageBlobClientUploadPagesFromURLOptions) SetSourceContentMD5 added in v0.6.0 

func (p *PageBlobClientUploadPagesFromURLOptions) SetSourceContentMD5(v []byte)

type PageBlobClientUploadPagesFromURLResponse 

type PageBlobClientUploadPagesFromURLResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientUploadPagesFromURLResponse contains the response from method PageBlobClient.UploadPagesFromURL.

type PageBlobClientUploadPagesOptions 

type PageBlobClientUploadPagesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The algorithm used to produce the encryption key hash. Must be provided if the encryption key is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Specifies the encryption key to use to encrypt the data provided in the request.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the encryption key is provided.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Specify this value to operate only on a blob with a matching Etag value.
	IfMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has been modified since the specified date-time.
	IfModifiedSince *time.Time

	// Specify this value to operate only on a blob with a non-matching Etag value.
	IfNoneMatch *azcore.ETag

	// Specify this value to operate only on a blob if it has the specified sequence number.
	IfSequenceNumberEqualTo *int64

	// Specify this value to operate only on a blob if it has a sequence number less than the specified.
	IfSequenceNumberLessThan *int64

	// Specify this value to operate only on a blob if it has a sequence number less than or equal to the specified.
	IfSequenceNumberLessThanOrEqualTo *int64

	// Specifies a SQL-like where clause on blob tags to operate only on a blob with matching tags.
	IfTags *string

	// Specify this value to operate only on a blob if it has not been modified since the specified date-time.
	IfUnmodifiedSince *time.Time

	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string

	// Required if the request body is a structured message. Specifies the message schema version and properties.
	StructuredBodyType *string

	// Required if the request body is a structured message. Specifies the length of the blob/file content inside the message
	// body. Will always be smaller than Content-Length.
	StructuredContentLength *int64

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32

	// Specifies the transactional CRC64 hash for the body.
	TransactionalContentCRC64 []byte

	// Specifies the transactional MD5 hash for the body.
	TransactionalContentMD5 []byte
}

PageBlobClientUploadPagesOptions contains the optional parameters for the PageBlobClient.UploadPages method.

func (*PageBlobClientUploadPagesOptions) SetCRC64 added in v0.6.0 

func (p *PageBlobClientUploadPagesOptions) SetCRC64(v []byte)

func (*PageBlobClientUploadPagesOptions) SetMD5 added in v0.6.0 

func (p *PageBlobClientUploadPagesOptions) SetMD5(v []byte)

func (*PageBlobClientUploadPagesOptions) SetStructuredBody 

func (p *PageBlobClientUploadPagesOptions) SetStructuredBody(bodyType string, contentLength int64)

type PageBlobClientUploadPagesResponse 

type PageBlobClientUploadPagesResponse struct {
	// The current sequence number for a page blob.
	BlobSequenceNumber *int64

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The CRC64 hash of the content.
	ContentCRC64 []byte

	// The blob content MD5 hash. Only returned if the full blob is read.
	ContentMD5 []byte

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque identifier for the current state of the resource.
	ETag *azcore.ETag

	// The SHA-256 hash of the provided encryption key.
	EncryptionKeySHA256 *string

	// Specifies the encryption scope used to encrypt the data.
	EncryptionScope *string

	// Indicates whether the contents of the request are successfully encrypted.
	IsServerEncrypted *bool

	// The date-time that the resource was last modified.
	LastModified *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Indicates if the response body contains a structured message and specifies the message schema version and properties.
	StructuredBodyType *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

PageBlobClientUploadPagesResponse contains the response from method PageBlobClient.UploadPages.

type PageList 

type PageList struct {
	// The clear ranges.
	ClearRange []*ClearRange `xml:"ClearRange"`

	// An opaque string value that identifies the portion of the result set to be returned with the next operation. Use this value
	// in the next request to continue the listing operation.
	NextMarker *string `xml:"NextMarker"`

	// The page ranges.
	PageRange []*PageRange `xml:"PageRange"`
}

PageList - The result of the Get Pages API.

func (PageList) MarshalXML 

func (p PageList) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type PageList.

type PageRange 

type PageRange struct {
	// REQUIRED; The end of the byte range.
	End *int64 `xml:"End"`

	// REQUIRED; The start of the byte range.
	Start *int64 `xml:"Start"`
}

PageRange - A page range.

type ParquetConfiguration 

type ParquetConfiguration struct {
	AdditionalProperties map[string]any
}

ParquetConfiguration - Represents the Parquet configuration.

type PremiumPageBlobAccessTier 

type PremiumPageBlobAccessTier string

PremiumPageBlobAccessTier - The premium page blob access tier types. 

const (
	// PremiumPageBlobAccessTierP10 - The premium page blob access tier is P10.
	PremiumPageBlobAccessTierP10 PremiumPageBlobAccessTier = "P10"
	// PremiumPageBlobAccessTierP15 - The premium page blob access tier is P15.
	PremiumPageBlobAccessTierP15 PremiumPageBlobAccessTier = "P15"
	// PremiumPageBlobAccessTierP20 - The premium page blob access tier is P20.
	PremiumPageBlobAccessTierP20 PremiumPageBlobAccessTier = "P20"
	// PremiumPageBlobAccessTierP30 - The premium page blob access tier is P30.
	PremiumPageBlobAccessTierP30 PremiumPageBlobAccessTier = "P30"
	// PremiumPageBlobAccessTierP4 - The premium page blob access tier is P4.
	PremiumPageBlobAccessTierP4 PremiumPageBlobAccessTier = "P4"
	// PremiumPageBlobAccessTierP40 - The premium page blob access tier is P40.
	PremiumPageBlobAccessTierP40 PremiumPageBlobAccessTier = "P40"
	// PremiumPageBlobAccessTierP50 - The premium page blob access tier is P50.
	PremiumPageBlobAccessTierP50 PremiumPageBlobAccessTier = "P50"
	// PremiumPageBlobAccessTierP6 - The premium page blob access tier is P6.
	PremiumPageBlobAccessTierP6 PremiumPageBlobAccessTier = "P6"
	// PremiumPageBlobAccessTierP60 - The premium page blob access tier is P60.
	PremiumPageBlobAccessTierP60 PremiumPageBlobAccessTier = "P60"
	// PremiumPageBlobAccessTierP70 - The premium page blob access tier is P70.
	PremiumPageBlobAccessTierP70 PremiumPageBlobAccessTier = "P70"
	// PremiumPageBlobAccessTierP80 - The premium page blob access tier is P80.
	PremiumPageBlobAccessTierP80 PremiumPageBlobAccessTier = "P80"
)

func PossiblePremiumPageBlobAccessTierValues 

func PossiblePremiumPageBlobAccessTierValues() []PremiumPageBlobAccessTier

PossiblePremiumPageBlobAccessTierValues returns the possible values for the PremiumPageBlobAccessTier const type.

type PublicAccessType 

type PublicAccessType string

PublicAccessType - The public access type. 

const (
	// PublicAccessTypeBlob - Blob access.
	PublicAccessTypeBlob PublicAccessType = "blob"
	// PublicAccessTypeContainer - Container access.
	PublicAccessTypeContainer PublicAccessType = "container"
)

func PossiblePublicAccessTypeValues 

func PossiblePublicAccessTypeValues() []PublicAccessType

PossiblePublicAccessTypeValues returns the possible values for the PublicAccessType const type.

type QueryFormat 

type QueryFormat struct {
	// REQUIRED; The query type.
	Type *QueryFormatType `xml:"Type"`

	// The Apache Arrow configuration.
	ArrowConfiguration *ArrowConfiguration `xml:"ArrowConfiguration"`

	// The delimited text configuration.
	DelimitedTextConfiguration *DelimitedTextConfiguration `xml:"DelimitedTextConfiguration"`

	// The JSON text configuration.
	JSONTextConfiguration *JSONTextConfiguration `xml:"JsonTextConfiguration"`

	// The Parquet configuration.
	ParquetTextConfiguration *ParquetConfiguration `xml:"ParquetTextConfiguration"`
}

QueryFormat - The query format settings.

type QueryFormatType 

type QueryFormatType string

QueryFormatType - The query format type. 

const (
	// QueryFormatTypeArrow - The query format type is Apache Arrow.
	QueryFormatTypeArrow QueryFormatType = "arrow"
	// QueryFormatTypeDelimited - The query format type is delimited.
	QueryFormatTypeDelimited QueryFormatType = "delimited"
	// QueryFormatTypeJSON - The query format type is JSON.
	QueryFormatTypeJSON QueryFormatType = "json"
	// QueryFormatTypeParquet - The query format type is Parquet.
	QueryFormatTypeParquet QueryFormatType = "parquet"
)

func PossibleQueryFormatTypeValues 

func PossibleQueryFormatTypeValues() []QueryFormatType

PossibleQueryFormatTypeValues returns the possible values for the QueryFormatType const type.

type QueryRequest 

type QueryRequest struct {
	// REQUIRED; The query expression. The maximum size of the query expression is 256KiB.
	Expression *string `xml:"Expression"`

	// REQUIRED; Required. The type of the provided query expression.
	QueryType *QueryRequestType `xml:"QueryType"`

	// The input serialization settings.
	InputSerialization *QuerySerialization `xml:"InputSerialization"`

	// The output serialization settings.
	OutputSerialization *QuerySerialization `xml:"OutputSerialization"`
}

QueryRequest - Groups the set of query request settings.

type QueryRequestType 

type QueryRequestType string

QueryRequestType - The query request type. 

const (
	// QueryRequestTypeSQL - The SQL request query type.
	QueryRequestTypeSQL QueryRequestType = "SQL"
)

func PossibleQueryRequestTypeValues 

func PossibleQueryRequestTypeValues() []QueryRequestType

PossibleQueryRequestTypeValues returns the possible values for the QueryRequestType const type.

type QuerySerialization 

type QuerySerialization struct {
	// REQUIRED; The query format.
	Format *QueryFormat `xml:"Format"`
}

QuerySerialization - The query serialization settings.

type RehydratePriority 

type RehydratePriority string

RehydratePriority - The priority of the rehydrate operation. 

const (
	// RehydratePriorityHigh - The rehydrate priority is high.
	RehydratePriorityHigh RehydratePriority = "High"
	// RehydratePriorityStandard - The rehydrate priority is standard.
	RehydratePriorityStandard RehydratePriority = "Standard"
)

func PossibleRehydratePriorityValues 

func PossibleRehydratePriorityValues() []RehydratePriority

PossibleRehydratePriorityValues returns the possible values for the RehydratePriority const type.

type RetentionPolicy 

type RetentionPolicy struct {
	// REQUIRED; Whether the policy is enabled.
	Enabled *bool `xml:"Enabled"`

	// Whether to allow permanent delete.
	AllowPermanentDelete *bool `xml:"AllowPermanentDelete"`

	// The number of days to retain the logs.
	Days *int32 `xml:"Days"`
}

RetentionPolicy - The retention policy.

type SKUName 

type SKUName string

SKUName - The account SKU. 

const (
	// SKUNamePremiumLRS - The premium LRS SKU.
	SKUNamePremiumLRS SKUName = "Premium_LRS"
	// SKUNamePremiumZRS - The premium ZRS SKU.
	SKUNamePremiumZRS SKUName = "Premium_ZRS"
	// SKUNameStandardGRS - The standard GRS SKU.
	SKUNameStandardGRS SKUName = "Standard_GRS"
	// SKUNameStandardGZRS - The standard GZRS SKU.
	SKUNameStandardGZRS SKUName = "Standard_GZRS"
	// SKUNameStandardLRS - The standard LRS SKU.
	SKUNameStandardLRS SKUName = "Standard_LRS"
	// SKUNameStandardRAGRS - The standard RAGRS SKU.
	SKUNameStandardRAGRS SKUName = "Standard_RAGRS"
	// SKUNameStandardRAGZRS - The standard RAGZRS SKU.
	SKUNameStandardRAGZRS SKUName = "Standard_RAGZRS"
	// SKUNameStandardZRS - The standard ZRS SKU.
	SKUNameStandardZRS SKUName = "Standard_ZRS"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SequenceNumberAccessConditions 

type SequenceNumberAccessConditions struct {
	// Specify this header value to operate only on a blob if it has the specified sequence number.
	IfSequenceNumberEqualTo *int64

	// Specify this header value to operate only on a blob if it has a sequence number less than the specified.
	IfSequenceNumberLessThan *int64

	// Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified.
	IfSequenceNumberLessThanOrEqualTo *int64
}

SequenceNumberAccessConditions contains a group of parameters for the PageBlobClient.UploadPages method.

type SequenceNumberActionType 

type SequenceNumberActionType string

SequenceNumberActionType - The sequence number actions. 

const (
	// SequenceNumberActionTypeIncrement - Increment the sequence number.
	SequenceNumberActionTypeIncrement SequenceNumberActionType = "increment"
	// SequenceNumberActionTypeMax - Set the maximum for the sequence number.
	SequenceNumberActionTypeMax SequenceNumberActionType = "max"
	// SequenceNumberActionTypeUpdate - Update the sequence number.
	SequenceNumberActionTypeUpdate SequenceNumberActionType = "update"
)

func PossibleSequenceNumberActionTypeValues 

func PossibleSequenceNumberActionTypeValues() []SequenceNumberActionType

PossibleSequenceNumberActionTypeValues returns the possible values for the SequenceNumberActionType const type.

type ServiceClient 

type ServiceClient struct {
	// contains filtered or unexported fields
}

ServiceClient contains the methods for the Service group. Don't use this type directly, use a constructor function instead.

Generated from API version 2026-12-06

func NewServiceClient 

func NewServiceClient(endpoint string, azClient *azcore.Client) *ServiceClient

NewServiceClient creates a new instance of ServiceClient with the specified values.

  • endpoint - The URL of the service account, container, or blob that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*ServiceClient) Endpoint 

func (client *ServiceClient) Endpoint() string

func (*ServiceClient) FilterBlobs 

func (client *ServiceClient) FilterBlobs(ctx context.Context, filterExpression string, options *ServiceClientFilterBlobsOptions) (ServiceClientFilterBlobsResponse, error)

FilterBlobs - Lists blobs across all containers whose tags match a given search expression. If the operation fails it returns an *azcore.ResponseError type.

  • filterExpression - Filters the results to return only blobs whose tags match the specified expression.
  • options - ServiceClientFilterBlobsOptions contains the optional parameters for the ServiceClient.FilterBlobs method.

func (*ServiceClient) GetAccountInfo 

func (client *ServiceClient) GetAccountInfo(ctx context.Context, options *ServiceClientGetAccountInfoOptions) (ServiceClientGetAccountInfoResponse, error)

GetAccountInfo - Returns information about the storage account. If the operation fails it returns an *azcore.ResponseError type.

  • options - ServiceClientGetAccountInfoOptions contains the optional parameters for the ServiceClient.GetAccountInfo method.

func (*ServiceClient) GetProperties 

func (client *ServiceClient) GetProperties(ctx context.Context, options *ServiceClientGetPropertiesOptions) (ServiceClientGetPropertiesResponse, error)

GetProperties - Retrieves properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. If the operation fails it returns an *azcore.ResponseError type.

  • options - ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

func (*ServiceClient) GetStatistics 

func (client *ServiceClient) GetStatistics(ctx context.Context, options *ServiceClientGetStatisticsOptions) (ServiceClientGetStatisticsResponse, error)

GetStatistics - Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. If the operation fails it returns an *azcore.ResponseError type.

  • options - ServiceClientGetStatisticsOptions contains the optional parameters for the ServiceClient.GetStatistics method.

func (*ServiceClient) GetUserDelegationKey 

func (client *ServiceClient) GetUserDelegationKey(ctx context.Context, keyInfo KeyInfo, options *ServiceClientGetUserDelegationKeyOptions) (ServiceClientGetUserDelegationKeyResponse, error)

GetUserDelegationKey - Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication. If the operation fails it returns an *azcore.ResponseError type.

  • keyInfo - Key information provided in the request.
  • options - ServiceClientGetUserDelegationKeyOptions contains the optional parameters for the ServiceClient.GetUserDelegationKey method.

func (*ServiceClient) InternalClient added in v1.2.0 

func (client *ServiceClient) InternalClient() *azcore.Client

func (*ServiceClient) ListContainersSegment 

func (client *ServiceClient) ListContainersSegment(ctx context.Context, options *ServiceClientListContainersSegmentOptions) (ServiceClientListContainersSegmentResponse, error)

ListContainersSegment - Returns a list of the containers in the specified account. If the operation fails it returns an *azcore.ResponseError type.

  • options - ServiceClientListContainersSegmentOptions contains the optional parameters for the ServiceClient.ListContainersSegment method.

func (*ServiceClient) ListContainersSegmentCreateRequest 

func (client *ServiceClient) ListContainersSegmentCreateRequest(ctx context.Context, options *ServiceClientListContainersSegmentOptions) (*policy.Request, error)

ListContainersSegmentCreateRequest creates the ListContainersSegment request.

func (*ServiceClient) ListContainersSegmentHandleResponse 

func (client *ServiceClient) ListContainersSegmentHandleResponse(resp *http.Response, successCodes ...int) (ServiceClientListContainersSegmentResponse, error)

ListContainersSegmentHandleResponse handles the ListContainersSegment response.

func (*ServiceClient) SetProperties 

func (client *ServiceClient) SetProperties(ctx context.Context, storageServiceProperties StorageServiceProperties, options *ServiceClientSetPropertiesOptions) (ServiceClientSetPropertiesResponse, error)

SetProperties - Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. If the operation fails it returns an *azcore.ResponseError type.

  • storageServiceProperties - The storage service properties to set.
  • options - ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

func (*ServiceClient) SubmitBatch 

func (client *ServiceClient) SubmitBatch(ctx context.Context, multipartContentType string, contentLength int64, body io.ReadSeekCloser, options *ServiceClientSubmitBatchOptions) (ServiceClientSubmitBatchResponse, error)

SubmitBatch - Allows multiple API calls to be embedded into a single HTTP request. If the operation fails it returns an *azcore.ResponseError type.

  • multipartContentType - The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
  • contentLength - The length of the request.
  • body - The body of the request.
  • options - ServiceClientSubmitBatchOptions contains the optional parameters for the ServiceClient.SubmitBatch method.

type ServiceClientFilterBlobsOptions 

type ServiceClientFilterBlobsOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify to include additional, optional information.
	Include []FilterBlobsIncludeItem

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientFilterBlobsOptions contains the optional parameters for the ServiceClient.FilterBlobs method.

type ServiceClientFilterBlobsResponse 

type ServiceClientFilterBlobsResponse struct {
	// The result of the Find Blobs by Tags API.
	FilterBlobSegment

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientFilterBlobsResponse contains the response from method ServiceClient.FilterBlobs.

type ServiceClientGetAccountInfoOptions 

type ServiceClientGetAccountInfoOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientGetAccountInfoOptions contains the optional parameters for the ServiceClient.GetAccountInfo method.

type ServiceClientGetAccountInfoResponse 

type ServiceClientGetAccountInfoResponse struct {
	// The account kind.
	AccountKind *AccountKind

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// Indicates if the account has hierarchical namespace enabled.
	IsHierarchicalNamespaceEnabled *bool

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// The SKU name of the account.
	SKUName *SKUName

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientGetAccountInfoResponse contains the response from method ServiceClient.GetAccountInfo.

type ServiceClientGetPropertiesOptions 

type ServiceClientGetPropertiesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

type ServiceClientGetPropertiesResponse 

type ServiceClientGetPropertiesResponse struct {
	// The blob service properties.
	StorageServiceProperties

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientGetPropertiesResponse contains the response from method ServiceClient.GetProperties.

type ServiceClientGetStatisticsOptions 

type ServiceClientGetStatisticsOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientGetStatisticsOptions contains the optional parameters for the ServiceClient.GetStatistics method.

type ServiceClientGetStatisticsResponse 

type ServiceClientGetStatisticsResponse struct {
	// Stats for the storage service.
	StorageServiceStats

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientGetStatisticsResponse contains the response from method ServiceClient.GetStatistics.

type ServiceClientGetUserDelegationKeyOptions 

type ServiceClientGetUserDelegationKeyOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientGetUserDelegationKeyOptions contains the optional parameters for the ServiceClient.GetUserDelegationKey method.

type ServiceClientGetUserDelegationKeyResponse 

type ServiceClientGetUserDelegationKeyResponse struct {
	// A user delegation key.
	UserDelegationKey

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientGetUserDelegationKeyResponse contains the response from method ServiceClient.GetUserDelegationKey.

type ServiceClientListContainersSegmentOptions 

type ServiceClientListContainersSegmentOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Specify to include additional, optional information.
	Include []ListContainersIncludeType

	// An opaque string value that identifies the portion of the result set to return with this operation.
	Marker *string

	// Specifies the maximum number of resources to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items.
	Maxresults *int32

	// Filters the results to return only resources whose name begins with the specified prefix.
	Prefix *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientListContainersSegmentOptions contains the optional parameters for the ServiceClient.ListContainersSegment method.

type ServiceClientListContainersSegmentResponse 

type ServiceClientListContainersSegmentResponse struct {
	// The result of the List Containers API.
	ListContainersSegmentResponse

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Content-Type header
	ContentType *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientListContainersSegmentResponse contains the response from method ServiceClient.ListContainersSegment.

type ServiceClientSetPropertiesOptions 

type ServiceClientSetPropertiesOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

type ServiceClientSetPropertiesResponse 

type ServiceClientSetPropertiesResponse struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Date-time value generated by the service that indicates the time at which the response was initiated.
	Date *time.Time

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientSetPropertiesResponse contains the response from method ServiceClient.SetProperties.

type ServiceClientSubmitBatchOptions 

type ServiceClientSubmitBatchOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The timeout parameter is expressed in seconds. For more information, see <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations\">Setting
	// Timeouts for Blob Service Operations.</a>
	Timeout *int32
}

ServiceClientSubmitBatchOptions contains the optional parameters for the ServiceClient.SubmitBatch method.

type ServiceClientSubmitBatchResponse 

type ServiceClientSubmitBatchResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID
	ContentType *string

	// An opaque, globally-unique, server-generated string identifier for the request.
	RequestID *string

	// Specifies the version of the operation to use for this request.
	Version *string
}

ServiceClientSubmitBatchResponse contains the response from method ServiceClient.SubmitBatch.

type SignedIdentifier 

type SignedIdentifier struct {
	// REQUIRED; The unique ID for the signed identifier.
	ID *string `xml:"Id"`

	// The access policy for the signed identifier.
	AccessPolicy *AccessPolicy `xml:"AccessPolicy"`
}

SignedIdentifier - A signed identifier.

type SourceCPKInfo added in v1.7.0 

type SourceCPKInfo struct {
	// The algorithm used to produce the source encryption key hash. Currently, the only accepted value is "AES256". Must be provided
	// if the x-ms-source-encryption-key is provided.
	SourceEncryptionAlgorithm *EncryptionAlgorithmType

	// Optional. Specifies the source encryption key to use to encrypt the source data provided in the request.
	SourceEncryptionKey *string

	// The SHA-256 hash of the provided source encryption key. Must be provided if the x-ms-source-encryption-key header is provided.
	SourceEncryptionKeySHA256 *string
}

SourceCPKInfo contains a group of parameters for the PageBlobClient.UploadPagesFromURL method.

type SourceContentSetter added in v0.6.0 

type SourceContentSetter interface {
	SetSourceContentCRC64(v []byte)
	SetSourceContentMD5(v []byte)
}

type SourceModifiedAccessConditions 

type SourceModifiedAccessConditions struct {
	// Specify an ETag value to operate only on blobs with a matching value.
	SourceIfMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has been modified since the specified date/time.
	SourceIfModifiedSince *time.Time

	// Specify an ETag value to operate only on blobs without a matching value.
	SourceIfNoneMatch *azcore.ETag

	// Specify a SQL where clause on blob tags to operate only on blobs with a matching value.
	SourceIfTags *string

	// Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
	SourceIfUnmodifiedSince *time.Time
}

SourceModifiedAccessConditions contains a group of parameters for the BlobClient.StartCopyFromURL method.

type StaticWebsite 

type StaticWebsite struct {
	// REQUIRED; Indicates whether this account is hosting a static website.
	Enabled *bool `xml:"Enabled"`

	// Absolute path of the default index page.
	DefaultIndexDocumentPath *string `xml:"DefaultIndexDocumentPath"`

	// The error document.
	ErrorDocument404Path *string `xml:"ErrorDocument404Path"`

	// The index document.
	IndexDocument *string `xml:"IndexDocument"`
}

StaticWebsite - The properties that enable an account to host a static website.

type StorageErrorCode 

type StorageErrorCode string

StorageErrorCode - Error codes returned by the Azure Blob Storage service. 

const (
	// StorageErrorCodeAccountAlreadyExists - Account already exists.
	StorageErrorCodeAccountAlreadyExists StorageErrorCode = "AccountAlreadyExists"
	// StorageErrorCodeAccountBeingCreated - Account is being created.
	StorageErrorCodeAccountBeingCreated StorageErrorCode = "AccountBeingCreated"
	// StorageErrorCodeAccountIsDisabled - Account is disabled.
	StorageErrorCodeAccountIsDisabled StorageErrorCode = "AccountIsDisabled"
	// StorageErrorCodeAppendPositionConditionNotMet - Append position condition not met.
	StorageErrorCodeAppendPositionConditionNotMet StorageErrorCode = "AppendPositionConditionNotMet"
	// StorageErrorCodeAuthenticationFailed - Authentication failed.
	StorageErrorCodeAuthenticationFailed StorageErrorCode = "AuthenticationFailed"
	// StorageErrorCodeAuthorizationFailure - Authorization failure.
	StorageErrorCodeAuthorizationFailure StorageErrorCode = "AuthorizationFailure"
	// StorageErrorCodeAuthorizationPermissionMismatch - Authorization permission mismatch.
	StorageErrorCodeAuthorizationPermissionMismatch StorageErrorCode = "AuthorizationPermissionMismatch"
	// StorageErrorCodeAuthorizationProtocolMismatch - Authorization protocol mismatch.
	StorageErrorCodeAuthorizationProtocolMismatch StorageErrorCode = "AuthorizationProtocolMismatch"
	// StorageErrorCodeAuthorizationResourceTypeMismatch - Authorization resource type mismatch.
	StorageErrorCodeAuthorizationResourceTypeMismatch StorageErrorCode = "AuthorizationResourceTypeMismatch"
	// StorageErrorCodeAuthorizationServiceMismatch - Authorization service mismatch.
	StorageErrorCodeAuthorizationServiceMismatch StorageErrorCode = "AuthorizationServiceMismatch"
	// StorageErrorCodeAuthorizationSourceIPMismatch - Authorization source IP mismatch.
	StorageErrorCodeAuthorizationSourceIPMismatch StorageErrorCode = "AuthorizationSourceIPMismatch"
	// StorageErrorCodeBlobAccessTierNotSupportedForAccountType - Blob access tier not supported for account type.
	StorageErrorCodeBlobAccessTierNotSupportedForAccountType StorageErrorCode = "BlobAccessTierNotSupportedForAccountType"
	// StorageErrorCodeBlobAlreadyExists - Blob already exists.
	StorageErrorCodeBlobAlreadyExists StorageErrorCode = "BlobAlreadyExists"
	// StorageErrorCodeBlobArchived - Blob archived.
	StorageErrorCodeBlobArchived StorageErrorCode = "BlobArchived"
	// StorageErrorCodeBlobBeingRehydrated - Blob being rehydrated.
	StorageErrorCodeBlobBeingRehydrated StorageErrorCode = "BlobBeingRehydrated"
	// StorageErrorCodeBlobImmutableDueToPolicy - Blob is immutable due to policy.
	StorageErrorCodeBlobImmutableDueToPolicy StorageErrorCode = "BlobImmutableDueToPolicy"
	// StorageErrorCodeBlobNotArchived - Blob not archived.
	StorageErrorCodeBlobNotArchived StorageErrorCode = "BlobNotArchived"
	// StorageErrorCodeBlobNotFound - Blob not found.
	StorageErrorCodeBlobNotFound StorageErrorCode = "BlobNotFound"
	// StorageErrorCodeBlobOverwritten - Blob overwritten.
	StorageErrorCodeBlobOverwritten StorageErrorCode = "BlobOverwritten"
	// StorageErrorCodeBlobTierInadequateForContentLength - Blob tier inadequate for content length.
	StorageErrorCodeBlobTierInadequateForContentLength StorageErrorCode = "BlobTierInadequateForContentLength"
	// StorageErrorCodeBlobUsesCustomerSpecifiedEncryption - Blob uses customer specified encryption.
	StorageErrorCodeBlobUsesCustomerSpecifiedEncryption StorageErrorCode = "BlobUsesCustomerSpecifiedEncryption"
	// StorageErrorCodeBlockCountExceedsLimit - Block count exceeds limit.
	StorageErrorCodeBlockCountExceedsLimit StorageErrorCode = "BlockCountExceedsLimit"
	// StorageErrorCodeBlockListTooLong - Block list too long.
	StorageErrorCodeBlockListTooLong StorageErrorCode = "BlockListTooLong"
	// StorageErrorCodeCannotChangeToLowerTier - Cannot change to lower tier.
	StorageErrorCodeCannotChangeToLowerTier StorageErrorCode = "CannotChangeToLowerTier"
	// StorageErrorCodeCannotVerifyCopySource - Cannot verify copy source.
	StorageErrorCodeCannotVerifyCopySource StorageErrorCode = "CannotVerifyCopySource"
	// StorageErrorCodeConditionHeadersNotSupported - Condition headers not supported.
	StorageErrorCodeConditionHeadersNotSupported StorageErrorCode = "ConditionHeadersNotSupported"
	// StorageErrorCodeConditionNotMet - Condition not met.
	StorageErrorCodeConditionNotMet StorageErrorCode = "ConditionNotMet"
	// StorageErrorCodeContainerAlreadyExists - Container already exists.
	StorageErrorCodeContainerAlreadyExists StorageErrorCode = "ContainerAlreadyExists"
	// StorageErrorCodeContainerBeingDeleted - Container being deleted.
	StorageErrorCodeContainerBeingDeleted StorageErrorCode = "ContainerBeingDeleted"
	// StorageErrorCodeContainerDisabled - Container disabled.
	StorageErrorCodeContainerDisabled StorageErrorCode = "ContainerDisabled"
	// StorageErrorCodeContainerNotFound - Container not found.
	StorageErrorCodeContainerNotFound StorageErrorCode = "ContainerNotFound"
	// StorageErrorCodeContentLengthLargerThanTierLimit - Content length larger than tier limit.
	StorageErrorCodeContentLengthLargerThanTierLimit StorageErrorCode = "ContentLengthLargerThanTierLimit"
	// StorageErrorCodeCopyAcrossAccountsNotSupported - Copy across accounts not supported.
	StorageErrorCodeCopyAcrossAccountsNotSupported StorageErrorCode = "CopyAcrossAccountsNotSupported"
	// StorageErrorCodeCopyIDMismatch - Copy ID mismatch.
	StorageErrorCodeCopyIDMismatch StorageErrorCode = "CopyIdMismatch"
	// StorageErrorCodeEmptyMetadataKey - Empty metadata key.
	StorageErrorCodeEmptyMetadataKey StorageErrorCode = "EmptyMetadataKey"
	// StorageErrorCodeFeatureVersionMismatch - Feature version mismatch.
	StorageErrorCodeFeatureVersionMismatch StorageErrorCode = "FeatureVersionMismatch"
	// StorageErrorCodeIncrementalCopyBlobMismatch - Incremental copy blob mismatch.
	StorageErrorCodeIncrementalCopyBlobMismatch StorageErrorCode = "IncrementalCopyBlobMismatch"
	// StorageErrorCodeIncrementalCopyOfEarlierSnapshotNotAllowed - Incremental copy of an earlier snapshot is not allowed.
	StorageErrorCodeIncrementalCopyOfEarlierSnapshotNotAllowed StorageErrorCode = "IncrementalCopyOfEarlierSnapshotNotAllowed"
	// StorageErrorCodeIncrementalCopyOfEarlierVersionSnapshotNotAllowed - Incremental copy of an earlier version snapshot is
	// not allowed.
	StorageErrorCodeIncrementalCopyOfEarlierVersionSnapshotNotAllowed StorageErrorCode = "IncrementalCopyOfEarlierVersionSnapshotNotAllowed"
	// StorageErrorCodeIncrementalCopySourceMustBeSnapshot - Incremental copy source must be snapshot.
	StorageErrorCodeIncrementalCopySourceMustBeSnapshot StorageErrorCode = "IncrementalCopySourceMustBeSnapshot"
	// StorageErrorCodeInfiniteLeaseDurationRequired - Infinite lease duration required.
	StorageErrorCodeInfiniteLeaseDurationRequired StorageErrorCode = "InfiniteLeaseDurationRequired"
	// StorageErrorCodeInsufficientAccountPermissions - Insufficient account permissions.
	StorageErrorCodeInsufficientAccountPermissions StorageErrorCode = "InsufficientAccountPermissions"
	// StorageErrorCodeInternalError - Internal error.
	StorageErrorCodeInternalError StorageErrorCode = "InternalError"
	// StorageErrorCodeInvalidAuthenticationInfo - Invalid authentication information.
	StorageErrorCodeInvalidAuthenticationInfo StorageErrorCode = "InvalidAuthenticationInfo"
	// StorageErrorCodeInvalidBlobOrBlock - Invalid blob or block.
	StorageErrorCodeInvalidBlobOrBlock StorageErrorCode = "InvalidBlobOrBlock"
	// StorageErrorCodeInvalidBlobTier - Invalid blob tier.
	StorageErrorCodeInvalidBlobTier StorageErrorCode = "InvalidBlobTier"
	// StorageErrorCodeInvalidBlobType - Invalid blob type.
	StorageErrorCodeInvalidBlobType StorageErrorCode = "InvalidBlobType"
	// StorageErrorCodeInvalidBlockID - Invalid block ID.
	StorageErrorCodeInvalidBlockID StorageErrorCode = "InvalidBlockId"
	// StorageErrorCodeInvalidBlockList - Invalid block list.
	StorageErrorCodeInvalidBlockList StorageErrorCode = "InvalidBlockList"
	// StorageErrorCodeInvalidHTTPVerb - Invalid HTTP verb.
	StorageErrorCodeInvalidHTTPVerb StorageErrorCode = "InvalidHttpVerb"
	// StorageErrorCodeInvalidHeaderValue - Invalid header value.
	StorageErrorCodeInvalidHeaderValue StorageErrorCode = "InvalidHeaderValue"
	// StorageErrorCodeInvalidInput - Invalid input.
	StorageErrorCodeInvalidInput StorageErrorCode = "InvalidInput"
	// StorageErrorCodeInvalidMD5 - Invalid MD5.
	StorageErrorCodeInvalidMD5 StorageErrorCode = "InvalidMd5"
	// StorageErrorCodeInvalidMetadata - Invalid metadata.
	StorageErrorCodeInvalidMetadata StorageErrorCode = "InvalidMetadata"
	// StorageErrorCodeInvalidOperation - Invalid operation.
	StorageErrorCodeInvalidOperation StorageErrorCode = "InvalidOperation"
	// StorageErrorCodeInvalidPageRange - Invalid page range.
	StorageErrorCodeInvalidPageRange StorageErrorCode = "InvalidPageRange"
	// StorageErrorCodeInvalidQueryParameterValue - Invalid query parameter value.
	StorageErrorCodeInvalidQueryParameterValue StorageErrorCode = "InvalidQueryParameterValue"
	// StorageErrorCodeInvalidRange - Invalid range.
	StorageErrorCodeInvalidRange StorageErrorCode = "InvalidRange"
	// StorageErrorCodeInvalidRequestURL - Invalid request URL.
	StorageErrorCodeInvalidRequestURL StorageErrorCode = "InvalidRequestUrl"
	// StorageErrorCodeInvalidResourceName - Invalid resource name.
	StorageErrorCodeInvalidResourceName StorageErrorCode = "InvalidResourceName"
	// StorageErrorCodeInvalidSourceBlobType - Invalid source blob type.
	StorageErrorCodeInvalidSourceBlobType StorageErrorCode = "InvalidSourceBlobType"
	// StorageErrorCodeInvalidSourceBlobURL - Invalid source blob URL.
	StorageErrorCodeInvalidSourceBlobURL StorageErrorCode = "InvalidSourceBlobUrl"
	// StorageErrorCodeInvalidURI - Invalid URI.
	StorageErrorCodeInvalidURI StorageErrorCode = "InvalidUri"
	// StorageErrorCodeInvalidVersionForPageBlobOperation - Invalid version for page blob operation.
	StorageErrorCodeInvalidVersionForPageBlobOperation StorageErrorCode = "InvalidVersionForPageBlobOperation"
	// StorageErrorCodeInvalidXMLDocument - Invalid XML document.
	StorageErrorCodeInvalidXMLDocument StorageErrorCode = "InvalidXmlDocument"
	// StorageErrorCodeInvalidXMLNodeValue - Invalid XML node value.
	StorageErrorCodeInvalidXMLNodeValue StorageErrorCode = "InvalidXmlNodeValue"
	// StorageErrorCodeLeaseAlreadyBroken - Lease already broken.
	StorageErrorCodeLeaseAlreadyBroken StorageErrorCode = "LeaseAlreadyBroken"
	// StorageErrorCodeLeaseAlreadyPresent - Lease already present.
	StorageErrorCodeLeaseAlreadyPresent StorageErrorCode = "LeaseAlreadyPresent"
	// StorageErrorCodeLeaseIDMismatchWithBlobOperation - Lease ID mismatch with blob operation.
	StorageErrorCodeLeaseIDMismatchWithBlobOperation StorageErrorCode = "LeaseIdMismatchWithBlobOperation"
	// StorageErrorCodeLeaseIDMismatchWithContainerOperation - Lease ID mismatch with container operation.
	StorageErrorCodeLeaseIDMismatchWithContainerOperation StorageErrorCode = "LeaseIdMismatchWithContainerOperation"
	// StorageErrorCodeLeaseIDMismatchWithLeaseOperation - Lease ID mismatch with lease operation.
	StorageErrorCodeLeaseIDMismatchWithLeaseOperation StorageErrorCode = "LeaseIdMismatchWithLeaseOperation"
	// StorageErrorCodeLeaseIDMissing - Lease ID missing.
	StorageErrorCodeLeaseIDMissing StorageErrorCode = "LeaseIdMissing"
	// StorageErrorCodeLeaseIsBreakingAndCannotBeAcquired - Lease is breaking and cannot be acquired.
	StorageErrorCodeLeaseIsBreakingAndCannotBeAcquired StorageErrorCode = "LeaseIsBreakingAndCannotBeAcquired"
	// StorageErrorCodeLeaseIsBreakingAndCannotBeChanged - Lease is breaking and cannot be changed.
	StorageErrorCodeLeaseIsBreakingAndCannotBeChanged StorageErrorCode = "LeaseIsBreakingAndCannotBeChanged"
	// StorageErrorCodeLeaseIsBrokenAndCannotBeRenewed - Lease is broken and cannot be renewed.
	StorageErrorCodeLeaseIsBrokenAndCannotBeRenewed StorageErrorCode = "LeaseIsBrokenAndCannotBeRenewed"
	// StorageErrorCodeLeaseLost - Lease lost.
	StorageErrorCodeLeaseLost StorageErrorCode = "LeaseLost"
	// StorageErrorCodeLeaseNotPresentWithBlobOperation - Lease not present with blob operation.
	StorageErrorCodeLeaseNotPresentWithBlobOperation StorageErrorCode = "LeaseNotPresentWithBlobOperation"
	// StorageErrorCodeLeaseNotPresentWithContainerOperation - Lease not present with container operation.
	StorageErrorCodeLeaseNotPresentWithContainerOperation StorageErrorCode = "LeaseNotPresentWithContainerOperation"
	// StorageErrorCodeLeaseNotPresentWithLeaseOperation - Lease not present with lease operation.
	StorageErrorCodeLeaseNotPresentWithLeaseOperation StorageErrorCode = "LeaseNotPresentWithLeaseOperation"
	// StorageErrorCodeMD5Mismatch - MD5 mismatch.
	StorageErrorCodeMD5Mismatch StorageErrorCode = "Md5Mismatch"
	// StorageErrorCodeMaxBlobSizeConditionNotMet - Maximum blob size condition not met.
	StorageErrorCodeMaxBlobSizeConditionNotMet StorageErrorCode = "MaxBlobSizeConditionNotMet"
	// StorageErrorCodeMetadataTooLarge - Metadata too large.
	StorageErrorCodeMetadataTooLarge StorageErrorCode = "MetadataTooLarge"
	// StorageErrorCodeMissingContentLengthHeader - Missing content length header.
	StorageErrorCodeMissingContentLengthHeader StorageErrorCode = "MissingContentLengthHeader"
	// StorageErrorCodeMissingRequiredHeader - Missing required header.
	StorageErrorCodeMissingRequiredHeader StorageErrorCode = "MissingRequiredHeader"
	// StorageErrorCodeMissingRequiredQueryParameter - Missing required query parameter.
	StorageErrorCodeMissingRequiredQueryParameter StorageErrorCode = "MissingRequiredQueryParameter"
	// StorageErrorCodeMissingRequiredXMLNode - Missing required XML node.
	StorageErrorCodeMissingRequiredXMLNode StorageErrorCode = "MissingRequiredXmlNode"
	// StorageErrorCodeMultipleConditionHeadersNotSupported - Multiple condition headers not supported.
	StorageErrorCodeMultipleConditionHeadersNotSupported StorageErrorCode = "MultipleConditionHeadersNotSupported"
	// StorageErrorCodeNoAuthenticationInformation - No authentication information.
	StorageErrorCodeNoAuthenticationInformation StorageErrorCode = "NoAuthenticationInformation"
	// StorageErrorCodeNoPendingCopyOperation - No pending copy operation.
	StorageErrorCodeNoPendingCopyOperation StorageErrorCode = "NoPendingCopyOperation"
	// StorageErrorCodeOperationNotAllowedOnIncrementalCopyBlob - Operation not allowed on incremental copy blob.
	StorageErrorCodeOperationNotAllowedOnIncrementalCopyBlob StorageErrorCode = "OperationNotAllowedOnIncrementalCopyBlob"
	// StorageErrorCodeOperationTimedOut - Operation timed out.
	StorageErrorCodeOperationTimedOut StorageErrorCode = "OperationTimedOut"
	// StorageErrorCodeOutOfRangeInput - Out of range input.
	StorageErrorCodeOutOfRangeInput StorageErrorCode = "OutOfRangeInput"
	// StorageErrorCodeOutOfRangeQueryParameterValue - Out of range query parameter value.
	StorageErrorCodeOutOfRangeQueryParameterValue StorageErrorCode = "OutOfRangeQueryParameterValue"
	// StorageErrorCodePendingCopyOperation - Pending copy operation.
	StorageErrorCodePendingCopyOperation StorageErrorCode = "PendingCopyOperation"
	// StorageErrorCodePreviousSnapshotCannotBeNewer - Previous snapshot cannot be newer.
	StorageErrorCodePreviousSnapshotCannotBeNewer StorageErrorCode = "PreviousSnapshotCannotBeNewer"
	// StorageErrorCodePreviousSnapshotNotFound - Previous snapshot not found.
	StorageErrorCodePreviousSnapshotNotFound StorageErrorCode = "PreviousSnapshotNotFound"
	// StorageErrorCodePreviousSnapshotOperationNotSupported - Previous snapshot operation not supported.
	StorageErrorCodePreviousSnapshotOperationNotSupported StorageErrorCode = "PreviousSnapshotOperationNotSupported"
	// StorageErrorCodeRequestBodyTooLarge - Request body too large.
	StorageErrorCodeRequestBodyTooLarge StorageErrorCode = "RequestBodyTooLarge"
	// StorageErrorCodeRequestURLFailedToParse - Request URL failed to parse.
	StorageErrorCodeRequestURLFailedToParse StorageErrorCode = "RequestUrlFailedToParse"
	// StorageErrorCodeResourceAlreadyExists - Resource already exists.
	StorageErrorCodeResourceAlreadyExists StorageErrorCode = "ResourceAlreadyExists"
	// StorageErrorCodeResourceNotFound - Resource not found.
	StorageErrorCodeResourceNotFound StorageErrorCode = "ResourceNotFound"
	// StorageErrorCodeResourceTypeMismatch - Resource type mismatch.
	StorageErrorCodeResourceTypeMismatch StorageErrorCode = "ResourceTypeMismatch"
	// StorageErrorCodeSequenceNumberConditionNotMet - Sequence number condition not met.
	StorageErrorCodeSequenceNumberConditionNotMet StorageErrorCode = "SequenceNumberConditionNotMet"
	// StorageErrorCodeSequenceNumberIncrementTooLarge - Sequence number increment too large.
	StorageErrorCodeSequenceNumberIncrementTooLarge StorageErrorCode = "SequenceNumberIncrementTooLarge"
	// StorageErrorCodeServerBusy - Server busy.
	StorageErrorCodeServerBusy StorageErrorCode = "ServerBusy"
	// StorageErrorCodeSnapshotCountExceeded - Snapshot count exceeded.
	StorageErrorCodeSnapshotCountExceeded StorageErrorCode = "SnapshotCountExceeded"
	// StorageErrorCodeSnapshotOperationRateExceeded - Snapshot operation rate exceeded.
	StorageErrorCodeSnapshotOperationRateExceeded StorageErrorCode = "SnapshotOperationRateExceeded"
	// StorageErrorCodeSnapshotsPresent - Snapshots present.
	StorageErrorCodeSnapshotsPresent StorageErrorCode = "SnapshotsPresent"
	// StorageErrorCodeSourceConditionNotMet - Source condition not met.
	StorageErrorCodeSourceConditionNotMet StorageErrorCode = "SourceConditionNotMet"
	// StorageErrorCodeSystemInUse - System in use.
	StorageErrorCodeSystemInUse StorageErrorCode = "SystemInUse"
	// StorageErrorCodeTargetConditionNotMet - Target condition not met.
	StorageErrorCodeTargetConditionNotMet StorageErrorCode = "TargetConditionNotMet"
	// StorageErrorCodeUnauthorizedBlobOverwrite - Unauthorized blob overwrite.
	StorageErrorCodeUnauthorizedBlobOverwrite StorageErrorCode = "UnauthorizedBlobOverwrite"
	// StorageErrorCodeUnsupportedHTTPVerb - Unsupported HTTP verb.
	StorageErrorCodeUnsupportedHTTPVerb StorageErrorCode = "UnsupportedHttpVerb"
	// StorageErrorCodeUnsupportedHeader - Unsupported header.
	StorageErrorCodeUnsupportedHeader StorageErrorCode = "UnsupportedHeader"
	// StorageErrorCodeUnsupportedQueryParameter - Unsupported query parameter.
	StorageErrorCodeUnsupportedQueryParameter StorageErrorCode = "UnsupportedQueryParameter"
	// StorageErrorCodeUnsupportedXMLNode - Unsupported XML node.
	StorageErrorCodeUnsupportedXMLNode StorageErrorCode = "UnsupportedXmlNode"
)

func PossibleStorageErrorCodeValues 

func PossibleStorageErrorCodeValues() []StorageErrorCode

PossibleStorageErrorCodeValues returns the possible values for the StorageErrorCode const type.

type StorageServiceProperties 

type StorageServiceProperties struct {
	// The CORS properties.
	CORS []*CORSRule `xml:"Cors>CorsRule"`

	// The default service version.
	DefaultServiceVersion *string `xml:"DefaultServiceVersion"`

	// The delete retention policy.
	DeleteRetentionPolicy *RetentionPolicy `xml:"DeleteRetentionPolicy"`

	// The hour metrics properties.
	HourMetrics *Metrics `xml:"HourMetrics"`

	// The logging properties.
	Logging *Logging `xml:"Logging"`

	// The minute metrics properties.
	MinuteMetrics *Metrics `xml:"MinuteMetrics"`

	// The static website properties.
	StaticWebsite *StaticWebsite `xml:"StaticWebsite"`
}

StorageServiceProperties - The blob service properties.

func (StorageServiceProperties) MarshalXML 

func (s StorageServiceProperties) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type StorageServiceProperties.

type StorageServiceStats 

type StorageServiceStats struct {
	// The geo-replication stats.
	GeoReplication *GeoReplication `xml:"GeoReplication"`
}

StorageServiceStats - Stats for the storage service.

type TransactionalContentSetter added in v0.6.0 

type TransactionalContentSetter interface {
	SetCRC64([]byte)
	SetMD5([]byte)
	SetStructuredBody(bodyType string, contentLength int64)
}

type UserDelegationKey 

type UserDelegationKey struct {
	// REQUIRED; The date-time the key expires.
	SignedExpiry *time.Time `xml:"SignedExpiry"`

	// REQUIRED; The Entra ID object ID in GUID format.
	SignedOID *string `xml:"SignedOid"`

	// REQUIRED; Abbreviation of the Azure Storage service that accepts the key.
	SignedService *string `xml:"SignedService"`

	// REQUIRED; The date-time the key is active.
	SignedStart *time.Time `xml:"SignedStart"`

	// REQUIRED; The Entra ID tenant ID in GUID format.
	SignedTID *string `xml:"SignedTid"`

	// REQUIRED; The service version that created the key.
	SignedVersion *string `xml:"SignedVersion"`

	// REQUIRED; The base64 encoded key value.
	Value *string `xml:"Value"`

	// The delegated user tenant ID in Entra ID. Returned if DelegatedUserTid is specified.
	SignedDelegatedUserTenantID *string `xml:"SignedDelegatedUserTid"`
}

UserDelegationKey - A user delegation key.

func (UserDelegationKey) MarshalXML 

func (u UserDelegationKey) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type UserDelegationKey.

func (*UserDelegationKey) UnmarshalXML 

func (u *UserDelegationKey) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type UserDelegationKey.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.