Data.Cloud.AzureAPI.TAccessPolicy

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

  TAccessPolicy = record
    Start: string;
    Expiry: string;
    PermRead: Boolean;
    PermWrite: Boolean;
    PermDelete:Boolean;
    PermList: Boolean;
    function GetPermission: string;
    procedure SetPermission(const rwdl: string);
    function AsXML: string;
    class function Create: TAccessPolicy; static;
    property Permission: string read GetPermission write SetPermission;
  end;

C++

struct DECLSPEC_DRECORD TAccessPolicy
{
public:
    System::UnicodeString Start;
    System::UnicodeString Expiry;
    bool PermRead;
    bool PermWrite;
    bool PermDelete;
    bool PermList;
    System::UnicodeString __fastcall GetPermission(void);
    void __fastcall SetPermission(const System::UnicodeString rwdl);
    System::UnicodeString __fastcall AsXML(void);
    static TAccessPolicy __fastcall Create();
    __property System::UnicodeString Permission = {read=GetPermission, write=SetPermission};
};

Properties

Type Visibility Source Unit Parent
record
struct
public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI Data.Cloud.AzureAPI

Description

Warning: TAccessPolicy is deprecated. Please use a subclass of TPolicy.

Access policy information, specifying the allowed public operations.

TAccessPolicy is a record with access policy information, specifying the allowed public operations. The four possible operations are: Read, Write, Delete, and List. Each of these can be enabled or disabled. Furthermore, the access policy can have a start time and an expiry time, to create a window of time the policy takes effect for.

The fields of the TAccessPolicy record are listed in the following table:

Field Meaning

Start

Represents the date before which the access policy is not valid. The date must be expressed as Coordinated Universal Time (UTC) and must adhere to a valid ISO 8061 format. Supported formats include:

YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, YYYY-MM-DDThh:mm:ssTZD, and YYYY-MM-DDThh:mm:ss.ffffffTZD

Expiry

The date after which the access policy is not valid. The date must be expressed as UTC and must adhere to a valid ISO 8061 format. Supported formats include:

YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, YYYY-MM-DDThh:mm:ssTZD, and YYYY-MM-DDThh:mm:ss.ffffffTZD

PermRead

True when read permission is granted by this access policy.

PermWrite

True when write permission is granted by this access policy.

PermDelete

True when delete permission is granted by this access policy.

PermList

True when list permission is granted by this access policy.

GetPermission

Returns the string representation of the permissions. Note that the representation is always in the order: rwdl, omitting any permissions that are currently set to False.

SetPermission

Sets the Boolean fields by parsing the string representation. Note that only four characters, at most, are expected in the rwdl string. If one of the characters is present in the string, then its corresponding permission Boolean field is set to True. Otherwise, it is set to False.

AsXML

Returns the XML representation of the access policy, as it is required by Azure.

Create

Creates a new instance of TAccessPolicy with all permissions, except read.

Permission

Returns or sets the permissions with a string representation.

See Also