Codeunit "AFS Optional Parameters"
Holds procedures to format headers and parameters to be used in requests.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentEntitlements | X |
| InherentPermissions | X |
Methods
Range
Sets the value for 'x-ms-range' HttpHeader for a request.
procedure Range(BytesStartValue: Integer, BytesEndValue: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| BytesStartValue | Integer |
Integer value specifying the Bytes start range value |
| BytesEndValue | Integer |
Integer value specifying the Bytes end range value |
Write
Sets the value for 'x-ms-write' HttpHeader for a request.
procedure Write(Value: Enum "AFS Write")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage.Files."AFS Write" |
Enum "AFS Write" value specifying the HttpHeader value |
LeaseId
Sets the value for 'x-ms-lease-id' HttpHeader for a request.
procedure LeaseId(Value: Guid)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Guid |
Guid value specifying the LeaseID |
LeaseDuration
Sets the value for 'x-ms-lease-duration' HttpHeader for a request.
procedure LeaseDuration(Value: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Integer |
Integer value specifying the LeaseDuration in seconds |
ProposedLeaseId
Sets the value for 'x-ms-proposed-lease-id' HttpHeader for a request.
procedure ProposedLeaseId(Value: Guid)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Guid |
Guid value specifying the ProposedLeaseId in seconds |
ClientRequestId
Sets the value for 'x-ms-client-request-id' HttpHeader for a request.
procedure ClientRequestId(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
FileLastWriteTime
Sets the value for 'x-ms-file-last-write-time' HttpHeader for a request.
procedure FileLastWriteTime(Value: Enum "AFS File Last Write Time")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage.Files."AFS File Last Write Time" |
Enum "AFS File Last Write Time" value specifying the HttpHeader value |
FileRequestIntent
Sets the value for 'x-ms-file-request-intent' HttpHeader for a request, 'backup' is an acceptable value.
procedure FileRequestIntent(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
FilePermission
Sets the value for 'x-ms-file-permission' HttpHeader for a request.
procedure FilePermission(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
FilePermissionKey
Sets the value for 'x-ms-file-permission-key' HttpHeader for a request.
procedure FilePermissionKey(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
FileAttributes
Sets the value for 'x-ms-file-attributes' HttpHeader for a request.
procedure FileAttributes(Value: List of [Enum "AFS File Attribute"])Parameters
| Name | Type | Description |
|---|---|---|
| Value | List of [Enum System.Azure.Storage.Files."AFS File Attribute"] |
Text value specifying the HttpHeader value |
FileCreationTime
Sets the value for 'x-ms-file-creation-time' HttpHeader for a request.
procedure FileCreationTime(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
Datetime of the file creation |
FileLastWriteTime
Sets the value for 'x-ms-file-last-write-time' HttpHeader for a request.
procedure FileLastWriteTime(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
Datetime of the file last write time |
FileChangeTime
Sets the value for 'x-ms-file-change-time' HttpHeader for a request.
procedure FileChangeTime(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
Datetime of the file last change time |
Meta
Sets the value for 'x-ms-meta-name' HttpHeader for a request. name should adhere to C# identifiers naming convention.
procedure Meta("Key": Text, Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Key | Text |
Text value specifying the metadata name key |
| Value | Text |
Text value specifying the HttpHeader value |
FilePermissionCopyMode
Sets the value for 'x-ms-file-permission-copy-mode' HttpHeader for a request.
procedure FilePermissionCopyMode(Value: Enum "AFS File Permission Copy Mode")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage.Files."AFS File Permission Copy Mode" |
Enum "AFS File Permission Copy Mode" value specifying the HttpHeader value |
CopySource
Sets the value for 'x-ms-copy-source' HttpHeader for a request.
procedure CopySource(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
AllowTrailingDot
Sets the value for 'x-ms-allow-trailing-dot' HttpHeader for a request.
procedure AllowTrailingDot(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
FileRenameReplaceIfExists
Sets the value for 'x-ms-file-rename-replace-if-exists' HttpHeader for a request.
procedure FileRenameReplaceIfExists(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
FileRenameIgnoreReadOnly
Sets the value for 'x-ms-file-rename-ignore-readonly' HttpHeader for a request.
procedure FileRenameIgnoreReadOnly(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
SourceLeaseId
Sets the value for 'x-ms-source-lease-id' HttpHeader for a request.
procedure SourceLeaseId(Value: Guid)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Guid |
Guid value specifying the SourceLeaseID |
DestinationLeaseId
Sets the value for 'x-ms-destination-lease-id' HttpHeader for a request.
procedure DestinationLeaseId(Value: Guid)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Guid |
Guid value specifying the DestinationLeaseID |
FileCopyIgnoreReadOnly
Sets the value for 'x-ms-file-copy-ignore-readonly' HttpHeader for a request.
procedure FileCopyIgnoreReadOnly(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
FileCopySetArchive
Sets the value for 'x-ms-file-copy-set-archive' HttpHeader for a request.
procedure FileCopySetArchive(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
FileExtendedInfo
Sets the value for 'x-ms-file-extended-info' HttpHeader for a request.
procedure FileExtendedInfo(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
RangeGetContentMD5
Sets the value for 'x-ms-range-get-content-md5' HttpHeader for a request.
procedure RangeGetContentMD5(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
Recursive
Sets the value for 'x-ms-recursive' HttpHeader for a request.
procedure Recursive(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
Timeout
Sets the optional timeout value for the request.
procedure Timeout(Value: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Integer |
Timeout in seconds. Most operations have a max. limit of 30 seconds. For more Information see: https://go.microsoft.com/fwlink/?linkid=2210591 |
Prefix
Filters the results to return only blobs whose names begin with the specified prefix.
procedure Prefix(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Prefix to search for |
ShareSnapshot
Specifies the share snapshot to query for the list of files and directories.
procedure ShareSnapshot(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
Datetime of the snapshot to query |
Marker
A string value that identifies the portion of the list to be returned with the next list operation.
procedure Marker(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text marker that was returned in previous operation |
MaxResults
Specifies the maximum number of files or directories to return
procedure MaxResults(Value: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Integer |
Max. number of results to return. Must be positive, must not be greater than 5000 |
Include
Specifies one or more properties to include in the response.
procedure Include(Value: List of [Enum "AFS Property"])Parameters
| Name | Type | Description |
|---|---|---|
| Value | List of [Enum System.Azure.Storage.Files."AFS Property"] |
List of properties to include. |