Codeunit "ABS Container Client"
Provides functionality to use operations on containers in Azure BLOB Services.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentEntitlements | X |
| InherentPermissions | X |
Methods
Initialize
Initializes the Azure BLOB Storage container client.
procedure Initialize(StorageAccount: Text, Authorization: Interface "Storage Service Authorization")Parameters
| Name | Type | Description |
|---|---|---|
| StorageAccount | Text |
The name of Storage Account to use. |
| Authorization | Interface System.Azure.Storage."Storage Service Authorization" |
The authorization to use. |
Initialize
Initializes the Azure BLOB Storage container client.
procedure Initialize(StorageAccount: Text, Authorization: Interface "Storage Service Authorization", ApiVersion: Enum "Storage Service API Version")Parameters
| Name | Type | Description |
|---|---|---|
| StorageAccount | Text |
The Storage Account to use. |
| Authorization | Interface System.Azure.Storage."Storage Service Authorization" |
The Storage Account to use. |
| ApiVersion | Enum System.Azure.Storage."Storage Service API Version" |
The API version to use. |
SetBaseUrl
The base URL to use when constructing the final URI. If not set, the base URL is https://%1.blob.core.windows.net where %1 is the storage account name.
procedure SetBaseUrl(BaseUrl: Text)Parameters
| Name | Type | Description |
|---|---|---|
| BaseUrl | Text |
A valid URL string |
Remarks
Use %1 as a placeholder for the storage account name.
ListContainers
List all containers in specific Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2211410
procedure ListContainers(var ABSContainers: Record "ABS Container" temporary): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ABSContainers | Table System.Azure.Storage."ABS Container" |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
ListContainers
List all containers in specific Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2211410
procedure ListContainers(var ABSContainers: Record "ABS Container" temporary, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ABSContainers | Table System.Azure.Storage."ABS Container" | |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
CreateContainer
Creates a new container in the Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2211411
procedure CreateContainer(ContainerName: Text): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
CreateContainer
Creates a new container in the Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2211411
procedure CreateContainer(ContainerName: Text, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container to create. |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
DeleteContainer
Deletes a container from the Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2210393
procedure DeleteContainer(ContainerName: Text): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
DeleteContainer
Deletes a container from the Storage Account. see: https://go.microsoft.com/fwlink/?linkid=2210393
procedure DeleteContainer(ContainerName: Text, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container to delete. |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, ABSOptionalParameters: Codeunit "ABS Optional Parameters", var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, DurationSeconds: Integer, var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| DurationSeconds | Integer |
Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, DurationSeconds: Integer, ABSOptionalParameters: Codeunit "ABS Optional Parameters", var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| DurationSeconds | Integer |
Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, ProposedLeaseId: Guid, var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| ProposedLeaseId | Guid |
Proposed lease ID, in a GUID string format |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, ProposedLeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters", var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| ProposedLeaseId | Guid |
Proposed lease ID, in a GUID string format |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
AcquireLease
Requests a new lease. If the container does not have an active lease, the blob service creates a lease on the container. The lease duration can be 15 to 60 seconds or can be infinite see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure AcquireLease(ContainerName: Text, DurationSeconds: Integer, ProposedLeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters", var LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| DurationSeconds | Integer |
Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires |
| ProposedLeaseId | Guid |
Proposed lease ID, in a GUID string format |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
| LeaseId | Guid |
Guid containing the response value from x-ms-lease-id HttpHeader |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
ReleaseLease
Releases a lease on a container if it is no longer needed so that another client may immediately acquire a lease against the blob see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure ReleaseLease(ContainerName: Text, LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be released |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
ReleaseLease
Releases a lease on a container if it is no longer needed so that another client may immediately acquire a lease against the blob see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure ReleaseLease(ContainerName: Text, LeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be released |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
RenewLease
Renews a lease on a container to keep it locked again for the same amount of time as before see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure RenewLease(ContainerName: Text, LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be renewed |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
RenewLease
Renews a lease on a container to keep it locked again for the same amount of time as before see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure RenewLease(ContainerName: Text, LeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be renewed |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
BreakLease
Breaks a lease on a container but ensures that another client cannot acquire a new lease until the current lease period has expired see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure BreakLease(ContainerName: Text, LeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be broken |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
BreakLease
Breaks a lease on a container but ensures that another client cannot acquire a new lease until the current lease period has expired see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure BreakLease(ContainerName: Text, LeaseId: Guid, LeaseBreakPeriod: Integer): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be broken |
| LeaseBreakPeriod | Integer |
The proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
BreakLease
Breaks a lease on a container but ensures that another client cannot acquire a new lease until the current lease period has expired see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure BreakLease(ContainerName: Text, LeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be broken |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
BreakLease
Breaks a lease on a container but ensures that another client cannot acquire a new lease until the current lease period has expired see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure BreakLease(ContainerName: Text, LeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters", LeaseBreakPeriod: Integer): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be broken |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
| LeaseBreakPeriod | Integer |
The proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
ChangeLease
Changes the lease ID of an active lease see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure ChangeLease(ContainerName: Text, var LeaseId: Guid, ProposedLeaseId: Guid): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be changed. Will contain the updated Guid after successful operation. |
| ProposedLeaseId | Guid |
The Guid that should be used in future |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |
ChangeLease
Changes the lease ID of an active lease see: https://go.microsoft.com/fwlink/?linkid=2211318
procedure ChangeLease(ContainerName: Text, LeaseId: Guid, ProposedLeaseId: Guid, ABSOptionalParameters: Codeunit "ABS Optional Parameters"): Codeunit "ABS Operation Response"Parameters
| Name | Type | Description |
|---|---|---|
| ContainerName | Text |
The name of the container. |
| LeaseId | Guid |
The Guid for the lease that should be changed |
| ProposedLeaseId | Guid |
The Guid that should be used in future |
| ABSOptionalParameters | Codeunit System.Azure.Storage."ABS Optional Parameters" |
Optional parameters to pass. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Azure.Storage."ABS Operation Response" |
An operation response object |