generated

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ISO8601 is used for formatting file creation, last write and change time.
	ISO8601 = "2006-01-02T15:04:05.0000000Z07:00"
)
View Source 
const ServiceVersion = "2024-11-04"

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 ACL policy.
	Permission *string `xml:"Permission"`

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

AccessPolicy - 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 AccessRight added in v1.2.0 

type AccessRight string

AccessRight - Access rights of the access policy. 

const (
	AccessRightDelete AccessRight = "Delete"
	AccessRightRead   AccessRight = "Read"
	AccessRightWrite  AccessRight = "Write"
)

func PossibleAccessRightValues added in v1.2.0 

func PossibleAccessRightValues() []AccessRight

PossibleAccessRightValues returns the possible values for the AccessRight const type.

type CORSRule 

type CORSRule struct {
	// REQUIRED; The request headers that the origin domain may specify on the CORS request.
	AllowedHeaders *string `xml:"AllowedHeaders"`

	// REQUIRED; The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)
	AllowedMethods *string `xml:"AllowedMethods"`

	// REQUIRED; The origin domains that are permitted to make a request against the storage service via CORS. The origin domain
	// is the domain from which the request originates. Note that the origin must be an exact
	// case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*'
	// to allow all origin domains to make requests via CORS.
	AllowedOrigins *string `xml:"AllowedOrigins"`

	// REQUIRED; The response headers that may be sent in the response to the CORS request and exposed by the browser to the request
	// issuer.
	ExposedHeaders *string `xml:"ExposedHeaders"`

	// REQUIRED; The maximum amount time that a browser should cache the preflight OPTIONS request.
	MaxAgeInSeconds *int32 `xml:"MaxAgeInSeconds"`
}

CORSRule - CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.

type ClearRange 

type ClearRange struct {
	// REQUIRED
	End *int64 `xml:"End"`

	// REQUIRED
	Start *int64 `xml:"Start"`
}

type CopyFileSMBInfo 

type CopyFileSMBInfo struct {
	// Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes
	// to set on a target file.
	FileAttributes *string

	// Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in
	// ISO 8601 format to set as last write time on a target file.
	FileChangeTime *string

	// Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO
	// 8601 format to set as creation time on a target file.
	FileCreationTime *string

	// Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in
	// ISO 8601 format to set as last write time on a target file.
	FileLastWriteTime *string

	// Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by
	// the header value of x-ms-file-permission or x-ms-file-permission-key.
	FilePermissionCopyMode *PermissionCopyModeType

	// Specifies the option to overwrite the target file if it already exists and has read-only attribute set.
	IgnoreReadOnly *bool

	// Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file
	// despite attribute overrides or a source file state.
	SetArchiveAttribute *bool
}

CopyFileSMBInfo contains a group of parameters for the DirectoryClient.Rename method.

type CopyStatusType 

type CopyStatusType string
const (
	CopyStatusTypeAborted CopyStatusType = "aborted"
	CopyStatusTypeFailed  CopyStatusType = "failed"
	CopyStatusTypePending CopyStatusType = "pending"
	CopyStatusTypeSuccess CopyStatusType = "success"
)

func PossibleCopyStatusTypeValues 

func PossibleCopyStatusTypeValues() []CopyStatusType

PossibleCopyStatusTypeValues returns the possible values for the CopyStatusType const type.

type DeleteSnapshotsOptionType 

type DeleteSnapshotsOptionType string
const (
	DeleteSnapshotsOptionTypeInclude       DeleteSnapshotsOptionType = "include"
	DeleteSnapshotsOptionTypeIncludeLeased DeleteSnapshotsOptionType = "include-leased"
)

func PossibleDeleteSnapshotsOptionTypeValues 

func PossibleDeleteSnapshotsOptionTypeValues() []DeleteSnapshotsOptionType

PossibleDeleteSnapshotsOptionTypeValues returns the possible values for the DeleteSnapshotsOptionType const type.

type DestinationLeaseAccessConditions added in v1.1.0 

type DestinationLeaseAccessConditions struct {
	// Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease
	// ID of the destination file. If the request does not include the lease ID or
	// it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination
	// file does not currently have an active lease, the operation will also
	// fail with status code 412 (Precondition Failed).
	DestinationLeaseID *string
}

DestinationLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.

type Directory 

type Directory struct {
	// REQUIRED
	Name          *string `xml:"Name"`
	Attributes    *string `xml:"Attributes"`
	ID            *string `xml:"FileId"`
	PermissionKey *string `xml:"PermissionKey"`

	// File properties.
	Properties *FileProperty `xml:"Properties"`
}

Directory - A listed directory item.

func (*Directory) UnmarshalXML added in v1.1.0 

func (d *Directory) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type Directory.

type DirectoryClient 

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

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

func NewDirectoryClient 

func NewDirectoryClient(endpoint string, allowTrailingDot *bool, fileRequestIntent *ShareTokenIntent, allowSourceTrailingDot *bool, azClient *azcore.Client) *DirectoryClient

NewDirectoryClient creates a new instance of DirectoryClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • allowTrailingDot - If true, the trailing dot will not be trimmed from the target URI.
  • fileRequestIntent - Valid value is backup
  • allowSourceTrailingDot - If true, the trailing dot will not be trimmed from the source URI.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*DirectoryClient) Create 

func (client *DirectoryClient) Create(ctx context.Context, options *DirectoryClientCreateOptions) (DirectoryClientCreateResponse, error)

Create - Creates a new directory under the specified share or parent directory. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - DirectoryClientCreateOptions contains the optional parameters for the DirectoryClient.Create method.

func (*DirectoryClient) Delete 

func (client *DirectoryClient) Delete(ctx context.Context, options *DirectoryClientDeleteOptions) (DirectoryClientDeleteResponse, error)

Delete - Removes the specified empty directory. Note that the directory must be empty before it can be deleted. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - DirectoryClientDeleteOptions contains the optional parameters for the DirectoryClient.Delete method.

func (*DirectoryClient) Endpoint 

func (client *DirectoryClient) Endpoint() string

func (*DirectoryClient) ForceCloseHandles 

func (client *DirectoryClient) ForceCloseHandles(ctx context.Context, handleID string, options *DirectoryClientForceCloseHandlesOptions) (DirectoryClientForceCloseHandlesResponse, error)

ForceCloseHandles - Closes all handles open for given directory. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • handleID - Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.
  • options - DirectoryClientForceCloseHandlesOptions contains the optional parameters for the DirectoryClient.ForceCloseHandles method.

func (*DirectoryClient) GetProperties 

func (client *DirectoryClient) GetProperties(ctx context.Context, options *DirectoryClientGetPropertiesOptions) (DirectoryClientGetPropertiesResponse, error)

GetProperties - Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - DirectoryClientGetPropertiesOptions contains the optional parameters for the DirectoryClient.GetProperties method.

func (*DirectoryClient) InternalClient added in v1.1.0 

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

func (*DirectoryClient) ListFilesAndDirectoriesSegmentCreateRequest 

func (client *DirectoryClient) ListFilesAndDirectoriesSegmentCreateRequest(ctx context.Context, options *DirectoryClientListFilesAndDirectoriesSegmentOptions) (*policy.Request, error)

NewListFilesAndDirectoriesSegmentPager - Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.

Generated from API version 2024-11-04

  • options - DirectoryClientListFilesAndDirectoriesSegmentOptions contains the optional parameters for the DirectoryClient.NewListFilesAndDirectoriesSegmentPager method.

listFilesAndDirectoriesSegmentCreateRequest creates the ListFilesAndDirectoriesSegment request.

func (*DirectoryClient) ListFilesAndDirectoriesSegmentHandleResponse 

func (client *DirectoryClient) ListFilesAndDirectoriesSegmentHandleResponse(resp *http.Response) (DirectoryClientListFilesAndDirectoriesSegmentResponse, error)

listFilesAndDirectoriesSegmentHandleResponse handles the ListFilesAndDirectoriesSegment response.

func (*DirectoryClient) ListHandles 

func (client *DirectoryClient) ListHandles(ctx context.Context, options *DirectoryClientListHandlesOptions) (DirectoryClientListHandlesResponse, error)

ListHandles - Lists handles for directory. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - DirectoryClientListHandlesOptions contains the optional parameters for the DirectoryClient.ListHandles method.

func (*DirectoryClient) Rename added in v1.1.0 

func (client *DirectoryClient) Rename(ctx context.Context, renameSource string, options *DirectoryClientRenameOptions, sourceLeaseAccessConditions *SourceLeaseAccessConditions, destinationLeaseAccessConditions *DestinationLeaseAccessConditions, copyFileSMBInfo *CopyFileSMBInfo) (DirectoryClientRenameResponse, error)

Rename - Renames a directory If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • renameSource - Required. Specifies the URI-style path of the source file, up to 2 KB in length.
  • options - DirectoryClientRenameOptions contains the optional parameters for the DirectoryClient.Rename method.
  • SourceLeaseAccessConditions - SourceLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.
  • DestinationLeaseAccessConditions - DestinationLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.
  • CopyFileSMBInfo - CopyFileSMBInfo contains a group of parameters for the DirectoryClient.Rename method.

func (*DirectoryClient) SetMetadata 

func (client *DirectoryClient) SetMetadata(ctx context.Context, options *DirectoryClientSetMetadataOptions) (DirectoryClientSetMetadataResponse, error)

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

Generated from API version 2024-11-04

  • options - DirectoryClientSetMetadataOptions contains the optional parameters for the DirectoryClient.SetMetadata method.

func (*DirectoryClient) SetProperties 

func (client *DirectoryClient) SetProperties(ctx context.Context, options *DirectoryClientSetPropertiesOptions) (DirectoryClientSetPropertiesResponse, error)

SetProperties - Sets properties on the directory. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - DirectoryClientSetPropertiesOptions contains the optional parameters for the DirectoryClient.SetProperties method.

type DirectoryClientCreateOptions 

type DirectoryClientCreateOptions struct {
	// If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory.
	// ‘None’ can also be specified as default.
	FileAttributes *string

	// Change time for the file/directory. Default value: Now.
	FileChangeTime *string

	// Creation time for the file/directory. Default value: Now.
	FileCreationTime *string

	// Last write time for the file/directory. Default value: Now.
	FileLastWriteTime *string

	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientCreateOptions contains the optional parameters for the DirectoryClient.Create method.

type DirectoryClientCreateResponse 

type DirectoryClientCreateResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientCreateResponse contains the response from method DirectoryClient.Create.

type DirectoryClientDeleteOptions 

type DirectoryClientDeleteOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientDeleteOptions contains the optional parameters for the DirectoryClient.Delete method.

type DirectoryClientDeleteResponse 

type DirectoryClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientDeleteResponse contains the response from method DirectoryClient.Delete.

type DirectoryClientForceCloseHandlesOptions 

type DirectoryClientForceCloseHandlesOptions struct {
	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.
	Recursive *bool

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientForceCloseHandlesOptions contains the optional parameters for the DirectoryClient.ForceCloseHandles method.

type DirectoryClientForceCloseHandlesResponse 

type DirectoryClientForceCloseHandlesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// Marker contains the information returned from the x-ms-marker header response.
	Marker *string

	// NumberOfHandlesClosed contains the information returned from the x-ms-number-of-handles-closed header response.
	NumberOfHandlesClosed *int32

	// NumberOfHandlesFailedToClose contains the information returned from the x-ms-number-of-handles-failed header response.
	NumberOfHandlesFailedToClose *int32

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientForceCloseHandlesResponse contains the response from method DirectoryClient.ForceCloseHandles.

type DirectoryClientGetPropertiesOptions 

type DirectoryClientGetPropertiesOptions struct {
	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientGetPropertiesOptions contains the optional parameters for the DirectoryClient.GetProperties method.

type DirectoryClientGetPropertiesResponse 

type DirectoryClientGetPropertiesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientGetPropertiesResponse contains the response from method DirectoryClient.GetProperties.

type DirectoryClientListFilesAndDirectoriesSegmentOptions 

type DirectoryClientListFilesAndDirectoriesSegmentOptions struct {
	// Include this parameter to specify one or more datasets to include in the response.
	Include []ListFilesIncludeType

	// Include extended information.
	IncludeExtendedInfo *bool

	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater
	// than 5,000, the server will return up to 5,000 items.
	Maxresults *int32

	// Filters the results to return only entries whose name begins with the specified prefix.
	Prefix *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientListFilesAndDirectoriesSegmentOptions contains the optional parameters for the DirectoryClient.NewListFilesAndDirectoriesSegmentPager method.

type DirectoryClientListFilesAndDirectoriesSegmentResponse 

type DirectoryClientListFilesAndDirectoriesSegmentResponse struct {
	// An enumeration of directories and files.
	ListFilesAndDirectoriesSegmentResponse

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientListFilesAndDirectoriesSegmentResponse contains the response from method DirectoryClient.NewListFilesAndDirectoriesSegmentPager.

type DirectoryClientListHandlesOptions 

type DirectoryClientListHandlesOptions struct {
	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater
	// than 5,000, the server will return up to 5,000 items.
	Maxresults *int32

	// Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.
	Recursive *bool

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientListHandlesOptions contains the optional parameters for the DirectoryClient.ListHandles method.

type DirectoryClientListHandlesResponse 

type DirectoryClientListHandlesResponse struct {
	// An enumeration of handles.
	ListHandlesResponse

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientListHandlesResponse contains the response from method DirectoryClient.ListHandles.

type DirectoryClientRenameOptions added in v1.1.0 

type DirectoryClientRenameOptions struct {
	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected.
	// If true, the rename will succeed, otherwise, a previous file at the
	// destination with the ReadOnly attribute set will cause the rename to fail.
	IgnoreReadOnly *bool

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not.
	// If true, the rename will succeed and will overwrite the destination file. If
	// not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided
	// and the destination file doesn’t exist, the rename will succeed. Note:
	// This value does not override the x-ms-file-copy-ignore-read-only header value.
	ReplaceIfExists *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientRenameOptions contains the optional parameters for the DirectoryClient.Rename method.

type DirectoryClientRenameResponse added in v1.1.0 

type DirectoryClientRenameResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientRenameResponse contains the response from method DirectoryClient.Rename.

type DirectoryClientSetMetadataOptions 

type DirectoryClientSetMetadataOptions struct {
	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientSetMetadataOptions contains the optional parameters for the DirectoryClient.SetMetadata method.

type DirectoryClientSetMetadataResponse 

type DirectoryClientSetMetadataResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientSetMetadataResponse contains the response from method DirectoryClient.SetMetadata.

type DirectoryClientSetPropertiesOptions 

type DirectoryClientSetPropertiesOptions struct {
	// If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory.
	// ‘None’ can also be specified as default.
	FileAttributes *string

	// Change time for the file/directory. Default value: Now.
	FileChangeTime *string

	// Creation time for the file/directory. Default value: Now.
	FileCreationTime *string

	// Last write time for the file/directory. Default value: Now.
	FileLastWriteTime *string

	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

DirectoryClientSetPropertiesOptions contains the optional parameters for the DirectoryClient.SetProperties method.

type DirectoryClientSetPropertiesResponse 

type DirectoryClientSetPropertiesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

DirectoryClientSetPropertiesResponse contains the response from method DirectoryClient.SetProperties.

type File 

type File struct {
	// REQUIRED
	Name *string `xml:"Name"`

	// REQUIRED; File properties.
	Properties    *FileProperty `xml:"Properties"`
	Attributes    *string       `xml:"Attributes"`
	ID            *string       `xml:"FileId"`
	PermissionKey *string       `xml:"PermissionKey"`
}

File - A listed file item.

func (*File) UnmarshalXML added in v1.1.0 

func (f *File) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type File.

type FileClient 

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

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

func NewFileClient 

func NewFileClient(endpoint string, allowTrailingDot *bool, fileRequestIntent *ShareTokenIntent, allowSourceTrailingDot *bool, azClient *azcore.Client) *FileClient

NewFileClient creates a new instance of FileClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • allowTrailingDot - If true, the trailing dot will not be trimmed from the target URI.
  • fileRequestIntent - Valid value is backup
  • allowSourceTrailingDot - If true, the trailing dot will not be trimmed from the source URI.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*FileClient) AbortCopy 

func (client *FileClient) AbortCopy(ctx context.Context, copyID string, options *FileClientAbortCopyOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientAbortCopyResponse, error)

AbortCopy - Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • copyID - The copy identifier provided in the x-ms-copy-id header of the original Copy File operation.
  • options - FileClientAbortCopyOptions contains the optional parameters for the FileClient.AbortCopy method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) AcquireLease 

func (client *FileClient) AcquireLease(ctx context.Context, duration int32, options *FileClientAcquireLeaseOptions) (FileClientAcquireLeaseResponse, error)

AcquireLease - [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • 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. A lease duration cannot be changed using renew or change.
  • options - FileClientAcquireLeaseOptions contains the optional parameters for the FileClient.AcquireLease method.

func (*FileClient) BreakLease 

func (client *FileClient) BreakLease(ctx context.Context, options *FileClientBreakLeaseOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientBreakLeaseResponse, error)

BreakLease - [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientBreakLeaseOptions contains the optional parameters for the FileClient.BreakLease method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) ChangeLease 

func (client *FileClient) ChangeLease(ctx context.Context, leaseID string, options *FileClientChangeLeaseOptions) (FileClientChangeLeaseResponse, error)

ChangeLease - [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • leaseID - Specifies the current lease ID on the resource.
  • options - FileClientChangeLeaseOptions contains the optional parameters for the FileClient.ChangeLease method.

func (*FileClient) Create 

func (client *FileClient) Create(ctx context.Context, fileContentLength int64, options *FileClientCreateOptions, shareFileHTTPHeaders *ShareFileHTTPHeaders, leaseAccessConditions *LeaseAccessConditions) (FileClientCreateResponse, error)

Create - Creates a new file or replaces a file. Note it only initializes the file with no content. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • fileContentLength - Specifies the maximum size for the file, up to 4 TB.
  • options - FileClientCreateOptions contains the optional parameters for the FileClient.Create method.
  • ShareFileHTTPHeaders - ShareFileHTTPHeaders contains a group of parameters for the FileClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) Delete 

func (client *FileClient) Delete(ctx context.Context, options *FileClientDeleteOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientDeleteResponse, error)

Delete - removes the file from the storage account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientDeleteOptions contains the optional parameters for the FileClient.Delete method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) Download 

func (client *FileClient) Download(ctx context.Context, options *FileClientDownloadOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientDownloadResponse, error)

Download - Reads or downloads a file from the system, including its metadata and properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientDownloadOptions contains the optional parameters for the FileClient.Download method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) Endpoint 

func (client *FileClient) Endpoint() string

func (*FileClient) ForceCloseHandles 

func (client *FileClient) ForceCloseHandles(ctx context.Context, handleID string, options *FileClientForceCloseHandlesOptions) (FileClientForceCloseHandlesResponse, error)

ForceCloseHandles - Closes all handles open for given file If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • handleID - Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.
  • options - FileClientForceCloseHandlesOptions contains the optional parameters for the FileClient.ForceCloseHandles method.

func (*FileClient) GetProperties 

func (client *FileClient) GetProperties(ctx context.Context, options *FileClientGetPropertiesOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientGetPropertiesResponse, error)

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

Generated from API version 2024-11-04

  • options - FileClientGetPropertiesOptions contains the optional parameters for the FileClient.GetProperties method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) GetRangeList 

func (client *FileClient) GetRangeList(ctx context.Context, options *FileClientGetRangeListOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientGetRangeListResponse, error)

GetRangeList - Returns the list of valid ranges for a file. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientGetRangeListOptions contains the optional parameters for the FileClient.GetRangeList method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) InternalClient added in v1.1.0 

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

func (*FileClient) ListHandles 

func (client *FileClient) ListHandles(ctx context.Context, options *FileClientListHandlesOptions) (FileClientListHandlesResponse, error)

ListHandles - Lists handles for file If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientListHandlesOptions contains the optional parameters for the FileClient.ListHandles method.

func (*FileClient) ReleaseLease 

func (client *FileClient) ReleaseLease(ctx context.Context, leaseID string, options *FileClientReleaseLeaseOptions) (FileClientReleaseLeaseResponse, error)

ReleaseLease - [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • leaseID - Specifies the current lease ID on the resource.
  • options - FileClientReleaseLeaseOptions contains the optional parameters for the FileClient.ReleaseLease method.

func (*FileClient) Rename added in v1.1.0 

func (client *FileClient) Rename(ctx context.Context, renameSource string, options *FileClientRenameOptions, sourceLeaseAccessConditions *SourceLeaseAccessConditions, destinationLeaseAccessConditions *DestinationLeaseAccessConditions, copyFileSMBInfo *CopyFileSMBInfo, shareFileHTTPHeaders *ShareFileHTTPHeaders) (FileClientRenameResponse, error)

Rename - Renames a file If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • renameSource - Required. Specifies the URI-style path of the source file, up to 2 KB in length.
  • options - FileClientRenameOptions contains the optional parameters for the FileClient.Rename method.
  • SourceLeaseAccessConditions - SourceLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.
  • DestinationLeaseAccessConditions - DestinationLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.
  • CopyFileSMBInfo - CopyFileSMBInfo contains a group of parameters for the DirectoryClient.Rename method.
  • ShareFileHTTPHeaders - ShareFileHTTPHeaders contains a group of parameters for the FileClient.Create method.

func (*FileClient) SetHTTPHeaders 

func (client *FileClient) SetHTTPHeaders(ctx context.Context, options *FileClientSetHTTPHeadersOptions, shareFileHTTPHeaders *ShareFileHTTPHeaders, leaseAccessConditions *LeaseAccessConditions) (FileClientSetHTTPHeadersResponse, error)

SetHTTPHeaders - Sets HTTP headers on the file. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - FileClientSetHTTPHeadersOptions contains the optional parameters for the FileClient.SetHTTPHeaders method.
  • ShareFileHTTPHeaders - ShareFileHTTPHeaders contains a group of parameters for the FileClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) SetMetadata 

func (client *FileClient) SetMetadata(ctx context.Context, options *FileClientSetMetadataOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientSetMetadataResponse, error)

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

Generated from API version 2024-11-04

  • options - FileClientSetMetadataOptions contains the optional parameters for the FileClient.SetMetadata method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) StartCopy 

func (client *FileClient) StartCopy(ctx context.Context, copySource string, options *FileClientStartCopyOptions, copyFileSMBInfo *CopyFileSMBInfo, leaseAccessConditions *LeaseAccessConditions) (FileClientStartCopyResponse, error)

StartCopy - Copies a blob or file to a destination file within the storage account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • copySource - Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source.
  • options - FileClientStartCopyOptions contains the optional parameters for the FileClient.StartCopy method.
  • CopyFileSMBInfo - CopyFileSMBInfo contains a group of parameters for the DirectoryClient.Rename method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) UploadRange 

func (client *FileClient) UploadRange(ctx context.Context, rangeParam string, fileRangeWrite FileRangeWriteType, contentLength int64, optionalbody io.ReadSeekCloser, options *FileClientUploadRangeOptions, leaseAccessConditions *LeaseAccessConditions) (FileClientUploadRangeResponse, error)

UploadRange - Upload a range of bytes to a file. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • rangeParam - Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.
  • fileRangeWrite - Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.
  • contentLength - Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.
  • optionalbody - Initial data.
  • options - FileClientUploadRangeOptions contains the optional parameters for the FileClient.UploadRange method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*FileClient) UploadRangeFromURL 

func (client *FileClient) UploadRangeFromURL(ctx context.Context, rangeParam string, copySource string, contentLength int64, options *FileClientUploadRangeFromURLOptions, sourceModifiedAccessConditions *SourceModifiedAccessConditions, leaseAccessConditions *LeaseAccessConditions) (FileClientUploadRangeFromURLResponse, error)

UploadRangeFromURL - Upload a range of bytes to a file where the contents are read from a URL. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • rangeParam - Writes data to the specified byte range in the file.
  • copySource - Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source.
  • contentLength - Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.
  • options - FileClientUploadRangeFromURLOptions contains the optional parameters for the FileClient.UploadRangeFromURL method.
  • SourceModifiedAccessConditions - SourceModifiedAccessConditions contains a group of parameters for the FileClient.UploadRangeFromURL method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

type FileClientAbortCopyOptions 

type FileClientAbortCopyOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientAbortCopyOptions contains the optional parameters for the FileClient.AbortCopy method.

type FileClientAbortCopyResponse 

type FileClientAbortCopyResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientAbortCopyResponse contains the response from method FileClient.AbortCopy.

type FileClientAcquireLeaseOptions 

type FileClientAcquireLeaseOptions struct {
	// Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientAcquireLeaseOptions contains the optional parameters for the FileClient.AcquireLease method.

type FileClientAcquireLeaseResponse 

type FileClientAcquireLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientAcquireLeaseResponse contains the response from method FileClient.AcquireLease.

type FileClientBreakLeaseOptions 

type FileClientBreakLeaseOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientBreakLeaseOptions contains the optional parameters for the FileClient.BreakLease method.

type FileClientBreakLeaseResponse 

type FileClientBreakLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientBreakLeaseResponse contains the response from method FileClient.BreakLease.

type FileClientChangeLeaseOptions 

type FileClientChangeLeaseOptions struct {
	// Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientChangeLeaseOptions contains the optional parameters for the FileClient.ChangeLease method.

type FileClientChangeLeaseResponse 

type FileClientChangeLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientChangeLeaseResponse contains the response from method FileClient.ChangeLease.

type FileClientCreateOptions 

type FileClientCreateOptions struct {
	// If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory.
	// ‘None’ can also be specified as default.
	FileAttributes *string

	// Change time for the file/directory. Default value: Now.
	FileChangeTime *string

	// Creation time for the file/directory. Default value: Now.
	FileCreationTime *string

	// Last write time for the file/directory. Default value: Now.
	FileLastWriteTime *string

	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientCreateOptions contains the optional parameters for the FileClient.Create method.

type FileClientCreateResponse 

type FileClientCreateResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientCreateResponse contains the response from method FileClient.Create.

type FileClientDeleteOptions 

type FileClientDeleteOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientDeleteOptions contains the optional parameters for the FileClient.Delete method.

type FileClientDeleteResponse 

type FileClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientDeleteResponse contains the response from method FileClient.Delete.

type FileClientDownloadOptions 

type FileClientDownloadOptions struct {
	// Return file data only from the specified byte range.
	Range *string

	// When this header is 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 MB in size.
	RangeGetContentMD5 *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientDownloadOptions contains the optional parameters for the FileClient.Download method.

type FileClientDownloadResponse 

type FileClientDownloadResponse struct {
	// AcceptRanges contains the information returned from the Accept-Ranges header response.
	AcceptRanges *string

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

	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// ContentRange contains the information returned from the Content-Range header response.
	ContentRange *string

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// CopyCompletionTime contains the information returned from the x-ms-copy-completion-time header response.
	CopyCompletionTime *time.Time

	// CopyID contains the information returned from the x-ms-copy-id header response.
	CopyID *string

	// CopyProgress contains the information returned from the x-ms-copy-progress header response.
	CopyProgress *string

	// CopySource contains the information returned from the x-ms-copy-source header response.
	CopySource *string

	// CopyStatus contains the information returned from the x-ms-copy-status header response.
	CopyStatus *CopyStatusType

	// CopyStatusDescription contains the information returned from the x-ms-copy-status-description header response.
	CopyStatusDescription *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileContentMD5 contains the information returned from the x-ms-content-md5 header response.
	FileContentMD5 []byte

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *LeaseDurationType

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *LeaseStateType

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *LeaseStatusType

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientDownloadResponse contains the response from method FileClient.Download.

type FileClientForceCloseHandlesOptions 

type FileClientForceCloseHandlesOptions struct {
	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientForceCloseHandlesOptions contains the optional parameters for the FileClient.ForceCloseHandles method.

type FileClientForceCloseHandlesResponse 

type FileClientForceCloseHandlesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// Marker contains the information returned from the x-ms-marker header response.
	Marker *string

	// NumberOfHandlesClosed contains the information returned from the x-ms-number-of-handles-closed header response.
	NumberOfHandlesClosed *int32

	// NumberOfHandlesFailedToClose contains the information returned from the x-ms-number-of-handles-failed header response.
	NumberOfHandlesFailedToClose *int32

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientForceCloseHandlesResponse contains the response from method FileClient.ForceCloseHandles.

type FileClientGetPropertiesOptions 

type FileClientGetPropertiesOptions struct {
	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientGetPropertiesOptions contains the optional parameters for the FileClient.GetProperties method.

type FileClientGetPropertiesResponse 

type FileClientGetPropertiesResponse struct {
	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// CopyCompletionTime contains the information returned from the x-ms-copy-completion-time header response.
	CopyCompletionTime *time.Time

	// CopyID contains the information returned from the x-ms-copy-id header response.
	CopyID *string

	// CopyProgress contains the information returned from the x-ms-copy-progress header response.
	CopyProgress *string

	// CopySource contains the information returned from the x-ms-copy-source header response.
	CopySource *string

	// CopyStatus contains the information returned from the x-ms-copy-status header response.
	CopyStatus *CopyStatusType

	// CopyStatusDescription contains the information returned from the x-ms-copy-status-description header response.
	CopyStatusDescription *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// FileType contains the information returned from the x-ms-type header response.
	FileType *string

	// IsServerEncrypted contains the information returned from the x-ms-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *LeaseDurationType

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *LeaseStateType

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *LeaseStatusType

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientGetPropertiesResponse contains the response from method FileClient.GetProperties.

type FileClientGetRangeListOptions 

type FileClientGetRangeListOptions struct {
	// The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.
	Prevsharesnapshot *string

	// Specifies the range of bytes over which to list ranges, inclusively.
	Range *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a
	// file that has been renamed or moved between the target snapshot (or the live
	// file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned.
	// If the value is false, the operation will result in a failure with 409
	// (Conflict) response. The default value is false.
	SupportRename *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientGetRangeListOptions contains the optional parameters for the FileClient.GetRangeList method.

type FileClientGetRangeListResponse 

type FileClientGetRangeListResponse struct {
	// The list of file ranges
	ShareFileRangeList

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileContentLength contains the information returned from the x-ms-content-length header response.
	FileContentLength *int64

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientGetRangeListResponse contains the response from method FileClient.GetRangeList.

type FileClientListHandlesOptions 

type FileClientListHandlesOptions struct {
	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater
	// than 5,000, the server will return up to 5,000 items.
	Maxresults *int32

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientListHandlesOptions contains the optional parameters for the FileClient.ListHandles method.

type FileClientListHandlesResponse 

type FileClientListHandlesResponse struct {
	// An enumeration of handles.
	ListHandlesResponse

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientListHandlesResponse contains the response from method FileClient.ListHandles.

type FileClientReleaseLeaseOptions 

type FileClientReleaseLeaseOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientReleaseLeaseOptions contains the optional parameters for the FileClient.ReleaseLease method.

type FileClientReleaseLeaseResponse 

type FileClientReleaseLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientReleaseLeaseResponse contains the response from method FileClient.ReleaseLease.

type FileClientRenameOptions added in v1.1.0 

type FileClientRenameOptions struct {
	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected.
	// If true, the rename will succeed, otherwise, a previous file at the
	// destination with the ReadOnly attribute set will cause the rename to fail.
	IgnoreReadOnly *bool

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not.
	// If true, the rename will succeed and will overwrite the destination file. If
	// not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided
	// and the destination file doesn’t exist, the rename will succeed. Note:
	// This value does not override the x-ms-file-copy-ignore-read-only header value.
	ReplaceIfExists *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientRenameOptions contains the optional parameters for the FileClient.Rename method.

type FileClientRenameResponse added in v1.1.0 

type FileClientRenameResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientRenameResponse contains the response from method FileClient.Rename.

type FileClientSetHTTPHeadersOptions 

type FileClientSetHTTPHeadersOptions struct {
	// If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory.
	// ‘None’ can also be specified as default.
	FileAttributes *string

	// Change time for the file/directory. Default value: Now.
	FileChangeTime *string

	// Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges
	// above the specified byte value are cleared.
	FileContentLength *int64

	// Creation time for the file/directory. Default value: Now.
	FileCreationTime *string

	// Last write time for the file/directory. Default value: Now.
	FileLastWriteTime *string

	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientSetHTTPHeadersOptions contains the optional parameters for the FileClient.SetHTTPHeaders method.

type FileClientSetHTTPHeadersResponse 

type FileClientSetHTTPHeadersResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileAttributes contains the information returned from the x-ms-file-attributes header response.
	FileAttributes *string

	// FileChangeTime contains the information returned from the x-ms-file-change-time header response.
	FileChangeTime *time.Time

	// FileCreationTime contains the information returned from the x-ms-file-creation-time header response.
	FileCreationTime *time.Time

	// ID contains the information returned from the x-ms-file-id header response.
	ID *string

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// ParentID contains the information returned from the x-ms-file-parent-id header response.
	ParentID *string

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientSetHTTPHeadersResponse contains the response from method FileClient.SetHTTPHeaders.

type FileClientSetMetadataOptions 

type FileClientSetMetadataOptions struct {
	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientSetMetadataOptions contains the optional parameters for the FileClient.SetMetadata method.

type FileClientSetMetadataResponse 

type FileClientSetMetadataResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientSetMetadataResponse contains the response from method FileClient.SetMetadata.

type FileClientStartCopyOptions 

type FileClientStartCopyOptions struct {
	// If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission
	// size is <= 8KB, else x-ms-file-permission-key header shall be used. Default
	// value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission
	// or x-ms-file-permission-key should be specified.
	FilePermission *string

	// Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key
	// should be specified.
	FilePermissionKey *string

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientStartCopyOptions contains the optional parameters for the FileClient.StartCopy method.

type FileClientStartCopyResponse 

type FileClientStartCopyResponse struct {
	// CopyID contains the information returned from the x-ms-copy-id header response.
	CopyID *string

	// CopyStatus contains the information returned from the x-ms-copy-status header response.
	CopyStatus *CopyStatusType

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientStartCopyResponse contains the response from method FileClient.StartCopy.

type FileClientUploadRangeFromURLOptions 

type FileClientUploadRangeFromURLOptions struct {
	// Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
	CopySourceAuthorization *string

	// If the file last write time should be preserved or overwritten
	FileLastWrittenMode *FileLastWrittenMode

	// Specify the crc64 calculated for the range of bytes that must be read from the copy source.
	SourceContentCRC64 []byte

	// Bytes of source data in the specified range.
	SourceRange *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientUploadRangeFromURLOptions contains the optional parameters for the FileClient.UploadRangeFromURL method.

func (*FileClientUploadRangeFromURLOptions) SetSourceContentCRC64 

func (f *FileClientUploadRangeFromURLOptions) SetSourceContentCRC64(v []byte)

type FileClientUploadRangeFromURLResponse 

type FileClientUploadRangeFromURLResponse struct {
	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string

	// XMSContentCRC64 contains the information returned from the x-ms-content-crc64 header response.
	XMSContentCRC64 []byte
}

FileClientUploadRangeFromURLResponse contains the response from method FileClient.UploadRangeFromURL.

type FileClientUploadRangeOptions 

type FileClientUploadRangeOptions struct {
	// An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5
	// header is specified, the File service compares the hash of the content that has
	// arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400
	// (Bad Request).
	ContentMD5 []byte

	// If the file last write time should be preserved or overwritten
	FileLastWrittenMode *FileLastWrittenMode

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

FileClientUploadRangeOptions contains the optional parameters for the FileClient.UploadRange method.

func (*FileClientUploadRangeOptions) SetMD5 

func (f *FileClientUploadRangeOptions) SetMD5(v []byte)

type FileClientUploadRangeResponse 

type FileClientUploadRangeResponse struct {
	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// FileLastWriteTime contains the information returned from the x-ms-file-last-write-time header response.
	FileLastWriteTime *time.Time

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileClientUploadRangeResponse contains the response from method FileClient.UploadRange.

type FileLastWrittenMode added in v1.1.0 

type FileLastWrittenMode string
const (
	FileLastWrittenModeNow      FileLastWrittenMode = "Now"
	FileLastWrittenModePreserve FileLastWrittenMode = "Preserve"
)

func PossibleFileLastWrittenModeValues added in v1.1.0 

func PossibleFileLastWrittenModeValues() []FileLastWrittenMode

PossibleFileLastWrittenModeValues returns the possible values for the FileLastWrittenMode const type.

type FilePermissionFormat added in v1.4.0 

type FilePermissionFormat string
const (
	FilePermissionFormatBinary FilePermissionFormat = "Binary"
	FilePermissionFormatSddl   FilePermissionFormat = "Sddl"
)

func PossibleFilePermissionFormatValues added in v1.4.0 

func PossibleFilePermissionFormatValues() []FilePermissionFormat

PossibleFilePermissionFormatValues returns the possible values for the FilePermissionFormat const type.

type FileProperty 

type FileProperty struct {
	// REQUIRED; Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally.
	// The value of Content-Length may not reflect that fact until the handle is closed or
	// the op-lock is broken. To retrieve current property values, call Get File Properties.
	ContentLength  *int64       `xml:"Content-Length"`
	ChangeTime     *time.Time   `xml:"ChangeTime"`
	CreationTime   *time.Time   `xml:"CreationTime"`
	ETag           *azcore.ETag `xml:"Etag"`
	LastAccessTime *time.Time   `xml:"LastAccessTime"`
	LastModified   *time.Time   `xml:"Last-Modified"`
	LastWriteTime  *time.Time   `xml:"LastWriteTime"`
}

FileProperty - File properties.

func (FileProperty) MarshalXML 

func (f FileProperty) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type FileProperty.

func (*FileProperty) UnmarshalXML 

func (f *FileProperty) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type FileProperty.

type FileRange 

type FileRange struct {
	// REQUIRED; End of the range.
	End *int64 `xml:"End"`

	// REQUIRED; Start of the range.
	Start *int64 `xml:"Start"`
}

FileRange - An Azure Storage file range.

type FileRangeWriteType 

type FileRangeWriteType string
const (
	FileRangeWriteTypeClear  FileRangeWriteType = "clear"
	FileRangeWriteTypeUpdate FileRangeWriteType = "update"
)

func PossibleFileRangeWriteTypeValues 

func PossibleFileRangeWriteTypeValues() []FileRangeWriteType

PossibleFileRangeWriteTypeValues returns the possible values for the FileRangeWriteType const type.

type FilesAndDirectoriesListSegment 

type FilesAndDirectoriesListSegment struct {
	// REQUIRED
	Directories []*Directory `xml:"Directory"`

	// REQUIRED
	Files []*File `xml:"File"`
}

FilesAndDirectoriesListSegment - Abstract for entries that can be listed from Directory.

func (FilesAndDirectoriesListSegment) MarshalXML 

func (f FilesAndDirectoriesListSegment) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type FilesAndDirectoriesListSegment.

type Handle 

type Handle struct {
	// REQUIRED; Client IP that opened the handle
	ClientIP *string `xml:"ClientIp"`

	// REQUIRED; Name of the client machine where the share is being mounted
	ClientName *string `xml:"ClientName"`

	// REQUIRED; FileId uniquely identifies the file or directory.
	FileID *string `xml:"FileId"`

	// REQUIRED; XSMB service handle ID
	ID *string `xml:"HandleId"`

	// REQUIRED; Time when the session that previously opened the handle has last been reconnected. (UTC)
	OpenTime *time.Time `xml:"OpenTime"`

	// REQUIRED
	Path *string `xml:"Path"`

	// REQUIRED; SMB session ID in context of which the file handle was opened
	SessionID       *string        `xml:"SessionId"`
	AccessRightList []*AccessRight `xml:"AccessRightList>AccessRight"`

	// Time handle was last connected to (UTC)
	LastReconnectTime *time.Time `xml:"LastReconnectTime"`

	// ParentId uniquely identifies the parent directory of the object.
	ParentID *string `xml:"ParentId"`
}

Handle - A listed Azure Storage handle item.

func (Handle) MarshalXML 

func (h Handle) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type Handle.

func (*Handle) UnmarshalXML 

func (h *Handle) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type Handle.

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 ShareClient.GetProperties method.

type LeaseDurationType 

type LeaseDurationType string

LeaseDurationType - When a share is leased, specifies whether the lease is of infinite or fixed duration. 

const (
	LeaseDurationTypeFixed    LeaseDurationType = "fixed"
	LeaseDurationTypeInfinite LeaseDurationType = "infinite"
)

func PossibleLeaseDurationTypeValues 

func PossibleLeaseDurationTypeValues() []LeaseDurationType

PossibleLeaseDurationTypeValues returns the possible values for the LeaseDurationType const type.

type LeaseStateType 

type LeaseStateType string

LeaseStateType - Lease state of the share. 

const (
	LeaseStateTypeAvailable LeaseStateType = "available"
	LeaseStateTypeBreaking  LeaseStateType = "breaking"
	LeaseStateTypeBroken    LeaseStateType = "broken"
	LeaseStateTypeExpired   LeaseStateType = "expired"
	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 current lease status of the share. 

const (
	LeaseStatusTypeLocked   LeaseStatusType = "locked"
	LeaseStatusTypeUnlocked LeaseStatusType = "unlocked"
)

func PossibleLeaseStatusTypeValues 

func PossibleLeaseStatusTypeValues() []LeaseStatusType

PossibleLeaseStatusTypeValues returns the possible values for the LeaseStatusType const type.

type ListFilesAndDirectoriesSegmentResponse 

type ListFilesAndDirectoriesSegmentResponse struct {
	// REQUIRED
	DirectoryPath *string `xml:"DirectoryPath,attr"`

	// REQUIRED
	NextMarker *string `xml:"NextMarker"`

	// REQUIRED
	Prefix *string `xml:"Prefix"`

	// REQUIRED; Abstract for entries that can be listed from Directory.
	Segment *FilesAndDirectoriesListSegment `xml:"Entries"`

	// REQUIRED
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`

	// REQUIRED
	ShareName     *string `xml:"ShareName,attr"`
	DirectoryID   *string `xml:"DirectoryId"`
	Encoded       *bool   `xml:"Encoded,attr"`
	Marker        *string `xml:"Marker"`
	MaxResults    *int32  `xml:"MaxResults"`
	ShareSnapshot *string `xml:"ShareSnapshot,attr"`
}

ListFilesAndDirectoriesSegmentResponse - An enumeration of directories and files.

func (*ListFilesAndDirectoriesSegmentResponse) UnmarshalXML added in v1.1.0 

func (l *ListFilesAndDirectoriesSegmentResponse) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type ListFilesAndDirectoriesSegmentResponse.

type ListFilesIncludeType 

type ListFilesIncludeType string
const (
	ListFilesIncludeTypeAttributes    ListFilesIncludeType = "Attributes"
	ListFilesIncludeTypeEtag          ListFilesIncludeType = "Etag"
	ListFilesIncludeTypePermissionKey ListFilesIncludeType = "PermissionKey"
	ListFilesIncludeTypeTimestamps    ListFilesIncludeType = "Timestamps"
)

func PossibleListFilesIncludeTypeValues 

func PossibleListFilesIncludeTypeValues() []ListFilesIncludeType

PossibleListFilesIncludeTypeValues returns the possible values for the ListFilesIncludeType const type.

type ListHandlesResponse 

type ListHandlesResponse struct {
	// REQUIRED
	NextMarker *string   `xml:"NextMarker"`
	Handles    []*Handle `xml:"Entries>Handle"`
}

ListHandlesResponse - An enumeration of handles.

func (ListHandlesResponse) MarshalXML 

func (l ListHandlesResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListHandlesResponse.

type ListSharesIncludeType 

type ListSharesIncludeType string
const (
	ListSharesIncludeTypeDeleted   ListSharesIncludeType = "deleted"
	ListSharesIncludeTypeMetadata  ListSharesIncludeType = "metadata"
	ListSharesIncludeTypeSnapshots ListSharesIncludeType = "snapshots"
)

func PossibleListSharesIncludeTypeValues 

func PossibleListSharesIncludeTypeValues() []ListSharesIncludeType

PossibleListSharesIncludeTypeValues returns the possible values for the ListSharesIncludeType const type.

type ListSharesResponse 

type ListSharesResponse struct {
	// REQUIRED
	NextMarker *string `xml:"NextMarker"`

	// REQUIRED
	ServiceEndpoint *string  `xml:"ServiceEndpoint,attr"`
	Marker          *string  `xml:"Marker"`
	MaxResults      *int32   `xml:"MaxResults"`
	Prefix          *string  `xml:"Prefix"`
	Shares          []*Share `xml:"Shares>Share"`
}

ListSharesResponse - An enumeration of shares.

func (ListSharesResponse) MarshalXML 

func (l ListSharesResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListSharesResponse.

type Metrics 

type Metrics struct {
	// REQUIRED; Indicates whether metrics are enabled for the File service.
	Enabled *bool `xml:"Enabled"`

	// REQUIRED; The version of Storage Analytics to configure.
	Version *string `xml:"Version"`

	// Indicates whether metrics should generate summary statistics for called API operations.
	IncludeAPIs *bool `xml:"IncludeAPIs"`

	// The retention policy.
	RetentionPolicy *RetentionPolicy `xml:"RetentionPolicy"`
}

Metrics - Storage Analytics metrics for file service.

type PermissionCopyModeType 

type PermissionCopyModeType string
const (
	PermissionCopyModeTypeOverride PermissionCopyModeType = "override"
	PermissionCopyModeTypeSource   PermissionCopyModeType = "source"
)

func PossiblePermissionCopyModeTypeValues 

func PossiblePermissionCopyModeTypeValues() []PermissionCopyModeType

PossiblePermissionCopyModeTypeValues returns the possible values for the PermissionCopyModeType const type.

type ProtocolSettings 

type ProtocolSettings struct {
	// Settings for SMB protocol.
	Smb *SMBSettings `xml:"SMB"`
}

ProtocolSettings - Protocol settings

type RetentionPolicy 

type RetentionPolicy struct {
	// REQUIRED; Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and
	// the user is responsible for deleting it.
	Enabled *bool `xml:"Enabled"`

	// Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics
	// data is deleted on a best-effort basis after the retention period expires.
	Days *int32 `xml:"Days"`
}

RetentionPolicy - The retention policy.

type SMBMultichannel 

type SMBMultichannel struct {
	// If SMB multichannel is enabled.
	Enabled *bool `xml:"Enabled"`
}

SMBMultichannel - Settings for SMB multichannel

type SMBSettings 

type SMBSettings struct {
	// Settings for SMB Multichannel.
	Multichannel *SMBMultichannel `xml:"Multichannel"`
}

SMBSettings - Settings for SMB protocol.

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.

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, share, directory or file 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) GetProperties 

func (client *ServiceClient) GetProperties(ctx context.Context, options *ServiceClientGetPropertiesOptions) (ServiceClientGetPropertiesResponse, error)

GetProperties - Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

func (*ServiceClient) InternalClient added in v1.1.0 

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

func (*ServiceClient) ListSharesSegmentCreateRequest 

func (client *ServiceClient) ListSharesSegmentCreateRequest(ctx context.Context, options *ServiceClientListSharesSegmentOptions) (*policy.Request, error)

NewListSharesSegmentPager - The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.

Generated from API version 2024-11-04

  • options - ServiceClientListSharesSegmentOptions contains the optional parameters for the ServiceClient.NewListSharesSegmentPager method.

listSharesSegmentCreateRequest creates the ListSharesSegment request.

func (*ServiceClient) ListSharesSegmentHandleResponse 

func (client *ServiceClient) ListSharesSegmentHandleResponse(resp *http.Response) (ServiceClientListSharesSegmentResponse, error)

listSharesSegmentHandleResponse handles the ListSharesSegment 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 File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • storageServiceProperties - The StorageService properties.
  • options - ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

type ServiceClientGetPropertiesOptions 

type ServiceClientGetPropertiesOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

type ServiceClientGetPropertiesResponse 

type ServiceClientGetPropertiesResponse struct {
	// Storage service properties.
	StorageServiceProperties

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ServiceClientGetPropertiesResponse contains the response from method ServiceClient.GetProperties.

type ServiceClientListSharesSegmentOptions 

type ServiceClientListSharesSegmentOptions struct {
	// Include this parameter to specify one or more datasets to include in the response.
	Include []ListSharesIncludeType

	// A string value that identifies the portion of the list to be returned with the next list operation. The operation returns
	// a marker value within the response body if the list returned was not complete.
	// The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque
	// to the client.
	Marker *string

	// Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater
	// than 5,000, the server will return up to 5,000 items.
	Maxresults *int32

	// Filters the results to return only entries whose name begins with the specified prefix.
	Prefix *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ServiceClientListSharesSegmentOptions contains the optional parameters for the ServiceClient.NewListSharesSegmentPager method.

type ServiceClientListSharesSegmentResponse 

type ServiceClientListSharesSegmentResponse struct {
	// An enumeration of shares.
	ListSharesResponse

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ServiceClientListSharesSegmentResponse contains the response from method ServiceClient.NewListSharesSegmentPager.

type ServiceClientSetPropertiesOptions 

type ServiceClientSetPropertiesOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

type ServiceClientSetPropertiesResponse 

type ServiceClientSetPropertiesResponse struct {
	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ServiceClientSetPropertiesResponse contains the response from method ServiceClient.SetProperties.

type Share 

type Share struct {
	// REQUIRED
	Name *string `xml:"Name"`

	// REQUIRED; Properties of a share.
	Properties *ShareProperties `xml:"Properties"`
	Deleted    *bool            `xml:"Deleted"`

	// Dictionary of
	Metadata map[string]*string `xml:"Metadata"`
	Snapshot *string            `xml:"Snapshot"`
	Version  *string            `xml:"Version"`
}

Share - A listed Azure Storage share item.

func (*Share) UnmarshalXML 

func (s *Share) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type Share.

type ShareAccessTier 

type ShareAccessTier string
const (
	ShareAccessTierCool                 ShareAccessTier = "Cool"
	ShareAccessTierHot                  ShareAccessTier = "Hot"
	ShareAccessTierTransactionOptimized ShareAccessTier = "TransactionOptimized"
)

func PossibleShareAccessTierValues 

func PossibleShareAccessTierValues() []ShareAccessTier

PossibleShareAccessTierValues returns the possible values for the ShareAccessTier const type.

type ShareClient 

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

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

func NewShareClient 

func NewShareClient(endpoint string, fileRequestIntent *ShareTokenIntent, azClient *azcore.Client) *ShareClient

NewShareClient creates a new instance of ShareClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • fileRequestIntent - Valid value is backup
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*ShareClient) AcquireLease 

func (client *ShareClient) AcquireLease(ctx context.Context, duration int32, options *ShareClientAcquireLeaseOptions) (ShareClientAcquireLeaseResponse, error)

AcquireLease - The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • 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. A lease duration cannot be changed using renew or change.
  • options - ShareClientAcquireLeaseOptions contains the optional parameters for the ShareClient.AcquireLease method.

func (*ShareClient) BreakLease 

func (client *ShareClient) BreakLease(ctx context.Context, options *ShareClientBreakLeaseOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientBreakLeaseResponse, error)

BreakLease - The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientBreakLeaseOptions contains the optional parameters for the ShareClient.BreakLease method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) ChangeLease 

func (client *ShareClient) ChangeLease(ctx context.Context, leaseID string, options *ShareClientChangeLeaseOptions) (ShareClientChangeLeaseResponse, error)

ChangeLease - The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • leaseID - Specifies the current lease ID on the resource.
  • options - ShareClientChangeLeaseOptions contains the optional parameters for the ShareClient.ChangeLease method.

func (*ShareClient) Create 

func (client *ShareClient) Create(ctx context.Context, options *ShareClientCreateOptions) (ShareClientCreateResponse, error)

Create - Creates a new share under the specified account. If the share with the same name already exists, the operation fails. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientCreateOptions contains the optional parameters for the ShareClient.Create method.

func (*ShareClient) CreatePermission 

func (client *ShareClient) CreatePermission(ctx context.Context, sharePermission SharePermission, options *ShareClientCreatePermissionOptions) (ShareClientCreatePermissionResponse, error)

CreatePermission - Create a permission (a security descriptor). If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • sharePermission - A permission (a security descriptor) at the share level.
  • options - ShareClientCreatePermissionOptions contains the optional parameters for the ShareClient.CreatePermission method.

func (*ShareClient) CreateSnapshot 

func (client *ShareClient) CreateSnapshot(ctx context.Context, options *ShareClientCreateSnapshotOptions) (ShareClientCreateSnapshotResponse, error)

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

Generated from API version 2024-11-04

  • options - ShareClientCreateSnapshotOptions contains the optional parameters for the ShareClient.CreateSnapshot method.

func (*ShareClient) Delete 

func (client *ShareClient) Delete(ctx context.Context, options *ShareClientDeleteOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientDeleteResponse, error)

Delete - Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientDeleteOptions contains the optional parameters for the ShareClient.Delete method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) Endpoint 

func (client *ShareClient) Endpoint() string

func (*ShareClient) GetAccessPolicy 

func (client *ShareClient) GetAccessPolicy(ctx context.Context, options *ShareClientGetAccessPolicyOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientGetAccessPolicyResponse, error)

GetAccessPolicy - Returns information about stored access policies specified on the share. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientGetAccessPolicyOptions contains the optional parameters for the ShareClient.GetAccessPolicy method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) GetPermission 

func (client *ShareClient) GetPermission(ctx context.Context, filePermissionKey string, options *ShareClientGetPermissionOptions) (ShareClientGetPermissionResponse, error)

GetPermission - Returns the permission (security descriptor) for a given key If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • filePermissionKey - Key of the permission to be set for the directory/file.
  • options - ShareClientGetPermissionOptions contains the optional parameters for the ShareClient.GetPermission method.

func (*ShareClient) GetProperties 

func (client *ShareClient) GetProperties(ctx context.Context, options *ShareClientGetPropertiesOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientGetPropertiesResponse, error)

GetProperties - Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientGetPropertiesOptions contains the optional parameters for the ShareClient.GetProperties method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) GetStatistics 

func (client *ShareClient) GetStatistics(ctx context.Context, options *ShareClientGetStatisticsOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientGetStatisticsResponse, error)

GetStatistics - Retrieves statistics related to the share. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientGetStatisticsOptions contains the optional parameters for the ShareClient.GetStatistics method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) InternalClient added in v1.1.0 

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

func (*ShareClient) ReleaseLease 

func (client *ShareClient) ReleaseLease(ctx context.Context, leaseID string, options *ShareClientReleaseLeaseOptions) (ShareClientReleaseLeaseResponse, error)

ReleaseLease - The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • leaseID - Specifies the current lease ID on the resource.
  • options - ShareClientReleaseLeaseOptions contains the optional parameters for the ShareClient.ReleaseLease method.

func (*ShareClient) RenewLease 

func (client *ShareClient) RenewLease(ctx context.Context, leaseID string, options *ShareClientRenewLeaseOptions) (ShareClientRenewLeaseResponse, error)

RenewLease - The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • leaseID - Specifies the current lease ID on the resource.
  • options - ShareClientRenewLeaseOptions contains the optional parameters for the ShareClient.RenewLease method.

func (*ShareClient) Restore 

func (client *ShareClient) Restore(ctx context.Context, options *ShareClientRestoreOptions) (ShareClientRestoreResponse, error)

Restore - Restores a previously deleted Share. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientRestoreOptions contains the optional parameters for the ShareClient.Restore method.

func (*ShareClient) SetAccessPolicy 

func (client *ShareClient) SetAccessPolicy(ctx context.Context, shareACL []*SignedIdentifier, options *ShareClientSetAccessPolicyOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientSetAccessPolicyResponse, error)

SetAccessPolicy - Sets a stored access policy for use with shared access signatures. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • shareACL - The ACL for the share.
  • options - ShareClientSetAccessPolicyOptions contains the optional parameters for the ShareClient.SetAccessPolicy method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) SetMetadata 

func (client *ShareClient) SetMetadata(ctx context.Context, options *ShareClientSetMetadataOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientSetMetadataResponse, error)

SetMetadata - Sets one or more user-defined name-value pairs for the specified share. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientSetMetadataOptions contains the optional parameters for the ShareClient.SetMetadata method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

func (*ShareClient) SetProperties 

func (client *ShareClient) SetProperties(ctx context.Context, options *ShareClientSetPropertiesOptions, leaseAccessConditions *LeaseAccessConditions) (ShareClientSetPropertiesResponse, error)

SetProperties - Sets properties for the specified share. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-04

  • options - ShareClientSetPropertiesOptions contains the optional parameters for the ShareClient.SetProperties method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the ShareClient.GetProperties method.

type ShareClientAcquireLeaseOptions 

type ShareClientAcquireLeaseOptions struct {
	// Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientAcquireLeaseOptions contains the optional parameters for the ShareClient.AcquireLease method.

type ShareClientAcquireLeaseResponse 

type ShareClientAcquireLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientAcquireLeaseResponse contains the response from method ShareClient.AcquireLease.

type ShareClientBreakLeaseOptions 

type ShareClientBreakLeaseOptions struct {
	// For a break operation, 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. A new lease will not be available before the break period has
	// expired, but the lease may be held for longer than the break period. If this
	// header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses,
	// and an infinite lease breaks immediately.
	BreakPeriod *int32

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientBreakLeaseOptions contains the optional parameters for the ShareClient.BreakLease method.

type ShareClientBreakLeaseResponse 

type ShareClientBreakLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// LeaseTime contains the information returned from the x-ms-lease-time header response.
	LeaseTime *int32

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientBreakLeaseResponse contains the response from method ShareClient.BreakLease.

type ShareClientChangeLeaseOptions 

type ShareClientChangeLeaseOptions struct {
	// Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientChangeLeaseOptions contains the optional parameters for the ShareClient.ChangeLease method.

type ShareClientChangeLeaseResponse 

type ShareClientChangeLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientChangeLeaseResponse contains the response from method ShareClient.ChangeLease.

type ShareClientCreateOptions 

type ShareClientCreateOptions struct {
	// Specifies the access tier of the share.
	AccessTier                           *ShareAccessTier
	EnableSnapshotVirtualDirectoryAccess *bool

	// Protocols to enable on the share.
	EnabledProtocols *string

	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// Optional. Boolean. Default if not specified is false. This property enables paid bursting.
	PaidBurstingEnabled *bool

	// Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a
	// file share is 10,340 MiB/sec.
	PaidBurstingMaxBandwidthMibps *int64

	// Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file
	// share is 102,400 IOPS.
	PaidBurstingMaxIops *int64

	// Specifies the maximum size of the share, in gigabytes.
	Quota *int32

	// Root squash to set on the share. Only valid for NFS shares.
	RootSquash *ShareRootSquash

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientCreateOptions contains the optional parameters for the ShareClient.Create method.

type ShareClientCreatePermissionOptions 

type ShareClientCreatePermissionOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientCreatePermissionOptions contains the optional parameters for the ShareClient.CreatePermission method.

type ShareClientCreatePermissionResponse 

type ShareClientCreatePermissionResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// FilePermissionKey contains the information returned from the x-ms-file-permission-key header response.
	FilePermissionKey *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientCreatePermissionResponse contains the response from method ShareClient.CreatePermission.

type ShareClientCreateResponse 

type ShareClientCreateResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientCreateResponse contains the response from method ShareClient.Create.

type ShareClientCreateSnapshotOptions 

type ShareClientCreateSnapshotOptions struct {
	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientCreateSnapshotOptions contains the optional parameters for the ShareClient.CreateSnapshot method.

type ShareClientCreateSnapshotResponse 

type ShareClientCreateSnapshotResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Snapshot contains the information returned from the x-ms-snapshot header response.
	Snapshot *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientCreateSnapshotResponse contains the response from method ShareClient.CreateSnapshot.

type ShareClientDeleteOptions 

type ShareClientDeleteOptions struct {
	// Specifies the option include to delete the base share and all of its snapshots.
	DeleteSnapshots *DeleteSnapshotsOptionType

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientDeleteOptions contains the optional parameters for the ShareClient.Delete method.

type ShareClientDeleteResponse 

type ShareClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientDeleteResponse contains the response from method ShareClient.Delete.

type ShareClientGetAccessPolicyOptions 

type ShareClientGetAccessPolicyOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientGetAccessPolicyOptions contains the optional parameters for the ShareClient.GetAccessPolicy method.

type ShareClientGetAccessPolicyResponse 

type ShareClientGetAccessPolicyResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// A collection of signed identifiers.
	SignedIdentifiers []*SignedIdentifier `xml:"SignedIdentifier"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientGetAccessPolicyResponse contains the response from method ShareClient.GetAccessPolicy.

type ShareClientGetPermissionOptions 

type ShareClientGetPermissionOptions struct {
	// Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable
	// values are SDDL or binary. If x-ms-file-permission-format is unspecified or
	// explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to
	// binary, the permission is returned as a base64 string representing the binary
	// encoding of the permission
	FilePermissionFormat *FilePermissionFormat

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientGetPermissionOptions contains the optional parameters for the ShareClient.GetPermission method.

type ShareClientGetPermissionResponse 

type ShareClientGetPermissionResponse struct {
	// A permission (a security descriptor) at the share level.
	SharePermission

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientGetPermissionResponse contains the response from method ShareClient.GetPermission.

type ShareClientGetPropertiesOptions 

type ShareClientGetPropertiesOptions struct {
	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientGetPropertiesOptions contains the optional parameters for the ShareClient.GetProperties method.

type ShareClientGetPropertiesResponse 

type ShareClientGetPropertiesResponse struct {
	// AccessTier contains the information returned from the x-ms-access-tier header response.
	AccessTier *string

	// AccessTierChangeTime contains the information returned from the x-ms-access-tier-change-time header response.
	AccessTierChangeTime *time.Time

	// AccessTierTransitionState contains the information returned from the x-ms-access-tier-transition-state header response.
	AccessTierTransitionState *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EnableSnapshotVirtualDirectoryAccess contains the information returned from the x-ms-enable-snapshot-virtual-directory-access
	// header response.
	EnableSnapshotVirtualDirectoryAccess *bool

	// EnabledProtocols contains the information returned from the x-ms-enabled-protocols header response.
	EnabledProtocols *string

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *LeaseDurationType

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *LeaseStateType

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *LeaseStatusType

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// NextAllowedQuotaDowngradeTime contains the information returned from the x-ms-share-next-allowed-quota-downgrade-time header
	// response.
	NextAllowedQuotaDowngradeTime *time.Time

	// PaidBurstingEnabled contains the information returned from the x-ms-share-paid-bursting-enabled header response.
	PaidBurstingEnabled *bool

	// PaidBurstingMaxBandwidthMibps contains the information returned from the x-ms-share-paid-bursting-max-bandwidth-mibps header
	// response.
	PaidBurstingMaxBandwidthMibps *int64

	// PaidBurstingMaxIops contains the information returned from the x-ms-share-paid-bursting-max-iops header response.
	PaidBurstingMaxIops *int64

	// ProvisionedBandwidthMiBps contains the information returned from the x-ms-share-provisioned-bandwidth-mibps header response.
	ProvisionedBandwidthMiBps *int32

	// ProvisionedEgressMBps contains the information returned from the x-ms-share-provisioned-egress-mbps header response.
	ProvisionedEgressMBps *int32

	// ProvisionedIngressMBps contains the information returned from the x-ms-share-provisioned-ingress-mbps header response.
	ProvisionedIngressMBps *int32

	// ProvisionedIops contains the information returned from the x-ms-share-provisioned-iops header response.
	ProvisionedIops *int32

	// Quota contains the information returned from the x-ms-share-quota header response.
	Quota *int32

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// RootSquash contains the information returned from the x-ms-root-squash header response.
	RootSquash *ShareRootSquash

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientGetPropertiesResponse contains the response from method ShareClient.GetProperties.

type ShareClientGetStatisticsOptions 

type ShareClientGetStatisticsOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientGetStatisticsOptions contains the optional parameters for the ShareClient.GetStatistics method.

type ShareClientGetStatisticsResponse 

type ShareClientGetStatisticsResponse struct {
	// Stats for the share.
	ShareStats

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientGetStatisticsResponse contains the response from method ShareClient.GetStatistics.

type ShareClientReleaseLeaseOptions 

type ShareClientReleaseLeaseOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientReleaseLeaseOptions contains the optional parameters for the ShareClient.ReleaseLease method.

type ShareClientReleaseLeaseResponse 

type ShareClientReleaseLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientReleaseLeaseResponse contains the response from method ShareClient.ReleaseLease.

type ShareClientRenewLeaseOptions 

type ShareClientRenewLeaseOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
	Sharesnapshot *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientRenewLeaseOptions contains the optional parameters for the ShareClient.RenewLease method.

type ShareClientRenewLeaseResponse 

type ShareClientRenewLeaseResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientRenewLeaseResponse contains the response from method ShareClient.RenewLease.

type ShareClientRestoreOptions 

type ShareClientRestoreOptions struct {
	// Specifies the name of the previously-deleted share.
	DeletedShareName *string

	// Specifies the version of the previously-deleted share.
	DeletedShareVersion *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientRestoreOptions contains the optional parameters for the ShareClient.Restore method.

type ShareClientRestoreResponse 

type ShareClientRestoreResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientRestoreResponse contains the response from method ShareClient.Restore.

type ShareClientSetAccessPolicyOptions 

type ShareClientSetAccessPolicyOptions struct {
	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientSetAccessPolicyOptions contains the optional parameters for the ShareClient.SetAccessPolicy method.

type ShareClientSetAccessPolicyResponse 

type ShareClientSetAccessPolicyResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientSetAccessPolicyResponse contains the response from method ShareClient.SetAccessPolicy.

type ShareClientSetMetadataOptions 

type ShareClientSetMetadataOptions struct {
	// A name-value pair to associate with a file storage object.
	Metadata map[string]*string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientSetMetadataOptions contains the optional parameters for the ShareClient.SetMetadata method.

type ShareClientSetMetadataResponse 

type ShareClientSetMetadataResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientSetMetadataResponse contains the response from method ShareClient.SetMetadata.

type ShareClientSetPropertiesOptions 

type ShareClientSetPropertiesOptions struct {
	// Specifies the access tier of the share.
	AccessTier                           *ShareAccessTier
	EnableSnapshotVirtualDirectoryAccess *bool

	// Optional. Boolean. Default if not specified is false. This property enables paid bursting.
	PaidBurstingEnabled *bool

	// Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a
	// file share is 10,340 MiB/sec.
	PaidBurstingMaxBandwidthMibps *int64

	// Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file
	// share is 102,400 IOPS.
	PaidBurstingMaxIops *int64

	// Specifies the maximum size of the share, in gigabytes.
	Quota *int32

	// Root squash to set on the share. Only valid for NFS shares.
	RootSquash *ShareRootSquash

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN]
	Timeout *int32
}

ShareClientSetPropertiesOptions contains the optional parameters for the ShareClient.SetProperties method.

type ShareClientSetPropertiesResponse 

type ShareClientSetPropertiesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ShareClientSetPropertiesResponse contains the response from method ShareClient.SetProperties.

type ShareFileHTTPHeaders 

type ShareFileHTTPHeaders struct {
	// Sets the file's cache control. The File service stores this value but does not use or modify it.
	CacheControl *string

	// Sets the file's Content-Disposition header.
	ContentDisposition *string

	// Specifies which content encodings have been applied to the file.
	ContentEncoding *string

	// Specifies the natural languages used by this resource.
	ContentLanguage *string

	// Sets the file's MD5 hash.
	ContentMD5 []byte

	// Sets the MIME content type of the file. The default type is 'application/octet-stream'.
	ContentType *string
}

ShareFileHTTPHeaders contains a group of parameters for the FileClient.Create method.

type ShareFileRangeList 

type ShareFileRangeList struct {
	ClearRanges []*ClearRange `xml:"ClearRange"`
	Ranges      []*FileRange  `xml:"Range"`
}

ShareFileRangeList - The list of file ranges

func (ShareFileRangeList) MarshalXML 

func (s ShareFileRangeList) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ShareFileRangeList.

type SharePermission 

type SharePermission struct {
	// REQUIRED; The permission in the Security Descriptor Definition Language (SDDL).
	Permission *string
	Format     *FilePermissionFormat
}

SharePermission - A permission (a security descriptor) at the share level.

func (SharePermission) MarshalJSON 

func (s SharePermission) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SharePermission.

func (*SharePermission) UnmarshalJSON 

func (s *SharePermission) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharePermission.

type ShareProperties 

type ShareProperties struct {
	// REQUIRED
	ETag *azcore.ETag `xml:"Etag"`

	// REQUIRED
	LastModified *time.Time `xml:"Last-Modified"`

	// REQUIRED
	Quota                                *int32     `xml:"Quota"`
	AccessTier                           *string    `xml:"AccessTier"`
	AccessTierChangeTime                 *time.Time `xml:"AccessTierChangeTime"`
	AccessTierTransitionState            *string    `xml:"AccessTierTransitionState"`
	DeletedTime                          *time.Time `xml:"DeletedTime"`
	EnableSnapshotVirtualDirectoryAccess *bool      `xml:"EnableSnapshotVirtualDirectoryAccess"`
	EnabledProtocols                     *string    `xml:"EnabledProtocols"`

	// When a share is leased, specifies whether the lease is of infinite or fixed duration.
	LeaseDuration *LeaseDurationType `xml:"LeaseDuration"`

	// Lease state of the share.
	LeaseState *LeaseStateType `xml:"LeaseState"`

	// The current lease status of the share.
	LeaseStatus                   *LeaseStatusType `xml:"LeaseStatus"`
	NextAllowedQuotaDowngradeTime *time.Time       `xml:"NextAllowedQuotaDowngradeTime"`
	PaidBurstingEnabled           *bool            `xml:"PaidBurstingEnabled"`
	PaidBurstingMaxBandwidthMibps *int64           `xml:"PaidBurstingMaxBandwidthMibps"`
	PaidBurstingMaxIops           *int64           `xml:"PaidBurstingMaxIops"`
	ProvisionedBandwidthMiBps     *int32           `xml:"ProvisionedBandwidthMiBps"`
	ProvisionedEgressMBps         *int32           `xml:"ProvisionedEgressMBps"`
	ProvisionedIngressMBps        *int32           `xml:"ProvisionedIngressMBps"`
	ProvisionedIops               *int32           `xml:"ProvisionedIops"`
	RemainingRetentionDays        *int32           `xml:"RemainingRetentionDays"`
	RootSquash                    *ShareRootSquash `xml:"RootSquash"`
}

ShareProperties - Properties of a share.

func (ShareProperties) MarshalXML 

func (s ShareProperties) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ShareProperties.

func (*ShareProperties) UnmarshalXML 

func (s *ShareProperties) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type ShareProperties.

type ShareRootSquash 

type ShareRootSquash string
const (
	ShareRootSquashAllSquash    ShareRootSquash = "AllSquash"
	ShareRootSquashNoRootSquash ShareRootSquash = "NoRootSquash"
	ShareRootSquashRootSquash   ShareRootSquash = "RootSquash"
)

func PossibleShareRootSquashValues 

func PossibleShareRootSquashValues() []ShareRootSquash

PossibleShareRootSquashValues returns the possible values for the ShareRootSquash const type.

type ShareStats 

type ShareStats struct {
	// REQUIRED; The approximate size of the data stored in bytes. Note that this value may not include all recently created or
	// recently resized files.
	ShareUsageBytes *int64 `xml:"ShareUsageBytes"`
}

ShareStats - Stats for the share.

type ShareTokenIntent added in v1.1.0 

type ShareTokenIntent string
const (
	ShareTokenIntentBackup ShareTokenIntent = "backup"
)

func PossibleShareTokenIntentValues added in v1.1.0 

func PossibleShareTokenIntentValues() []ShareTokenIntent

PossibleShareTokenIntentValues returns the possible values for the ShareTokenIntent const type.

type SignedIdentifier 

type SignedIdentifier struct {
	// REQUIRED; A unique id.
	ID *string `xml:"Id"`

	// The access policy.
	AccessPolicy *AccessPolicy `xml:"AccessPolicy"`
}

SignedIdentifier - Signed identifier.

type SourceContentSetter 

type SourceContentSetter interface {
	SetSourceContentCRC64(v []byte)
}

type SourceLeaseAccessConditions added in v1.1.0 

type SourceLeaseAccessConditions struct {
	// Required if the source file has an active infinite lease.
	SourceLeaseID *string
}

SourceLeaseAccessConditions contains a group of parameters for the DirectoryClient.Rename method.

type SourceModifiedAccessConditions 

type SourceModifiedAccessConditions struct {
	// Specify the crc64 value to operate only on range with a matching crc64 checksum.
	SourceIfMatchCRC64 []byte

	// Specify the crc64 value to operate only on range without a matching crc64 checksum.
	SourceIfNoneMatchCRC64 []byte
}

SourceModifiedAccessConditions contains a group of parameters for the FileClient.UploadRangeFromURL method.

type StorageError 

type StorageError struct {
	AuthenticationErrorDetail *string
	Message                   *string
}

func (StorageError) MarshalJSON 

func (s StorageError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageError.

func (*StorageError) UnmarshalJSON 

func (s *StorageError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageError.

type StorageErrorCode 

type StorageErrorCode string

StorageErrorCode - Error codes returned by the service 

const (
	StorageErrorCodeAccountAlreadyExists                 StorageErrorCode = "AccountAlreadyExists"
	StorageErrorCodeAccountBeingCreated                  StorageErrorCode = "AccountBeingCreated"
	StorageErrorCodeAccountIsDisabled                    StorageErrorCode = "AccountIsDisabled"
	StorageErrorCodeAuthenticationFailed                 StorageErrorCode = "AuthenticationFailed"
	StorageErrorCodeAuthorizationFailure                 StorageErrorCode = "AuthorizationFailure"
	StorageErrorCodeAuthorizationPermissionMismatch      StorageErrorCode = "AuthorizationPermissionMismatch"
	StorageErrorCodeAuthorizationProtocolMismatch        StorageErrorCode = "AuthorizationProtocolMismatch"
	StorageErrorCodeAuthorizationResourceTypeMismatch    StorageErrorCode = "AuthorizationResourceTypeMismatch"
	StorageErrorCodeAuthorizationServiceMismatch         StorageErrorCode = "AuthorizationServiceMismatch"
	StorageErrorCodeAuthorizationSourceIPMismatch        StorageErrorCode = "AuthorizationSourceIPMismatch"
	StorageErrorCodeCannotDeleteFileOrDirectory          StorageErrorCode = "CannotDeleteFileOrDirectory"
	StorageErrorCodeClientCacheFlushDelay                StorageErrorCode = "ClientCacheFlushDelay"
	StorageErrorCodeConditionHeadersNotSupported         StorageErrorCode = "ConditionHeadersNotSupported"
	StorageErrorCodeConditionNotMet                      StorageErrorCode = "ConditionNotMet"
	StorageErrorCodeContainerQuotaDowngradeNotAllowed    StorageErrorCode = "ContainerQuotaDowngradeNotAllowed"
	StorageErrorCodeDeletePending                        StorageErrorCode = "DeletePending"
	StorageErrorCodeDirectoryNotEmpty                    StorageErrorCode = "DirectoryNotEmpty"
	StorageErrorCodeEmptyMetadataKey                     StorageErrorCode = "EmptyMetadataKey"
	StorageErrorCodeFeatureVersionMismatch               StorageErrorCode = "FeatureVersionMismatch"
	StorageErrorCodeFileLockConflict                     StorageErrorCode = "FileLockConflict"
	StorageErrorCodeInsufficientAccountPermissions       StorageErrorCode = "InsufficientAccountPermissions"
	StorageErrorCodeInternalError                        StorageErrorCode = "InternalError"
	StorageErrorCodeInvalidAuthenticationInfo            StorageErrorCode = "InvalidAuthenticationInfo"
	StorageErrorCodeInvalidFileOrDirectoryPathName       StorageErrorCode = "InvalidFileOrDirectoryPathName"
	StorageErrorCodeInvalidHTTPVerb                      StorageErrorCode = "InvalidHttpVerb"
	StorageErrorCodeInvalidHeaderValue                   StorageErrorCode = "InvalidHeaderValue"
	StorageErrorCodeInvalidInput                         StorageErrorCode = "InvalidInput"
	StorageErrorCodeInvalidMD5                           StorageErrorCode = "InvalidMd5"
	StorageErrorCodeInvalidMetadata                      StorageErrorCode = "InvalidMetadata"
	StorageErrorCodeInvalidQueryParameterValue           StorageErrorCode = "InvalidQueryParameterValue"
	StorageErrorCodeInvalidRange                         StorageErrorCode = "InvalidRange"
	StorageErrorCodeInvalidResourceName                  StorageErrorCode = "InvalidResourceName"
	StorageErrorCodeInvalidURI                           StorageErrorCode = "InvalidUri"
	StorageErrorCodeInvalidXMLDocument                   StorageErrorCode = "InvalidXmlDocument"
	StorageErrorCodeInvalidXMLNodeValue                  StorageErrorCode = "InvalidXmlNodeValue"
	StorageErrorCodeMD5Mismatch                          StorageErrorCode = "Md5Mismatch"
	StorageErrorCodeMetadataTooLarge                     StorageErrorCode = "MetadataTooLarge"
	StorageErrorCodeMissingContentLengthHeader           StorageErrorCode = "MissingContentLengthHeader"
	StorageErrorCodeMissingRequiredHeader                StorageErrorCode = "MissingRequiredHeader"
	StorageErrorCodeMissingRequiredQueryParameter        StorageErrorCode = "MissingRequiredQueryParameter"
	StorageErrorCodeMissingRequiredXMLNode               StorageErrorCode = "MissingRequiredXmlNode"
	StorageErrorCodeMultipleConditionHeadersNotSupported StorageErrorCode = "MultipleConditionHeadersNotSupported"
	StorageErrorCodeOperationTimedOut                    StorageErrorCode = "OperationTimedOut"
	StorageErrorCodeOutOfRangeInput                      StorageErrorCode = "OutOfRangeInput"
	StorageErrorCodeOutOfRangeQueryParameterValue        StorageErrorCode = "OutOfRangeQueryParameterValue"
	StorageErrorCodeParentNotFound                       StorageErrorCode = "ParentNotFound"
	StorageErrorCodePreviousSnapshotNotFound             StorageErrorCode = "PreviousSnapshotNotFound"
	StorageErrorCodeReadOnlyAttribute                    StorageErrorCode = "ReadOnlyAttribute"
	StorageErrorCodeRequestBodyTooLarge                  StorageErrorCode = "RequestBodyTooLarge"
	StorageErrorCodeRequestURLFailedToParse              StorageErrorCode = "RequestUrlFailedToParse"
	StorageErrorCodeResourceAlreadyExists                StorageErrorCode = "ResourceAlreadyExists"
	StorageErrorCodeResourceNotFound                     StorageErrorCode = "ResourceNotFound"
	StorageErrorCodeResourceTypeMismatch                 StorageErrorCode = "ResourceTypeMismatch"
	StorageErrorCodeServerBusy                           StorageErrorCode = "ServerBusy"
	StorageErrorCodeShareAlreadyExists                   StorageErrorCode = "ShareAlreadyExists"
	StorageErrorCodeShareBeingDeleted                    StorageErrorCode = "ShareBeingDeleted"
	StorageErrorCodeShareDisabled                        StorageErrorCode = "ShareDisabled"
	StorageErrorCodeShareHasSnapshots                    StorageErrorCode = "ShareHasSnapshots"
	StorageErrorCodeShareNotFound                        StorageErrorCode = "ShareNotFound"
	StorageErrorCodeShareSnapshotCountExceeded           StorageErrorCode = "ShareSnapshotCountExceeded"
	StorageErrorCodeShareSnapshotInProgress              StorageErrorCode = "ShareSnapshotInProgress"
	StorageErrorCodeShareSnapshotOperationNotSupported   StorageErrorCode = "ShareSnapshotOperationNotSupported"
	StorageErrorCodeSharingViolation                     StorageErrorCode = "SharingViolation"
	StorageErrorCodeUnsupportedHTTPVerb                  StorageErrorCode = "UnsupportedHttpVerb"
	StorageErrorCodeUnsupportedHeader                    StorageErrorCode = "UnsupportedHeader"
	StorageErrorCodeUnsupportedQueryParameter            StorageErrorCode = "UnsupportedQueryParameter"
	StorageErrorCodeUnsupportedXMLNode                   StorageErrorCode = "UnsupportedXmlNode"
)

func PossibleStorageErrorCodeValues 

func PossibleStorageErrorCodeValues() []StorageErrorCode

PossibleStorageErrorCodeValues returns the possible values for the StorageErrorCode const type.

type StorageServiceProperties 

type StorageServiceProperties struct {
	// The set of CORS rules.
	CORS []*CORSRule `xml:"Cors>CorsRule"`

	// A summary of request statistics grouped by API in hourly aggregates for files.
	HourMetrics *Metrics `xml:"HourMetrics"`

	// A summary of request statistics grouped by API in minute aggregates for files.
	MinuteMetrics *Metrics `xml:"MinuteMetrics"`

	// Protocol settings
	Protocol *ProtocolSettings `xml:"ProtocolSettings"`
}

StorageServiceProperties - Storage 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 StringEncoded added in v1.1.0 

type StringEncoded struct {
	Content *string `xml:",chardata"`
	Encoded *bool   `xml:"Encoded,attr"`
}

type TransactionalContentSetter 

type TransactionalContentSetter interface {
	SetMD5([]byte)
}

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.