Codeunit "ABS Optional Parameters"
Holder for the optional Azure Blob Storage HTTP headers and URL parameters.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentEntitlements | X |
| InherentPermissions | X |
Methods
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 |
SourceLeaseId
Sets the value for 'x-ms-source-lease-id' HttpHeader for a request.
procedure SourceLeaseId(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the source LeaseID |
Origin
Sets the value for 'Origin' HttpHeader for a request.
procedure Origin(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
AccessControlRequestMethod
Sets the value for 'Access-Control-Request-Method' HttpHeader for a request.
procedure AccessControlRequestMethod(Value: Enum "Http Request Type")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Security.Authentication."Http Request Type" |
Text value specifying the HttpHeader value |
AccessControlRequestHeaders
Sets the value for 'Access-Control-Request-Headers' HttpHeader for a request.
procedure AccessControlRequestHeaders(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
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 |
BlobPublicAccess
Sets the value for 'x-ms-blob-public-access' HttpHeader for a request.
procedure BlobPublicAccess(Value: Enum "ABS Blob Public Access")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage."ABS Blob Public Access" |
Enum "Blob Public Access" value specifying the HttpHeader value |
Metadata
Sets the value for 'x-ms-meta-[MetaName]' HttpHeader for a request.
procedure Metadata(MetaName: Text, Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| MetaName | Text |
The name of the Metadata-value. |
| Value | Text |
Text value specifying the Metadata value |
TagsValue
Sets the value for 'x-ms-tags' HttpHeader for a request.
procedure TagsValue(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
SourceIfModifiedSince
Sets the value for 'x-ms-source-if-modified-since' HttpHeader for a request.
procedure SourceIfModifiedSince(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
DateTime value specifying the HttpHeader value |
SourceIfUnmodifiedSince
Sets the value for 'x-ms-source-if-unmodified-since' HttpHeader for a request.
procedure SourceIfUnmodifiedSince(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
DateTime value specifying the HttpHeader value |
SourceIfMatch
Sets the value for 'x-ms-source-if-match' HttpHeader for a request.
procedure SourceIfMatch(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
SourceIfNoneMatch
Sets the value for 'x-ms-source-if-none-match' HttpHeader for a request.
procedure SourceIfNoneMatch(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
CopySourceName
Sets the value for 'x-ms-copy-source' HttpHeader for a request.
procedure CopySourceName(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Text value specifying the HttpHeader value |
RehydratePriority
Sets the value for 'x-ms-rehydrate-priority' HttpHeader for a request.
procedure RehydratePriority(Value: Enum "ABS Rehydrate Priority")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage."ABS Rehydrate Priority" |
Enum "Rehydrate Priority" value specifying the HttpHeader value |
BlobExpiryOption
Sets the value for 'x-ms-expiry-option' HttpHeader for a request.
procedure BlobExpiryOption(Value: Enum "ABS Blob Expiry Option")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage."ABS Blob Expiry Option" |
Enum "Blob Expiry Option" value specifying the HttpHeader value |
BlobExpiryTime
Sets the value for 'x-ms-expiry-time' HttpHeader for a request.
procedure BlobExpiryTime(Value: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Integer |
Integer value specifying the HttpHeader value |
BlobExpiryTime
Sets the value for 'x-ms-expiry-time' HttpHeader for a request.
procedure BlobExpiryTime(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
DateTime value specifying the HttpHeader value |
BlobAccessTier
Sets the value for 'x-ms-access-tier' HttpHeader for a request.
procedure BlobAccessTier(Value: Enum "ABS Blob Access Tier")Parameters
| Name | Type | Description |
|---|---|---|
| Value | Enum System.Azure.Storage."ABS Blob Access Tier" |
Enum "Blob Access Tier" value specifying the HttpHeader value |
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 |
SourceRange
Sets the value for 'x-ms-source-range' HttpHeader for a request.
procedure SourceRange(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 |
RequiresSync
Sets the value for 'x-ms-requires-sync' HttpHeader for a request.
procedure RequiresSync(Value: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Boolean |
Boolean value specifying the HttpHeader value |
ReturnUserPrincipalName
Sets the value for 'x-ms-upn' HttpHeader for a request. Version 2020-06-12 and later. Valid for accounts with hierarchical namespace enabled. If the user identity values that are returned in the x-ms-owner are true, they're transformed from Azure Active Directory object IDs to user principal names. If the values are false, they're returned as Azure Active Directory object IDs. The default value is false. Note that group and application object IDs are not translated, because they don't have unique friendly names.
procedure ReturnUserPrincipalName(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 |
VersionId
The versionid parameter is an opaque DateTime value that, when present, specifies the Version of the blob to retrieve.
procedure VersionId(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
The DateTime identifying the version |
Snapshot
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.
procedure Snapshot(Value: DateTime)Parameters
| Name | Type | Description |
|---|---|---|
| Value | DateTime |
The DateTime identifying the Snapshot |
Snapshot
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve.
procedure Snapshot(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
The DateTime identifying the Snapshot |
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 |
Delimiter
When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs with names that begin with the same substring until the delimiter character is reached. The delimiter may be a single character or a string.
procedure Delimiter(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
Delimiting character/string |
MaxResults
Specifies the maximum number of blobs to be fetch, from 1 to 5000 if not defined it will fetch 5000 If more than 5000 blobs then use NextMarker to fetch the next set of blobs. In certain cases, the service might return fewer results than specified by maxresults, and also return a continuation token. Setting maxresults to a value less than or equal to zero results in error response code 400 (Bad Request). see: https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs?tabs=azure-ad#uri-parameters
procedure MaxResults(Value: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Integer |
Max. number of results to fetch. Must be positive between 1 - 5000 |
NextMarker
Specifies the NextMarker of blobs to fetch see: https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs?tabs=azure-ad#uri-parameters
procedure NextMarker(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
NextMarker From previous response to fetch the next 5000 or what you have defined in MaxResults |
BlockId
Identifiers the ID of a Block in BlockBlob
procedure BlockId(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes |
Include
Specifies one or more datasets to include in the response.
procedure Include(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
The dataset(s) to include in text |
ShowOnly
Specifies the datasets to be returned in the response.
procedure ShowOnly(Value: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Value | Text |
The dataset to include in text |