AzureBlob Component
Properties Methods Events Config Settings Errors
The AzureBlob component provides an easy to use interface to Microsoft's Azure Blob Storage service.
Syntax
TcsAzureBlob
Remarks
The AzureBlob component offers an easy-to-use API for the Microsoft Azure Blob Storage service. Capabilities include uploading and downloading blobs of all types, strong encryption support, container management, and more.
Authentication
Authentication is simple, set the Account property to the name of the Azure Storage account to operate against, and set the AccessKey property to an Azure access key associated with that account.
Alternatively, this component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType. Typically, the following fields should be set to the below values:
Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" |
Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" |
Scopes | "offline_access https://{ACCOUNT}.blob.core.windows.net/user_impersonation" |
Below is a brief description of the different ClientProfile and GrantType values that are supported by this component. For a more in-depth description of what needs to be set, refer to the service documentation.
Application Profile
This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken property will be populated. Additionally, if a refresh token was provided the RefreshToken property will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the GrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this GrantType the component expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the AuthorizationCode property, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken property is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
blob.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
blob.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
blob.OAuth.ClientId = CLIENT_ID;
blob.OAuth.ClientSecret = CLIENT_SECRET;
blob.OAuth.AuthorizationScope = "https://{ACCOUNT}.blob.core.windows.net/user_impersonation";
blob.OAuth.ServerAuthURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize";
blob.OAuth.ServerTokenURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token";
blob.Authorize();
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the component will request the authorization server to get an access token. For this GrantType the component expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the access token from the redirect.
A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the component will not be able to automatically get a fresh token once it expires.
Password
Note: This grant type is considered insecure and should only be used when necessary.
When using the Resource Owner Password Credentials grant type, the component will authenticate as the resource owner. This allows for the component to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.
For this GrantType the component requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Web Profile
This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that ClientId, ClientSecret, ServerAuthURL, ServerTokenURL, and the ReturnURL properties to be set. Before calling the Authorize method, the WebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the ReturnURL property. The ReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the AuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The component will then cache these values like normal and use them to make requests. If the RefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.
Consult the Azure Blob Storage service's documentation for more information about using OAuth authentication.
Usage
Once authenticated, you can start interacting with the Azure Blob Storage service. The following list shows some of the methods used to accomplish common tasks:
- Container management: ListContainers, GetContainerInfo, CreateContainer, DeleteContainer, GetContainerACL, SetContainerACL
- Blob management: ListBlobs, GetBlobInfo, UpdateBlobInfo, CreateBlob, CopyBlob, GetBlob, DeleteBlob, UndeleteBlob
- Block blob management: ListBlocks, PutBlock, PutBlockList
- Page blob management: ListPageRanges, PutPages, ClearPages, UpdatePageBlob
- Append blob management: AppendBlock
The component support much more than just the functionality described above; refer to the complete API, below, for more information.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AccessKey | The Azure access key to use for authentication. |
AccessPolicies | A collection of access policies. |
Account | The Azure storage account name. |
Authorization | OAuth 2.0 Authorization Token. |
BlobData | The data that was downloaded, or that should be uploaded. |
BlobDelimiter | The delimiter string to use when listing blobs. |
BlobMarker | A marker indicating what page of blobs to return next. |
Blobs | A collection of blobs. |
Blocks | A collection of blocks. |
Container | Selects a container. |
ContainerMarker | A marker indicating what page of containers to return next. |
Containers | A collection of containers. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LeaseId | The lease Id to include when making requests. |
LocalFile | The location of the local file. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Metadata | A collection of metadata items. |
OAuth | This property holds the OAuth Settings. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | Whether to overwrite the local file, or remote blob. |
PageRanges | A collection of page range items. |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
Prefix | A prefix used to restrict the results returned when listing blobs or containers. |
Proxy | A set of properties related to proxy access. |
QueryParams | Additional query parameters to be included in the request. |
Range | The range of bytes to request. |
Snapshot | The blob snapshot to make requests against. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | This property includes the timeout for the component. |
UseSSL | Whether to use SSL/TLS when connecting. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AbortCopy | Aborts a copy operation. |
AddBlock | Adds a block to the Blocks properties. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
AppendBlock | Appends a block of data to an append blob. |
Authorize | Get the authorization string required to access the protected resource. |
CalcAuthorization | Calculates the Authorization header based on provided credentials. |
ClearPages | Clears a range of pages in a page blob. |
Config | Sets or retrieves a configuration setting. |
CopyBlob | Copies a blob. |
CreateBlob | Creates a new blob of the specified type. |
CreateContainer | Creates a new container. |
CreateSnapshot | Creates a new snapshot of a blob. |
DeleteBlob | Deletes a blob. |
DeleteContainer | Deletes a container. |
GetBlob | Downloads a blob. |
GetBlobInfo | Gets a blob's information and metadata. |
GetContainerACL | Gets the stored access policies and public access level for a container. |
GetContainerInfo | Gets a container's information and metadata. |
GetLink | Creates a link that provides access to a container, blob, or snapshot. |
GetUserDelegationKey | Requests a new user delegation key. |
Interrupt | This method interrupts the current method. |
Lease | Creates or manages a lease on a blob or container. |
ListBlobs | Lists the blobs in a container. |
ListBlocks | Lists the blocks associated with a block blob. |
ListContainers | Lists the containers in the blob storage account. |
ListPageRanges | Lists the page ranges of a page blob. |
PutBlock | Uploads a new block of data to a block blob. |
PutBlockList | Commits a list of data blocks to a block blob. |
PutPages | Uploads a range of pages to a page blob. |
Reset | Resets the component to its initial state. |
SendCustomRequest | Sends a custom request to the Azure Blob Storage service. |
SetContainerACL | Sets the stored access policies and public access level for a container. |
SetDownloadStream | Sets the stream to which downloaded data will be written. |
SetUploadStream | Sets the stream from which data is read when uploading. |
UndeleteBlob | Undeletes a soft-deleted blob. |
UndeleteContainer | Undeletes a soft-deleted container. |
UpdateBlobInfo | Updates a blob's information. |
UpdateMetadata | Sets the metadata for a blob or container. |
UpdatePageBlob | Updates a page blob's size and/or sequence number. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
BlobList | Fires once for each blob returned when listing blobs. |
BlockList | Fires once for each block returned when listing blocks. |
ContainerList | Fires once for each container returned when listing containers. |
EndTransfer | This event fires when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
FragmentComplete | Fires after each block in an automatic block-based upload is complete. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
MetadataList | Fires once for each metadata item returned when listing metadata. |
PrefixList | Fires once for each common prefix returned when listing blobs. |
Progress | Fires during an upload or download to indicate transfer progress. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
APIVersion | The Azure Storage REST API version being used by the component. |
AppendedBlockCount | The number of blocks that have been appended to the append blob. |
AutoAddBlocks | Whether to automatically add an item to the Blocks collection after a block is uploaded. |
BlobAccessTier[i] | The access tier of the specified blob. |
BlobAccessTierChanged[i] | The time at which the specified blob's access tier was last changed. |
BlobAccessTierInferred[i] | Whether the specified blob's access tier is inferred. |
BlobArchiveStatus[i] | The rehydration status of the specified blob. |
BlobCacheControl[i] | The Cache-Control value of the specified blob. |
BlobContentLanguage[i] | The content language of the specified blob. |
BlobRetentionDaysLeft[i] | The number of days left before the specified soft-deleted blob is permanently deleted. |
BlobSoftDeleteTime[i] | The time at which the specified blob was soft-deleted. |
BlockListStringSeparator | The separator string to use when parsing a block list string. |
CopyId | The Id of a copy operation. |
CopyProgress | The progress of a copy operation. |
CopySourceURL | The Azure storage URL to use as the source. |
CopyStatus | The status of a copy operation. |
CopyStatusDesc | The status description for a copy operation. |
DateFormat | The format to use for date and time. |
DeletePermanently | Whether a blob should be permanently deleted. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncodeBlockIds | Whether the component should automatically Base64-encode and -decode block Ids. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
Endpoint | The Azure Storage endpoint suffix that the component should use. |
FragmentSize | The block size to use when uploading a new block blob. |
IfMatch | The ETag which the blob must currently have in order for a request to succeed. |
IncludeMetadata | Whether to include metadata items when listing blobs or containers. |
IncludeSnapshots | Whether blob snapshots should be included when listing blobs. |
IncludeSoftDeleted | Whether soft-deleted blobs and containers should be included when listing. |
IncludeSystemContainers | Whether to include system containers when listing containers. |
IncludeUncommittedBlobs | Whether uncommitted block blobs should be included when listing blobs. |
LeaseBreakPeriod | The approximate number of seconds the lease will remain in the 'breaking' state. |
MaxResults | The maximum number of results to return when listing blobs or containers. |
PageRangeCleared[i] | Whether the specified page range has been cleared. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixed returned. |
PreviousSnapshot | An opaque DateTime value that identifies the snapshot to list page range changes since. |
ProgressAbsolute | Whether the component should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
SendMetadata | Whether to send metadata items when creating blobs and containers. |
SendMetadataOnCopy | Whether to send metadata items when copying blobs. |
SendMetadataOnPutBlockList | Whether to send metadata items when committing a new block list. |
SendMetadataOnSnapshot | Whether to send metadata items when creating a blob snapshot. |
SharedAccessSignature | Specifies a SAS token to use for authentication. |
SimpleUploadLimit | The maximum data size the component should attempt to upload directly when creating a block blob. |
StorePrefixList | Whether to store the common prefixes returned when listing blobs. |
TempPath | The path to the directory where temporary files are created. |
UserDelegationKey | A user delegation key to use for constructing SAS tokens. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (AzureBlob Component)
The Azure access key to use for authentication.
Syntax
property AccessKey: String read get_AccessKey write set_AccessKey;
Default Value
''
Remarks
This property specifies the Azure access key that should be used for authentication. It must be set before attempting any operations which connect to the server.
Both primary and secondary access keys are valid.
Note: this property's value is ignored if the Authorization property is populated.
This property is not available at design time.
AccessPolicies Property (AzureBlob Component)
A collection of access policies.
Syntax
property AccessPolicies: TcsAzureAccessPolicyList read get_AccessPolicies write set_AccessPolicies;
Remarks
This collection holds a list of AzureAccessPolicy items.
This collection is populated anytime GetContainerACL is called; and its items are used anytime SetContainerACL is called.
This property is not available at design time.
Please refer to the AzureAccessPolicy type for a complete list of fields.Account Property (AzureBlob Component)
The Azure storage account name.
Syntax
property Account: String read get_Account write set_Account;
Default Value
''
Remarks
This property specifies the name of the Azure storage account to operate against. It must be set before attempting any operations which connect to the server.
This property is not available at design time.
Authorization Property (AzureBlob Component)
OAuth 2.0 Authorization Token.
Syntax
property Authorization: String read get_Authorization write set_Authorization;
Default Value
''
Remarks
This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth component or a separate process. If using the OAuth property, then the Authorization property will not be used.
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Note: if both this property and AccessKey are populated, this property takes precedence, and the component will use OAuth authentication instead of shared key authentication. The Account property must be set in either case.
BlobData Property (AzureBlob Component)
The data that was downloaded, or that should be uploaded.
Syntax
property BlobData: String read get_BlobData write set_BlobData; property BlobDataB: TBytes read get_BlobDataB write set_BlobDataB;
Default Value
''
Remarks
This property is populated with blob data after calling GetBlob if SetDownloadStream and LocalFile are not set.
This property can also be set before calling AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; its data will be uploaded if SetUploadStream and LocalFile are not set.
This property is not available at design time.
BlobDelimiter Property (AzureBlob Component)
The delimiter string to use when listing blobs.
Syntax
property BlobDelimiter: String read get_BlobDelimiter write set_BlobDelimiter;
Default Value
''
Remarks
If this property is non-empty when ListBlobs is called, any blobs whose names contain the same string between the specified Prefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual blobs themselves.
The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the component will also populate the PrefixCount and Prefix[i] configuration settings
Blob Namespace Traversal
By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:
Prefix Value | Blobs Returned | Prefixes Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
This property is not available at design time.
BlobMarker Property (AzureBlob Component)
A marker indicating what page of blobs to return next.
Syntax
property BlobMarker: String read get_BlobMarker write set_BlobMarker;
Default Value
''
Remarks
This property will be populated when ListBlobs is called if the results are paged and there are more pages. To list all blobs, continue to call ListBlobs until this property returns empty string.
Refer to ListBlobs for more information.
This property is not available at design time.
Blobs Property (AzureBlob Component)
A collection of blobs.
Syntax
property Blobs: TcsAzureBlobBlobList read get_Blobs write set_Blobs;
Remarks
This collection holds a list of AzureBlobBlob items.
Calling ListBlobs or GetBlobInfo will populate this collection.
This property is not available at design time.
Please refer to the AzureBlobBlob type for a complete list of fields.Blocks Property (AzureBlob Component)
A collection of blocks.
Syntax
property Blocks: TcsAzureBlobBlockList read get_Blocks write set_Blocks;
Remarks
This collection holds a list of AzureBlobBlock items.
Calling ListBlocks or AddBlock will populate this collection; and its items are used anytime PutBlockList is called. Additionally, if the CreateBlob method is used to create a new block blob, and more than 256MB if upload data is provided, the component will use this collection as it automatically uploads the data; refer to CreateBlob for more information.
This property is not available at design time.
Please refer to the AzureBlobBlock type for a complete list of fields.Container Property (AzureBlob Component)
Selects a container.
Syntax
property Container: String read get_Container write set_Container;
Default Value
''
Remarks
This property selects a container, by name, for the component to operate against. It must be set before attempting most operations.
Container Name Rules
Container names must adhere to the following rules:
- Must be 3 to 63 characters long.
- Must start with a letter or number; and may only contain letters, numbers, and hyphens.
- All letters much be lowercase. (For convenience, the component will automatically lowercase all letters in any value assigned to Container.)
- All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).
This property is not available at design time.
ContainerMarker Property (AzureBlob Component)
A marker indicating what page of containers to return next.
Syntax
property ContainerMarker: String read get_ContainerMarker write set_ContainerMarker;
Default Value
''
Remarks
This property will be populated when ListContainers is called if the results are paged and there are more pages. To list all containers, continue to call ListContainers until this property returns empty string.
Refer to ListContainers for more information.
This property is not available at design time.
Containers Property (AzureBlob Component)
A collection of containers.
Syntax
property Containers: TcsAzureBlobContainerList read get_Containers;
Remarks
This collection holds a list of AzureBlobContainer items.
Calling ListContainers or GetContainerInfo will populate this collection.
This property is read-only and not available at design time.
Please refer to the AzureBlobContainer type for a complete list of fields.EncryptionAlgorithm Property (AzureBlob Component)
The encryption algorithm.
Syntax
property EncryptionAlgorithm: TcsEncryptionAlgorithms read get_EncryptionAlgorithm write set_EncryptionAlgorithm;
TcsEncryptionAlgorithms = ( eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 );
Default Value
eaAES
Remarks
This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:
Algorithm | Key Size |
0 (eaAES - default) | 256 |
1 (eaBlowfish) | 448 |
2 (eaCAST) | 128 |
3 (eaDES) | 64 |
4 (eaIDEA) | 128 |
5 (eaRC2) | 128 |
6 (eaRC4) | 2048 |
7 (eaTEA) | 128 |
8 (eaTripleDES) | 192 |
9 (eaTwofish) | 256 |
10 (eaRijndael) | 256 |
11 (eaChaCha) | 256 |
12 (eaXSalsa20) | 256 |
EncryptionPassword Property (AzureBlob Component)
The encryption password.
Syntax
property EncryptionPassword: String read get_EncryptionPassword write set_EncryptionPassword;
Default Value
''
Remarks
If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.
The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.
This property is not available at design time.
Firewall Property (AzureBlob Component)
A set of properties related to firewall access.
Syntax
property Firewall: TcsFirewall read get_Firewall write set_Firewall;
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (AzureBlob Component)
This property specifies the current status of the component.
Syntax
property Idle: Boolean read get_Idle;
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
LeaseId Property (AzureBlob Component)
The lease Id to include when making requests.
Syntax
property LeaseId: String read get_LeaseId write set_LeaseId;
Default Value
''
Remarks
This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.
The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.
MUST be populated | May OPTIONALLY be populated |
Containers | |
Blobs | |
|
For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For CreateBlob and CopyBlob, note that this property must be empty if the target blob does not yet exist.
For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.
Finally, note that this property is used in a specific manner by the Lease method; refer to its documentation for more information.
This property is not available at design time.
LocalFile Property (AzureBlob Component)
The location of the local file.
Syntax
property LocalFile: String read get_LocalFile write set_LocalFile;
Default Value
''
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; and as the destination file when calling GetBlob.
Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.
LocalHost Property (AzureBlob Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
property LocalHost: String read get_LocalHost write set_LocalHost;
Default Value
''
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Metadata Property (AzureBlob Component)
A collection of metadata items.
Syntax
property Metadata: TcsAzureMetadataList read get_Metadata write set_Metadata;
Remarks
This collection holds a list of AzureMetadata items.
This collection is populated when GetBlobInfo or GetContainerInfo is called; and its items are used anytime UpdateMetadata is called. Additionally, its items may be used when CreateBlob, CreateSnapshot, CopyBlob, and/or PutBlockList are called, depending on how the various SendMetadata* configuration settings are set.
This property is not available at design time.
Please refer to the AzureMetadata type for a complete list of fields.OAuth Property (AzureBlob Component)
This property holds the OAuth Settings.
Syntax
property OAuth: TcsOAuthSettings read get_OAuth;
Remarks
This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.
This property is read-only and not available at design time.
Please refer to the OAuthSettings type for a complete list of fields.OtherHeaders Property (AzureBlob Component)
This property includes other headers as determined by the user (optional).
Syntax
property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders;
Default Value
''
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ('#13#10') .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the component beyond what is provided.
This property is not available at design time.
Overwrite Property (AzureBlob Component)
Whether to overwrite the local file, or remote blob.
Syntax
property Overwrite: Boolean read get_Overwrite write set_Overwrite;
Default Value
false
Remarks
When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.
When calling CreateBlob or CopyBlob, this property determines if the remote blob should be overwritten if it already exists.
PageRanges Property (AzureBlob Component)
A collection of page range items.
Syntax
property PageRanges: TcsAzureRangeList read get_PageRanges;
Remarks
This collection holds a list of AzureRange items.
This collection is populated when ListPageRanges is called.
This property is read-only and not available at design time.
Please refer to the AzureRange type for a complete list of fields.ParsedHeaders Property (AzureBlob Component)
This property includes a collection of headers returned from the last request.
Syntax
property ParsedHeaders: TcsHeaderList read get_ParsedHeaders;
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.Prefix Property (AzureBlob Component)
A prefix used to restrict the results returned when listing blobs or containers.
Syntax
property Prefix: String read get_Prefix write set_Prefix;
Default Value
''
Remarks
This property, if non-empty, is used to restrict the results returned by ListBlobs or ListContainers to only the items whose names begin with the given value.
Blob Namespace Traversal
By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:
Prefix Value | Blobs Returned | Prefixes Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
This property is not available at design time.
Proxy Property (AzureBlob Component)
A set of properties related to proxy access.
Syntax
property Proxy: TcsProxy read get_Proxy write set_Proxy;
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.QueryParams Property (AzureBlob Component)
Additional query parameters to be included in the request.
Syntax
property QueryParams: TcsQueryParamList read get_QueryParams write set_QueryParams;
Remarks
This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.
Please refer to the QueryParam type for a complete list of fields.Range Property (AzureBlob Component)
The range of bytes to request.
Syntax
property Range: String read get_Range write set_Range;
Default Value
''
Remarks
This property specifies the range of bytes to request from the server. If this property is non-empty when a GetBlob or ListPageRanges request is being constructed, a header like x-ms-range: bytes=Range will be added to the request, with Range substituted with the specified value.
There are two valid formats for this property's value:
- StartByte-
- StartByte-EndByte
Note: If the StartByte property is greater than zero when GetBlob is called (i.e., when a download is being resumed), and this property is non-empty, the component will automatically advance the StartByte value in the specified range by StartByte bytes when sending the x-ms-range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.
This property is not available at design time.
Snapshot Property (AzureBlob Component)
The blob snapshot to make requests against.
Syntax
property Snapshot: String read get_Snapshot write set_Snapshot;
Default Value
''
Remarks
This property can be set to the opaque DateTime value used to identify a particular blob snapshot before calling the following methods in order to make requests against the specified blob snapshot instead of the base blob:
- CopyBlob (to copy from a blob snapshot)
- DeleteBlob
- GetBlob
- GetBlobInfo
- GetLink (to build a link for a specific blob snapshot)
- ListPageRanges
- SendCustomRequest
Refer to the documentation of the methods listed above for more information.
This property is not available at design time.
SSLAcceptServerCert Property (AzureBlob Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
property SSLAcceptServerCert: TcsCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (AzureBlob Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
property SSLCert: TcsCertificate read get_SSLCert write set_SSLCert;
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (AzureBlob Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
property SSLProvider: TcsTSSLProviders read get_SSLProvider write set_SSLProvider;
TcsTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal );
Default Value
sslpAutomatic
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
SSLServerCert Property (AzureBlob Component)
This property includes the server certificate for the last established connection.
Syntax
property SSLServerCert: TcsCertificate read get_SSLServerCert;
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.StartByte Property (AzureBlob Component)
The byte offset from which to resume the upload or download.
Syntax
property StartByte: Int64 read get_StartByte write set_StartByte;
Default Value
0
Remarks
This property specifies the byte offset from which to resume a block blob upload using CreateBlob, or a download of any blob type using GetBlob. Refer to those methods' documentation for more information about resuming uploads and downloads.
When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when CreateBlob is called. Keep this in mind when resuming interrupted block blob uploads.
This property is not available at design time.
Timeout Property (AzureBlob Component)
This property includes the timeout for the component.
Syntax
property Timeout: Integer read get_Timeout write set_Timeout;
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the component raises an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
UseSSL Property (AzureBlob Component)
Whether to use SSL/TLS when connecting.
Syntax
property UseSSL: Boolean read get_UseSSL write set_UseSSL;
Default Value
true
Remarks
This property specifies whether the component should use SSL/TLS when connecting.
This property is not available at design time.
AbortCopy Method (AzureBlob Component)
Aborts a copy operation.
Syntax
procedure AbortCopy(DestBlob: String; CopyId: String);
Remarks
This method aborts the copy operation identified by the given CopyId for the destination blob DestBlob in the container currently selected by Container.
Note that the destination blob will still exist after aborting a copy operation, but it will be empty.
AddBlock Method (AzureBlob Component)
Adds a block to the Blocks properties.
Syntax
procedure AddBlock(Id: String; BlockListType: Integer);
Remarks
This method adds a block to the Blocks properties. Id specifies the block's Id, and BlockListType specifies where the server should search for this block.
Block Ids must be Base64-encoded when sent to the server. By default, the component will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.
All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.
Valid values for BlockListType are:
Value | Meaning During PutBlockList Operations |
abktCommitted (0) | Search for a committed block with the specified Id. |
abktUncommitted (1) | Search for an uncommitted block with the specified Id. |
abktLatest (2) | Search for an uncommitted block with the specified Id; and then, if one isn't found, search for a committed block. |
AddMetadata Method (AzureBlob Component)
Adds a metadata item to the Metadata properties.
Syntax
procedure AddMetadata(Name: String; Value: String);
Remarks
This method adds a metadata item to the Metadata properties. Name specifies the name of the item, and Value specifies the value of the item.
Note that the component will automatically prepend x-ms-meta- to metadata item names (as necessary) when they are submitted to the server. Also note that while metadata item names are case-preserving, they are not case-sensitive.
AddQueryParam Method (AzureBlob Component)
Adds a query parameter to the QueryParams properties.
Syntax
procedure AddQueryParam(Name: String; Value: String);
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.
AppendBlock Method (AzureBlob Component)
Appends a block of data to an append blob.
Syntax
procedure AppendBlock(AppendBlob: String);
Remarks
This method appends a block of data to the specified AppendBlob in the container currently selected by Container. The block of data is immediately available as part of the append blob, which must already exist.
Up to 100MB (104857600 bytes) of data may be appended in a single block, and up to 50000 blocks may be appended to a single append blob.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
Authorize Method (AzureBlob Component)
Get the authorization string required to access the protected resource.
Syntax
procedure Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile property and the GrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
CalcAuthorization Method (AzureBlob Component)
Calculates the Authorization header based on provided credentials.
Syntax
procedure CalcAuthorization();
Remarks
This method calculates the Authorization value using the values provided in AuthScheme, User and Password.
In most cases this method does not need to be called. The component will automatically calculate any required authorization values when a method is called such as Get or Post.
This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.
ClearPages Method (AzureBlob Component)
Clears a range of pages in a page blob.
Syntax
procedure ClearPages(PageBlob: String; ByteOffset: Int64; PageCount: Int64);
Remarks
This method clears PageCount pages, from ByteOffset onwards, for the specified PageBlob in the container currently selected by Container.
ByteOffset must be a multiple of 512; i.e. ByteOffset % 512 == 0. PageCount must be a number between 1 and the number of pages in the page blob following ByteOffset (inclusive).
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
Config Method (AzureBlob Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): String;
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CopyBlob Method (AzureBlob Component)
Copies a blob.
Syntax
function CopyBlob(SrcBlob: String; DestBlob: String; DestContainer: String): String;
Remarks
This method copies the specified SrcBlob (in the container currently selected by Container) to the specified DestBlob in DestContainer. If this method finishes successfully, it will either return an asynchronous copy Id, or an empty string (if the copy has finished already).
If Snapshot is non-empty, the specified snapshot of SrcBlob will be used as the copy source. In this case, DestBlob may be the same blob as SrcBlob to "promote" the snapshot, copying its contents back to the base blob.
If DestContainer is empty, the current value of Container is used instead. If DestContainer in non-empty, the value will automatically be lowercased when preparing the request.
If DestBlob already exists, and is the same type of blob as SrcBlob, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.
If DestBlob already exists and has an active infinite-duration lease, its lease Id must be specified using LeaseId, or the request will fail. (If it exists and has an active fixed-duration lease, the request will always fail.)
If the SendMetadataOnCopy configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the copy request and applied to DestBlob. Otherwise, the server will copy the metadata items from SrcBlob to DestBlob.
If the request succeeds, this method will always populate the CopyId and CopyStatus configuration settings (and clear CopyProgress and CopyStatusDesc).
Asynchronous Copy Notes
As mentioned, this method will return a copy operation Id if the copy operation was started asynchronously. In this case, use the GetBlobInfo method to poll the DestBlob blob's information, which will cause the CopyStatus, CopyStatusDesc, and CopyProgress configuration settings to be refreshed.
A copy operation whose CopyStatus is still pending may also be aborted by passing the copy operation Id returned by this method (or later retrieved from CopyId) to the AbortCopy method.
// Copy a blob to another location within the same container.
string copyResult = azureblob.CopyBlob("important.zip", "secrets.zip", "");
// If the returned value *isn't* empty string, then we'll monitor the status of the
// asynchronous copy operation by polling once every 2 seconds using GetBlobInfo().
if (!string.IsNullOrEmpty(copyResult)) {
do {
azureblob.GetBlobInfo("secrets.zip");
Console.WriteLine("Copy progress: " + azureblob.Config("CopyProgress"));
} while (azureblob.Config("CopyStatus") == "pending");
}
CreateBlob Method (AzureBlob Component)
Creates a new blob of the specified type.
Syntax
procedure CreateBlob(Blob: String; BlobType: Integer; PageBlobSize: Int64);
Remarks
This method creates a new blob named Blob in the container currently selected by Container. BlobType specifies what type of blob should be created; valid values are: Possible values are:
abtBlockBlob (0) | Block blob |
abtPageBlob (1) | Page blob |
abtAppendBlob (2) | Append blob |
Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.
PageBlobSize is only used when BlobType is abtPageBlob (1); it is ignored otherwise.
If the specified blob already exists, and is the same type of blob as BlobType specifies, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.
If the specified blob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
Creating Block Blobs
Block blobs can be created either with or without data initially. In either case, after the block blob is created, its contents can be managed by uploading blocks with PutBlock and then committing a new block list using PutBlockList.
If upload data is present when this method is called to create a block blob, it will be uploaded in one of two ways. If the amount of data provided is less than or equal to the limit specified by the SimpleUploadLimit configuration setting (268435456 bytes (256MB), by default), it will be uploaded directly in the create blob request.
If more than SimpleUploadLimit bytes of data are provided, the component will first create the new block blob, and then upload the data by splitting it up into blocks (sized according to the FragmentSize configuration setting), uploading them individually, and then committing a new block list. To accomplish this, the component automatically makes calls to PutBlock and PutBlockList internally, tracks the blocks as they are uploaded using the Blocks properties, and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each block is uploaded.
If, during a block-based upload, any individual PutBlock request (or the PutBlockList request) fails, the upload can be resumed be calling this method again with the same parameters, so long as the Blocks and StartByte properties still hold the same information as they did when the upload was interrupted.
When a block-based upload completes successfully, StartByte is reset to 0, but the Blocks properties remains populated. This allows applications to easily inspect the Ids of the uploaded blocks, which the component generates automatically in the following GUID format: dddddddd-dddd-dddd-dddd-dddddddddddd (where each d is a single hex digit).
Creating Page Blobs
Unlike block blobs, no data can be uploaded when creating a page blob. However, the page blob's size (i.e., capacity) must be specified using PageBlobSize. A page blob's size must be a 512-byte-aligned; i.e. PageBlobSize % 512 == 0.
Once a page blob has been created, its contents can be manipulated using the PutPages and ClearPages methods.
Creating Append Blobs
Append blobs must also be created without uploading any data initially. After a page blob has been created, data can be appended to it using the AppendBlock method.
CreateContainer Method (AzureBlob Component)
Creates a new container.
Syntax
procedure CreateContainer();
Remarks
This method creates a new container using the name specified by the Container property;
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
Container Name Rules
Container names must adhere to the following rules:
- Must be 3 to 63 characters long.
- Must start with a letter or number; and may only contain letters, numbers, and hyphens.
- All letters much be lowercase. (For convenience, the component will automatically lowercase all letters in any value assigned to Container.)
- All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).
CreateSnapshot Method (AzureBlob Component)
Creates a new snapshot of a blob.
Syntax
function CreateSnapshot(Blob: String): String;
Remarks
This method creates a new snapshot of the specified Blob in the container currently selected by Container, and returns the opaque DateTime value used to identify the newly-created snapshot.
If the SendMetadataOnSnapshot configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the request and applied to newly-created snapshot. Otherwise, the server will copy the metadata items from Blob to the snapshot.
If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
DeleteBlob Method (AzureBlob Component)
Deletes a blob.
Syntax
procedure DeleteBlob(Blob: String; DeleteAction: Integer);
Remarks
This method deletes the specified Blob in the container currently selected by Container. DeleteAction specifies how the delete operation should be handled; possible values are:
Single (0) | Only delete the specified blob. The request will fail if any snapshots of the blob exist. |
Snapshots Only (1) | Delete all of the specified blob's snapshots, but not the blob itself. |
Everything (2) | Delete the specified blob and all of its snapshots. |
Alternatively, if Snapshot is non-empty, the specified snapshot of Blob is deleted, and DeleteAction is ignored.
If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete blobs (and snapshots). Soft-deleted blobs and snapshots can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListBlobs, and can be undeleted at any point before their retention period expires by calling UndeleteBlob. This method can alternatively permanently delete blobs and snapshots by enabling the DeletePermanently configuration setting.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
DeleteContainer Method (AzureBlob Component)
Deletes a container.
Syntax
procedure DeleteContainer();
Remarks
This method deletes the container currently selected by Container. Note that, according to the Azure documentation, when a container is deleted its name cannot be reused for at least 30 seconds.
If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete containers. Soft-deleted containers can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListContainers, and can be undeleted at any point before their retention period expires by calling UndeleteContainer.
If the specified container has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
GetBlob Method (AzureBlob Component)
Downloads a blob.
Syntax
procedure GetBlob(Blob: String);
Remarks
This methods downloads the specified Blob in the container currently selected by Container. If Snapshot is non-empty, the specified snapshot of Blob is downloaded instead. The Range property can be used to download a specific range of bytes from the blob.
If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
If a stream has been specified using SetDownloadStream, the blob data will be sent through it. If a stream is not specified, and LocalFile is set, the blob data will be saved to the specified location; otherwise, the blob data will be held by ResourceData.
To download and decrypt an encrypted blob, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a blob looks like this:
azureblob.LocalFile = "../MyData.zip";
azureblob.GetBlob(azureblob.Blobs[0].Name);
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyData.zip";
azureblob.LocalFile = downloadFile;
azureblob.GetBlob(azureblob.Blobs[0].Name);
//The transfer is interrupted and GetBlob() above fails. Later, resume the download:
//Get the size of the partially downloaded file
azureblob.StartByte = new FileInfo(downloadFile).Length;
azureblob.GetBlob(azureblob.Blobs[0].Name);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
azureblob.LocalFile = "../MyData.zip";
azureblob.EncryptionPassword = "password";
azureblob.GetBlob(azureblob.Blobs[0].Name);
//The transfer is interrupted and GetBlob() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
azureblob.StartByte = new FileInfo(azureblob.Config("DownloadTempFile")).Length;
azureblob.GetBlob(azureblob.Blobs[0].Name);
GetBlobInfo Method (AzureBlob Component)
Gets a blob's information and metadata.
Syntax
procedure GetBlobInfo(Blob: String);
Remarks
This method gets information and metadata for the specified Blob in the container currently selected by Container. If Snapshot is non-empty, information and metadata for the specified snapshot of Blob is retrieved instead.
Calling this method will fire the BlobList and MetadataList events, and will re-populate the Blobs and Metadata collection properties.
If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
GetContainerACL Method (AzureBlob Component)
Gets the stored access policies and public access level for a container.
Syntax
function GetContainerACL(): Integer;
Remarks
This method retrieves the stored access policies and the public access level for the container currently selected by Container. The stored access policies are used to populate the AccessPolicies properties, and the public access level is returned directly. Possible values are:
acpaNone (0) | The container is private. |
acpaBlobs (1) | Blob data within the container is publicly readable, but blobs cannot be listed. |
acpaContainer (2) | Container information and blob data within the container is publicly readable, and blobs can be listed. |
If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
GetContainerInfo Method (AzureBlob Component)
Gets a container's information and metadata.
Syntax
procedure GetContainerInfo();
Remarks
This method gets information and metadata for the container currently selected by Container.
Calling this method will fire the ContainerList and MetadataList events, and will re-populate the Containers and Metadata collection properties.
If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
GetLink Method (AzureBlob Component)
Creates a link that provides access to a container, blob, or snapshot.
Syntax
function GetLink(Blob: String; Permissions: String; StartTime: String; ExpiryTime: String): String;
Remarks
This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific container, blob, or snapshot. The following table indicates which inputs must be provided to produce a link of the desired type:
Link Type | Required Inputs |
Container | Non-empty Container, empty Blob, any Snapshot (ignored) |
Blob | Non-empty Container and Blob, empty Snapshot |
Snapshot | Non-empty Container, Blob, and Snapshot |
Permissions specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format this value.
StartTime and ExpiryTime specify the UTC start and end times of the SAS's validity interval. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format these values.
StartTime may be empty, in which case the server will assume that the link is valid immediately. Permissions and ExpiryTime must both be non-empty, unless an si query parameter that references a stored access policy (which has corresponding non-empty values) is present in the QueryParams properties.
If any of the query parameters listed below are present in the QueryParams properties when this method is called, they will be included when creating the SAS. All other application-specified query parameters are ignored.
- Response headers: rscc, rscd, rsce, rscl, rsct
- IP address (single or range): sip
- Allowed HTTP protocol(s): spr
- Stored access policy ("signed identifier"): si
For more information about SAS links, refer to Azure's Create a Service SAS article.
GetUserDelegationKey Method (AzureBlob Component)
Requests a new user delegation key.
Syntax
procedure GetUserDelegationKey(StartTime: String; ExpiryTime: String);
Remarks
This method requests a new user delegation key and populates UserDelegationKey with the returned information.
NOTE: This method is not currently implemented; it is reserved for future use.
Interrupt Method (AzureBlob Component)
This method interrupts the current method.
Syntax
procedure Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Lease Method (AzureBlob Component)
Creates or manages a lease on a blob or container.
Syntax
procedure Lease(Blob: String; LeaseAction: Integer; NewLeaseId: String; Duration: Integer);
Remarks
This method creates or manages a lease on the container currently selected by Container (if Blob is empty), or on the specified Blob in that container.
LeaseAction specifies what action should occur. Possible values, and their effects, are:
- Acquire (0): Requests a new lease.
- If no active lease currently exists, a new one is created and LeaseId is populated with the new lease's Id. If a non-empty value is passed for NewLeaseId, it is used; otherwise the server generates an Id.
- If an active lease currently exists, its Id must be passed for NewLeaseId.
- In either case, Duration is used to specify the length of time that the lease is valid for (see below).
- Renew (1): Renews the lease specified by LeaseId.
- Leases can only be renewed while active or expired (and in the latter case, only if a different lease has not been acquired in the meantime).
- Renewing an active lease will reset its expiration clock.
- Change (2): Changes the Id of the active lease specified by LeaseId to the one specified by NewLeaseId.
- If this action is successful, the component will automatically set LeaseId to the value passed for NewLeaseId.
- Release (3): Releases the lease specified by LeaseId.
- If this action is successful, the component will automatically clear LeaseId.
- Break (4): Breaks the current lease, either immediately or after a certain period of time (the "break period") according to the value passed for Duration.
- The lease's Id is not required to break the lease.
- If Duration is -1, fixed-length leases are broken after their remaining time elapses, and infinite-length leases are broken immediately.
- Otherwise, Duration specified how many seconds (see below) the lease should continue before being broken. (For fixed-length leases, the lesser of this value and the lease's remaining time is used.)
- If this action is successful, the LeaseBreakPeriod configuration setting is populated to indicate how long the lease's break period is.
If NewLeaseId is non-empty, if must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.
The value passed for Duration is only used in the cases listed below; it is ignored otherwise.
- When LeaseAction is Acquire (0): Valid values for Duration are -1 (infinite), or a number of seconds between 15 and 60 (inclusive).
- When LeaseAction is Break (4): Valid values for Duration are -1 (unspecified), or a number of seconds between 0 and 60 (inclusive). 0 indicates the lease should be broken immediately, regardless of whether it is fixed- or infinite-length.
For more information about how leases work, refer to Azure's Lease Blob and Lease Container API documentation.
ListBlobs Method (AzureBlob Component)
Lists the blobs in a container.
Syntax
procedure ListBlobs();
Remarks
This method lists the blobs in the container currently selected by Container.
Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The following properties and configuration settings can also be used to further tune the results returned; refer to their documentation for more information:
Calling this method will fire the BlobList event once for each blob, and will also populate the Blobs properties. It may also fire the PrefixList and MetadataList events, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties and configuration settings discussed above are set.
If there are still more blobs available to list when this method returns, the BlobMarker property will be populated. Continue to call this method until BlobMarker is empty to accumulate all pages of results in the Blobs properties.
Blob Namespace Traversal
By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:
Prefix Value | Blobs Returned | Prefixes Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
ListBlocks Method (AzureBlob Component)
Lists the blocks associated with a block blob.
Syntax
procedure ListBlocks(BlockBlob: String; BlockListType: Integer);
Remarks
This method lists the blocks associated with the specified BlockBlob in the container currently selected by Container. BlockListType indicates which block list(s) the server should return results from; possible values are:
Committed (0) | Only committed blocks are listed. The blocks are returned in the same order that they were committed in by the most recent PutBlockList operation. |
Uncommitted (1) | Only uncommitted blocks are listed. The blocks are returned in alphabetical order by Id. |
All (2) | Both committed and uncommitted blocks are listed. The committed blocks are returned before the uncommitted blocks. |
Alternatively, if Snapshot is non-empty, the committed blocks for the specified snapshot of BlockBlob are listed instead (and BlockListType is ignored).
Calling this method will fire the BlockList event once for each block, and will also repopulate the Blocks properties.
ListContainers Method (AzureBlob Component)
Lists the containers in the blob storage account.
Syntax
procedure ListContainers();
Remarks
This method lists the containers in the Azure blob storage account specified by the Account property.
Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The ListWithMetadata and IncludeSoftDeleted configuration settings can also be used to further tune the results returned.
Calling this method will fire the ContainerList event once for each container, and will also populate the Containers properties. It may also fire the MetadataList event, depending on how the ListWithMetadata setting is configured.
If there are still more containers available to list when this method returns, the ContainerMarker property will be populated. Continue to call this method until ContainerMarker is empty to accumulate all pages of results in the Containers properties.
ListPageRanges Method (AzureBlob Component)
Lists the page ranges of a page blob.
Syntax
procedure ListPageRanges(PageBlob: String);
Remarks
This method lists the allocated page ranges of the specified PageBlob in the container currently selected by Container. If Snapshot is non-empty, the allocated page ranges for the specified snapshot of PageBlob are listed instead.
The Range property can be used to restrict the results to only the page ranges within the specified range.
Calling this method will repopulate the PageRanges properties. Every page in a page blob is exactly 512 bytes in length; thus, the size of every range returned by this method will always be a multiple of 512.
Normally, ranges of pages that are not currently allocated (either because no data has been written to them, or because they've been cleared with ClearPages) will not be returned by this method. However, setting the PreviousSnapshot configuration setting to a non-empty value will cause the server to return a list of all pages that differ between that snapshot and the base PageBlob (or the later snapshot of PageBlob specified by Snapshot); refer to PreviousSnapshot for more information.
If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
PutBlock Method (AzureBlob Component)
Uploads a new block of data to a block blob.
Syntax
function PutBlock(BlockBlob: String; BlockId: String): String;
Remarks
This method uploads a new block of data with the given BlockId to the specified BlockBlob in the container currently selected by Container. The block of data is uploaded in an uncommitted state; it will not be available as part of the block blob until it is committed in a PutBlockList operation.
The Base64-encoded Id of the block is returned (if the EncodeBlockIds configuration setting is disabled, the same value as passed for BlockId is returned; see below for more information).
If the specified BlockBlob does not yet exist, it is created in an uncommitted state. If an uncommitted block with the specified BlockId is already associated with the specified BlockBlob, it is replaced.
Block Ids must be Base64-encoded when sent to the server. By default, the component will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.
All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.
Up to 100MB (104857600 bytes) of data may be uploaded in a single block, and up to 100000 uncommitted blocks may be associated with a block blob at any time.
If the block is successfully uploaded, the component will automatically call AddBlock to add an item to the Blocks properties. This behavior can be changed using the AutoAddBlocks configuration setting.
If BlockBlob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
PutBlockList Method (AzureBlob Component)
Commits a list of data blocks to a block blob.
Syntax
procedure PutBlockList(BlockBlob: String; BlockList: String);
Remarks
This method commits the blocks of data specified by the Blocks properties to the specified BlockBlob in the container currently selected by Container. Up to 50000 blocks may be committed to a single block blob at any time.
The BlockList parameter can optionally be passed a non-empty list of blocks to commit in order to repopulate the Blocks properties before building the request. This allows applications to build an entire block list and then commit it in a single call, rather than manipulating the Blocks properties directly, or calling AddBlock.
The value supplied should contain a comma-separated list of strings like {BlockListType}:{BlockId}, where {BlockListType} is either C, U, or L to specify whether the server should search for a block with the associated Id in BlockBlob's committed block list, uncommitted block list, or both (uncommitted; then committed, if necessary). If necessary, the BlockListStringSeparator configuration setting can be used to change the separator string used when parsing the value.
If BlockList is empty, the current items in the Blocks properties will remain unchanged.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
Note: By default, the component will automatically retrieve and re-submit the BlockBlob's current properties and metadata (if it exists) when this method is called, since Azure would clear them otherwise.
However, if one or more x-ms-blob-* headers are present in OtherHeaders when this method is called, the component will send them rather than re-submitting any of the retrieved blob properties. Similarly, if the SendMetadataOnPutBlockList configuration setting is enabled, the component will send the metadata items currently present in the Metadata properties instead of those retrieved from the server.
PutPages Method (AzureBlob Component)
Uploads a range of pages to a page blob.
Syntax
procedure PutPages(PageBlob: String; WriteOffset: Int64);
Remarks
This method uploads a range of pages to the specified PageBlob in the container currently selected by Container, starting at the byte offset specified by WriteOffset. The uploaded data is immediately available as part of the page blob, which must already exist.
The upload data's size, in bytes, must be a multiple of 512 no larger than 4MB (4194304 bytes). The value passed for WriteOffset must also be a multiple of 512; WriteOffset % == 0.
Note that writing a page full of zeros will not actually clear said page, so it will still incur data storage charges. It is recommended that applications avoid writing pages that only contain zeros, or clear such pages using the ClearPages method.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
Reset Method (AzureBlob Component)
Resets the component to its initial state.
Syntax
procedure Reset();
Remarks
This method resets the component to its initial state.
SendCustomRequest Method (AzureBlob Component)
Sends a custom request to the Azure Blob Storage service.
Syntax
procedure SendCustomRequest(HttpMethod: String; Blob: String; RequestBody: String);
Remarks
This method can be used to send arbitrary requests to the Azure Blob Storage service.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The Blob and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the component does the following:
- Builds a request URL, including query parameters, using the following:
- UseSSL
- Account (must be non-empty)
- Container (if non-empty)
- Blob (if non-empty)
- Snapshot (if both it and Blob are non-empty)
- QueryParams
- Adds request headers from:
- APIVersion
- LeaseId (if non-empty)
- IfMatch (if non-empty)
- OtherHeaders
- Authenticates the request using Authorization (if non-empty), or AccessKey (in which case the request is signed).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeaders properties; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or BlobData (using the same logic as GetBlob).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
SetContainerACL Method (AzureBlob Component)
Sets the stored access policies and public access level for a container.
Syntax
procedure SetContainerACL(PublicAccess: Integer);
Remarks
This method sets the stored access policies and the public access level for the container currently specified by Container. The items in the AccessPolicies properties determine the new set of stored access policies, and PublicAccess determines the new public access level. Possible values are:
acpaNone (0) | The container is private. |
acpaBlobs (1) | Blob data within the container is publicly readable, but blobs cannot be listed. |
acpaContainer (2) | Container information and blob data within the container is publicly readable, and blobs can be listed. |
Note that it is not possible to do a partial update of stored access policies. That is, all stored access policies currently associated with the container will be replaced with the stored access policies sent in the request. To prevent data loss, applications should call GetContainerACL to retrieve the container's current stored access polices, and then add/modify/remove them as desired, before using this method.
If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.
SetDownloadStream Method (AzureBlob Component)
Sets the stream to which downloaded data will be written.
Syntax
procedure SetDownloadStream(DownloadStream: TStream);
Remarks
If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
SetUploadStream Method (AzureBlob Component)
Sets the stream from which data is read when uploading.
Syntax
procedure SetUploadStream(UploadStream: TStream);
Remarks
If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.
Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
UndeleteBlob Method (AzureBlob Component)
Undeletes a soft-deleted blob.
Syntax
procedure UndeleteBlob(Blob: String);
Remarks
This method undeletes the specified soft-deleted Blob in the container currently selected by Container. If any soft-deleted snapshots are associated with the specified blob, they are also undeleted (note that this also works if the blob itself has not been soft-deleted).
Refer to DeleteBlob for more information about soft-deleting blobs.
UndeleteContainer Method (AzureBlob Component)
Undeletes a soft-deleted container.
Syntax
procedure UndeleteContainer(Container: String; DeletedVersion: String);
Remarks
This method undeletes the specified soft-deleted Container with the supplied DeletedVersion. If any soft-deleted blobs and snapshots are associated with the specified container, they are also undeleted, but note that soft-deleted blobs can only be restored in this manner if the container itself was also deleted.
Refer to DeleteContainer for more information about soft-deleting containers.
UpdateBlobInfo Method (AzureBlob Component)
Updates a blob's information.
Syntax
procedure UpdateBlobInfo(Blob: String);
Remarks
This method updates the information of the specified Blob in the container currently selected by Container.
There must be an AzureBlobBlob properties whose Name property matches the specified Blob name (and whose Snapshot property is empty) before this method is called.
When this method is called, the values of the following propertys on the aforementioned item are sent to the server (note that the last two are indexed configuration settings):
Note that it is not possible to do a partial update of a blob's information. That is, all of the blob's current values for the aforementioned propertys will be replaced with the values sent in the request. To prevent data loss, applications should call GetBlobInfo to retrieve the blob's current information, and then modify it as desired, before using this method.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
UpdateMetadata Method (AzureBlob Component)
Sets the metadata for a blob or container.
Syntax
procedure UpdateMetadata(Blob: String);
Remarks
This method sets the metadata for the container currently selected by Container (if Blob is empty), or for the specified Blob in that container, to the items currently held by the Metadata properties.
Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the blob or container will be replaced with the metadata sent in the request. To prevent data loss, applications should call GetBlobInfo or GetContainerInfo to retrieve the blob or container's current metadata, and then modify it as desired, before using this method.
When setting the metadata of a container that has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified. When setting the metadata of a blob that has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
UpdatePageBlob Method (AzureBlob Component)
Updates a page blob's size and/or sequence number.
Syntax
procedure UpdatePageBlob(PageBlob: String; NewSize: Int64; SequenceNumAction: Integer; NewSequenceNum: Int64);
Remarks
This method updates the size and/or sequence number of the specified PageBlob in the container currently selected by Container.
NewSize must either be -1 (to keep the page blob's current size), or a multiple of 512; i.e. NewSize % 512 == 0. If NewSize is less than the page blob's current size, all pages above the specified value are cleared.
SequenceNumAction determines how the page blob's sequence number should be changed; possible values are:
None (0) | The page blob's sequence number remains unchanged. NewSequenceNum is ignored. |
Increment (1) | The page blob's sequence number is incremented by 1. NewSequenceNum is ignored. |
Update (2) | The page blob's sequence number is set to NewSequenceNum. |
Use Greater (3) | The page blob's sequence number is set to the greater of NewSequenceNum and the current sequence number. |
In cases where NewSequenceNum is used, it must be a value in the range 0 to 2^63 - 1, inclusive.
If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.
BlobList Event (AzureBlob Component)
Fires once for each blob returned when listing blobs.
Syntax
type TBlobListEvent = procedure ( Sender: TObject; const Name: String; const Container: String; BlobType: Integer; const Snapshot: String; ContentLength: Int64; const ContentType: String; const CreatedTime: String; const ModifiedTime: String; const ETag: String; SoftDeleted: Boolean; IsLeased: Boolean; LeaseState: Integer ) of Object;
property OnBlobList: TBlobListEvent read FOnBlobList write FOnBlobList;
Remarks
This event fires once for each blob returned when ListBlobs or GetBlobInfo is called.
Name is the name of the blob.
Container is the name of the blob's container.
BlobType is the blob's type. Possible values are:
abtBlockBlob (0) | Block blob |
abtPageBlob (1) | Page blob |
abtAppendBlob (2) | Append blob |
Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.
Snapshot is the snapshot identifier, if the current item represents a blob snapshot; empty otherwise.
ContentLength is the size of the blob's committed data in bytes, for block blobs and append blobs. For page blobs, its the capacity in bytes.
ContentType is the blob's content type. Always empty for uncommitted block blobs.
CreatedTime and ModifiedTime reflect the creation and last modified times of the blob, formatted according to RFC 1123. The latter is always empty for uncommitted block blobs.
ETag is the blob's ETag. Always empty for uncommitted block blobs.
SoftDeleted indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.
IsLeased indicates whether the blob is currently leased. Always False if SoftDeleted is True and/or Snapshot is non-empty.
LeaseState reflects the lease state of the blob. Possible values are:
ablsAvailable (0) | The blob's lease is unlocked and can be acquired. |
ablsLeased (1) | The blob's lease is locked. |
ablsExpired (2) | The lease duration has expired. |
ablsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
ablsBroken (4) | The lease has been broken, and the break period has expired. |
BlockList Event (AzureBlob Component)
Fires once for each block returned when listing blocks.
Syntax
type TBlockListEvent = procedure ( Sender: TObject; const Id: String; BlockType: Integer; Size: Integer ) of Object;
property OnBlockList: TBlockListEvent read FOnBlockList write FOnBlockList;
Remarks
This event fires once for each block returned when ListBlocks is called.
Id is the Id of the block.
BlockType reflects the block's type; possible values are:
- abktCommitted (0)
- abktUncommitted (1)
Size reflects the size of the block, in bytes.
ContainerList Event (AzureBlob Component)
Fires once for each container returned when listing containers.
Syntax
type TContainerListEvent = procedure ( Sender: TObject; const Name: String; const ModifiedTime: String; const ETag: String; IsLeased: Boolean; LeaseState: Integer ) of Object;
property OnContainerList: TContainerListEvent read FOnContainerList write FOnContainerList;
Remarks
This event fires once for each container returned when ListContainers or GetContainerInfo is called.
Name is the name of the container.
ModifiedTime reflects the last modified time of the container, formatted according to RFC 1123.
ETag is the container's ETag.
IsLeased indicates whether the container is currently leased.
LeaseState reflects the lease state of the container. Possible values are:
aclsAvailable (0) | The container's lease is unlocked and can be acquired. |
aclsLeased (1) | The container's lease is locked. |
aclsExpired (2) | The lease duration has expired. |
aclsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
aclsBroken (4) | The lease has been broken, and the break period has expired. |
EndTransfer Event (AzureBlob Component)
This event fires when a document finishes transferring.
Syntax
type TEndTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object;
property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer;
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (AzureBlob Component)
Fired when information is available about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FragmentComplete Event (AzureBlob Component)
Fires after each block in an automatic block-based upload is complete.
Syntax
type TFragmentCompleteEvent = procedure ( Sender: TObject; FragmentNumber: Integer; FragmentCount: Integer; var Interrupt: Boolean ) of Object;
property OnFragmentComplete: TFragmentCompleteEvent read FOnFragmentComplete write FOnFragmentComplete;
Remarks
When CreateBlob is used to create a new block blob, and more than SimpleUploadLimit bytes of upload data is provided, the component will automatically split the upload data up into blocks to perform the upload. During the overall upload process, this event will fire after each block is uploaded, providing an indication of overall upload progress.
FragmentNumber is the number of the current block that has completed. This value starts at 1.
FragmentCount is the total number of blocks that will be uploaded.
Interrupt can be set to True to interrupt the upload. The upload may be resumed later.
Refer to CreateBlob for more information.
Header Event (AzureBlob Component)
This event is fired every time a header line comes in.
Syntax
type THeaderEvent = procedure ( Sender: TObject; const Field: String; const Value: String ) of Object;
property OnHeader: THeaderEvent read FOnHeader write FOnHeader;
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains '' (empty string).
Log Event (AzureBlob Component)
This event fires once for each log message.
Syntax
type TLogEvent = procedure ( Sender: TObject; LogLevel: Integer; const Message: String; const LogType: String ) of Object;
property OnLog: TLogEvent read FOnLog write FOnLog;
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MetadataList Event (AzureBlob Component)
Fires once for each metadata item returned when listing metadata.
Syntax
type TMetadataListEvent = procedure ( Sender: TObject; const Container: String; const Blob: String; const Snapshot: String; const Name: String; const Value: String ) of Object;
property OnMetadataList: TMetadataListEvent read FOnMetadataList write FOnMetadataList;
Remarks
This event fires once for each metadata item returned when GetBlobInfo or GetContainerInfo is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual blob or container is returned when ListBlobs or ListContainers is called.
Container is the name of the container that the blob is in (if Blob is non-empty), or that the metadata item is associated with (if Blob is empty).
Blob, if non-empty, is the name of the blob that the metadata item is associated with.
Snapshot, if non-empty, is the opaque DateTime value that identifiers the blob snapshot that the metadata item is associated with.
Name is the name of the metadata item, without the x-ms-meta- prefix.
Value the metadata item's value.
PrefixList Event (AzureBlob Component)
Fires once for each common prefix returned when listing blobs.
Syntax
type TPrefixListEvent = procedure ( Sender: TObject; const Prefix: String ) of Object;
property OnPrefixList: TPrefixListEvent read FOnPrefixList write FOnPrefixList;
Remarks
This event fires once for each common prefix returned when ListBlobs is called when BlobDelimiter is non-empty. Refer to BlobDelimiter for more information.
Prefix is the common prefix.
Progress Event (AzureBlob Component)
Fires during an upload or download to indicate transfer progress.
Syntax
type TProgressEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; TotalBytes: Int64; PercentDone: Integer ) of Object;
property OnProgress: TProgressEvent read FOnProgress write FOnProgress;
Remarks
This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.
For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.
This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.
SSLServerAuthentication Event (AzureBlob Component)
Fired after the server presents its certificate to the client.
Syntax
type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; const CertEncoded: String; CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object;
property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AzureBlob Component)
Fired when secure connection progress messages are available.
Syntax
type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object;
property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AzureBlob Component)
This event fires when a document starts transferring (after the headers).
Syntax
type TStartTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object;
property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer;
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (AzureBlob Component)
This event is fired while a document transfers (delivers document).
Syntax
type TTransferEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; PercentDone: Integer; const Text: String; TextB: TBytes ) of Object;
property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer;
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
AzureAccessPolicy Type
An Azure storage access policy.
Remarks
This type represents an Azure storage access policy.
Fields
ExpiryTime
String
Default Value: ""
The expiry time of the access policy.
This property specifies the UTC expiry time of the access policy, formatted according to this page in Azure's documentation.
This property can be empty if the access policy doesn't include an expiry time.
Id
String
Default Value: ""
The unique Id of the access policy.
This property specifies the unique Id of the access policy, which may be up to 64 characters in length.
Permissions
String
Default Value: ""
The permissions that the access policy grants.
This property specifies the permissions that the access policy grants, in the form of an abbreviated permissions list formatted according to this page in Azure's documentation.
This property can be empty if the access policy doesn't include any permissions.
StartTime
String
Default Value: ""
The start time of the access policy.
This property specifies the UTC start time of the access policy, formatted according to this page in Azure's documentation.
This property can be empty if the access policy doesn't include a start time.
Constructors
constructor Create();
constructor Create(valId: String; valPermissions: String; valStartTime: String; valExpiryTime: String);
AzureBlobBlob Type
An Azure storage blob.
Remarks
This type represents an Azure storage blob.
Fields
Container
String (read-only)
Default Value: ""
The container that the blob resides in.
This property reflects the name of the container that the blob resides in.
ContentDisposition
String
Default Value: ""
The blob's content disposition.
This property specifies the blob's content disposition.
ContentEncoding
String
Default Value: ""
The blob's content encoding.
This property specifies the blob's content encoding. Always empty for uncommitted block blobs.
ContentLength
Int64 (read-only)
Default Value: 0
The size of the blob.
For block blobs and append blobs, this property reflects the size of the blob's (committed) data, in bytes. For page blobs, this property reflects the blob's capacity in bytes.
ContentMD5
String
Default Value: ""
An MD5 hash of the blob's content.
This property specifies an MD5 hash of the blob's content. Always empty for uncommitted block blobs.
Note that the server generally won't calculate this value automatically.
ContentType
String
Default Value: ""
The blob's content type.
This property specifies the blob's content type. Always empty for uncommitted block blobs.
CreatedTime
String (read-only)
Default Value: ""
The creation time of the blob.
This property reflects the creation time of the blob, formatted according to RFC 1123.
ETag
String (read-only)
Default Value: ""
The ETag of the blob.
This property reflects the ETag of the blob. Always empty for uncommitted block blobs.
IsLeased
Boolean (read-only)
Default Value: False
Whether the blob is current leased.
This property indicates whether the blob is currently leased.
This property is always False if SoftDeleted is True and/or Snapshot is non-empty.
IsLeaseInfinite
Boolean (read-only)
Default Value: False
Whether the blob's lease duration is infinite.
This property indicates whether the blob's lease duration is fixed (False) or infinite (True).
This property is always False when IsLeased is False.
LeaseState
TcsAzureBlobLeaseStates (read-only)
Default Value: 0
The lease state of the blob.
This property reflects the lease state of the blob. Possible values are:
ablsAvailable (0) | The blob's lease is unlocked and can be acquired. |
ablsLeased (1) | The blob's lease is locked. |
ablsExpired (2) | The lease duration has expired. |
ablsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
ablsBroken (4) | The lease has been broken, and the break period has expired. |
This property is always ablsAvailable (0) when IsLeased is False.
ModifiedTime
String (read-only)
Default Value: ""
The last modified time of the blob.
This property reflects the last modified time of the blob, formatted according to RFC 1123. Always empty for uncommitted block blobs.
Name
String
Default Value: ""
The name of the blob.
This property specifies the name of the blob.
Note: Blobs cannot be renamed; this property is only writable so that applications can add new items to the Blobs properties for use with UpdateBlobInfo (which looks up items in said properties by blob name).
SequenceNum
Int64 (read-only)
Default Value: 0
The sequence number of the page blob.
This property reflects the sequence number of the page blob; it is always -1 for block blobs and append blobs.
Snapshot
String (read-only)
Default Value: ""
The blob snapshot identifier.
If the current item represents a blob snapshot, this property will be populated with the opaque DateTime value that identifies the snapshot. If the current items represents a base blob, this property will be empty.
SoftDeleted
Boolean (read-only)
Default Value: False
Whether the blob has been soft-deleted.
This property indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.
Type
TcsAzureBlobTypes (read-only)
Default Value: 0
The blob's type.
This property reflects the blob's type. Possible values are:
abtBlockBlob (0) | Block blob |
abtPageBlob (1) | Page blob |
abtAppendBlob (2) | Append blob |
Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.
Constructors
constructor Create();
AzureBlobBlock Type
An Azure storage block.
Remarks
This type represents an Azure storage block. Blocks are the chunks of data that comprise block blobs.
Fields
Id
String
Default Value: ""
The Id of the block.
This property specifies the Id of the block.
Block Ids must be Base64-encoded when sent to the server. By default, the component will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.
All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.
Size
Integer (read-only)
Default Value: -1
The size of the block.
This property reflects the size of the block, in bytes.
This property is only populated by calls to ListBlocks, and will be -1 in all other cases.
Type
TcsAzureBlockTypes
Default Value: 0
The type of block.
When populated by ListBlocks, this property reflects the block's type (one of the first two values listed below). When used during a PutBlockList operation, this property specifies which block list the server should search for the block Id specified by Id.
Possible values are:
Value | Meaning During PutBlockList Operations |
abktCommitted (0) | Search for a committed block with the specified Id. |
abktUncommitted (1) | Search for an uncommitted block with the specified Id. |
abktLatest (2) | Search for an uncommitted block with the specified Id; and then, if one isn't found, search for a committed block. |
Constructors
constructor Create();
AzureBlobContainer Type
An Azure storage container.
Remarks
This type represents an Azure storage container.
Fields
DeletedVersion
String (read-only)
Default Value: ""
The deleted version of the container.
This property reflects the version of the container if it was soft-deleted; otherwise, it will be empty.
ETag
String (read-only)
Default Value: ""
The ETag of the container.
This property reflects the container's ETag.
HasImmutabilityPolicy
Boolean (read-only)
Default Value: False
Whether an immutability policy is set on the container.
This property indicates whether there is an immutability policy set on the container.
HasLegalHold
Boolean (read-only)
Default Value: False
Whether there are any legal holds on the container.
This property indicates whether there are any legal holds on the container.
IsLeased
Boolean (read-only)
Default Value: False
Whether the container is currently leased.
This property indicates whether the container is currently leased.
IsLeaseInfinite
Boolean (read-only)
Default Value: False
Whether the container's lease duration is infinite.
This property indicates whether the container's lease duration is fixed (False) or infinite (True).
This property is always False when IsLeased is False.
LeaseState
TcsAzureContainerLeaseStates (read-only)
Default Value: 0
The lease state of the container.
This property reflects the lease state of the container. Possible values are:
aclsAvailable (0) | The container's lease is unlocked and can be acquired. |
aclsLeased (1) | The container's lease is locked. |
aclsExpired (2) | The lease duration has expired. |
aclsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
aclsBroken (4) | The lease has been broken, and the break period has expired. |
This property is always aclsAvailable (0) when IsLeased is False.
ModifiedTime
String (read-only)
Default Value: ""
The last modified time of the container.
This property reflects the last modified time of the container, formatted according to RFC 1123.
Name
String (read-only)
Default Value: ""
The name of the container.
This property reflects the name of the container.
PublicAccess
TcsAzureContainerPublicAccess (read-only)
Default Value: 0
The container's public access level.
This property reflects the container's public access level. Possible values are:
acpaNone (0) | The container is private. |
acpaBlobs (1) | Blob data within the container is publicly readable, but blobs cannot be listed. |
acpaContainer (2) | Container information and blob data within the container is publicly readable, and blobs can be listed. |
SoftDeleted
Boolean (read-only)
Default Value: False
Whether the container has been soft-deleted.
This property indicates whether the container has been soft-deleted.
AzureMetadata Type
An Azure metadata item.
Remarks
This type represents an Azure metadata item.
Fields
Name
String
Default Value: ""
The name of the metadata item.
This property specifies the name of the metadata item. Note that metadata item names are case-preserving, but not case-sensitive.
Note that the component will automatically prepend x-ms-meta- to this value when submitting metadata items to the server; and will automatically strip that prefix from this value when retrieving them from the server.
Value
String
Default Value: ""
The value of the metadata item.
This property specifies the value of the metadata item.
Constructors
constructor Create();
constructor Create(valName: String; valValue: String);
AzureRange Type
An Azure byte range.
Remarks
This type represents an Azure byte range.
Fields
First
Int64 (read-only)
Default Value: 0
The first byte of the range.
This property specifies the first byte (inclusive) of the byte range.
Last
Int64 (read-only)
Default Value: 0
The last byte of the range.
This property specifies the last byte (inclusive) of the byte range.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
String (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
String (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
String (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
String (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
String (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
String (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
String (read-only)
Default Value: ""
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
String (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
Boolean (read-only)
Default Value: False
This property shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String (read-only)
Default Value: ""
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
Integer (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
String (read-only)
Default Value: ""
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
String
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
TBytes
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
TcsCertStoreTypes
Default Value: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
String (read-only)
Default Value: ""
This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
String (read-only)
Default Value: ""
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
String (read-only)
Default Value: ""
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
String (read-only)
Default Value: ""
This property contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
Integer (read-only)
Default Value: 0
This property contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage property for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
String
Default Value: ""
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
String
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
TBytes
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
>
constructor Create();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
>constructor Create(valEncoded: TBytes);
Parses Encoded as an X.509 public key.
>constructor Create(valStoreType: TcsCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
>constructor Create(valStoreType: TcsCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
Boolean
Default Value: False
This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
TcsFirewallTypes
Default Value: 0
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
String
Default Value: ""
This property contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.
Password
String
Default Value: ""
This property contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.
Port
Integer
Default Value: 0
This property contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
User
String
Default Value: ""
This property contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this property and the Password property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.
Constructors
constructor Create();
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
String
Default Value: ""
This property contains the name of the HTTP Header (this is the same case as it is delivered).
Value
String
Default Value: ""
This property contains the Header contents.
Constructors
constructor Create();
constructor Create(valField: String; valValue: String);
OAuthSettings Type
The settings to use to authenticate with the service provider.
Remarks
Used to set give the component the necessary information needed to complete OAuth authentication.
Fields
AccessToken
String
Default Value: ""
The access token returned by the authorization server. This is set when the component makes a request to the token server.
AuthorizationCode
String
Default Value: ""
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
AuthorizationScope
String
Default Value: ""
The scope request or response parameter used during authorization.
ClientId
String
Default Value: ""
The id of the client assigned when registering the application.
ClientProfile
TcsCloudOAuthClientProfiles
Default Value: 0
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
ClientSecret
String
Default Value: ""
The secret value for the client assigned when registering the application.
GrantType
TcsOAuthSettingsGrantTypes
Default Value: 0
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
RefreshToken
String
Default Value: ""
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
RequestRefreshToken
Boolean
Default Value: True
Specifies whether the component will request a refresh token during authorization. By default, this value is True.
When True, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
ReturnURL
String
Default Value: ""
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
ServerAuthURL
String
Default Value: ""
The URL of the authorization server.
ServerTokenURL
String
Default Value: ""
The URL of the token server used to obtain the access token.
WebAuthURL
String (read-only)
Default Value: ""
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
Constructors
constructor Create();
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
TcsProxyAuthSchemes
Default Value: 0
This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of User and Password.
AutoDetect
Boolean
Default Value: False
This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is False.
Password
String
Default Value: ""
This property contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Port
Integer
Default Value: 80
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.
Server
String
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.
SSL
TcsProxySSLTypes
Default Value: 0
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
String
Default Value: ""
This property contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Constructors
constructor Create();
constructor Create(valServer: String; valPort: Integer);
constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);
QueryParam Type
A query parameter to send in the request.
Remarks
This type represents a query parameter to send in the request.
Fields
Name
String
Default Value: ""
The name of the query parameter.
This property specifies the name of the query parameter.
Value
String
Default Value: ""
The value of the query parameter.
This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.
Constructors
constructor Create();
constructor Create(valName: String; valValue: String);
Config Settings (AzureBlob Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.AzureBlob Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
Note that this setting cannot be changed.
If GetBlobInfo is called on a block blob or a page blob, this setting will be -1.
By default, this setting is enabled.
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
Valid values for i are from 0 to (BlobCount - 1).
By default, a comma (,) is used as the separator string.
This setting is populated after calling CopyBlob, or after calling GetBlobInfo for the destination blob in a copy operation.
Calling CopyBlob will clear this setting; call GetBlobInfo for the destination blob in a copy operation to populate it.
This setting, if non-empty, must be an Azure storage URL appropriate for use in a blob operation; the corresponding method will then use this URL directly when building the request. Note that when calling CopyBlob, the SrcBlob parameter will be ignored.
Refer to Azure's Append Block From URL, Copy Blob From URL, Put Blob From URL, and Put Page From URL API documentation (and particularly, the description of the x-ms-copy-source header) for more information.
- pending
- success
- aborted
- failed
This setting is populated after calling CopyBlob, or after calling GetBlobInfo for the destination blob in a copy operation.
- If the operation is pending, the description may reflect any non-fatal errors which have occurred thus far.
- If the operation is failed, the description will detail the fatal error which caused the failure.
- Otherwise, the description will always be empty.
Calling CopyBlob will clear this setting; call GetBlobInfo for the destination blob in a copy operation to populate it.
yyyy | year |
MM | month |
dd | day |
hh | hours |
mm | minutes |
ss | seconds |
These format specifiers can be written in any combination. For example:
AzureBlob.Config("DateFormat=yyyy-MM-ddThh:mm:ss");
AzureBlob.Config("DateFormat=dd/MM/yyyy hh:mm:ss");
If this setting is not specified, the default date/time format will be Day, dd MM yyyy hh:mm:ss. This is from RFC 1123.
By default, this setting is disabled.
When downloading encrypted data with LocalFile set, the component will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.
If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details.
By default, this setting is enabled.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
In most cases, the default endpoint suffix is the correct choice. This setting should only be changed if the component needs to use an endpoint suffix associated with a specific National Cloud Deployment, in which case it should be set to one of the values shown in this table:
National Cloud | Endpoint Suffix |
Azure global service | .core.windows.net (default) |
Azure Government (US) | .core.usgovcloudapi.net |
Azure Germany | .core.cloudapi.de |
Azure China | .core.chinacloudapi.cn |
Please note that each National Cloud Deployment also has its own corresponding application registration portal and OAuth endpoints, both of which are completely separate from those used for/by the global Azure Storage services. Applications that wish to work with a specific National Cloud Deployment must use that National Cloud Deployment's app registration portal and OAuth endpoints to register and authenticate in order for the component to successfully communicate using the National Cloud Deployment-specific endpoint. Refer to Microsoft's National Cloud Authentication article for more information.
Valid values are 1 to 2147483647 (2GB). The default is 104857600 (100MB).
Note: If the amount of upload data provided when creating a block blob is less than SimpleUploadLimit bytes, it can be uploaded directly, and this setting will not apply. Data cannot be uploaded when creating a page blob or an append blob, so this setting does not apply in those cases either.
Note that Azure supports many other conditional headers in addition to If-Match, from common ones (like If-None-Match, If-Modified-Since, and If-Unmodified-Since), to request-specific ones. The OtherHeaders property can be used to include additional conditional headers as needed; refer to the Azure Blob REST API documentation for more information.
By default, this setting is disabled, and results are returned without metadata items.
Note that calls to ListBlobs and ListContainers will never repopulate the Metadata properties, regardless of this setting's value.
By default, this setting is disabled.
By default, this setting is disabled.
By default, this setting is disabled, and results are returned without system containers.
Note that calls to ListBlobs and ListContainers will never repopulate the Metadata properties, regardless of this setting's value.
By default, this setting is disabled.
A successful call to Lease where LeaseAction was not Break (4) will set this setting back to -1.
If this setting is -1 (default), the server's default (5000) is used. Acceptable values are 1 to 5000 (inclusive).
This setting returns True if the specified page range has been completely cleared, or False it it's been changed in some other manner. If PreviousSnapshot was empty when ListPageRanges was last called, this setting will always return False.
Valid values for i are from 0 to (PageRangeCount - 1).
Valid values for i are from 0 to (PrefixCount - 1).
This setting is always -1 when StorePrefixList is disabled.
If the Snapshot property is also non-empty when ListPageRanges is called, this server will return a list of page ranges that differ between the snapshot that this setting specifies, and the one that Snapshot specifies. (Snapshot must specify a later snapshot than this setting, otherwise the request will fail.)
Note that there are other restrictions that apply when requesting page range change lists; refer to the Azure Blob REST API documentation for more information.
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the component will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the Progress event for more information.
The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.
Note that the Progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the component will behave as if this setting were 0 for the duration of the transfer.
By default, this setting is disabled, and blobs and containers are created without metadata.
If this setting is disabled (default), or if this setting is enabled but there are no Metadata items, then the server will copy the source blob's current metadata to the destination blob.
If this setting is disabled (default), the component will ensure that the block blob's current metadata, if any, is preserved (as described in PutBlockList's documentation).
If this setting is disabled (default), or if this setting is enabled but there are no Metadata items, the server will copy the base blob's current metadata to the snapshot.
Valid values are 0 to 5368709120 (5GB), inclusive. The default is 268435456 (256MB). If this setting is set to 0, the component will always perform a block-based upload (if necessary) when creating a block blob.
Note: Data cannot be uploaded when creating a page blob or an append blob, so this setting does not apply in those cases.
By default, this setting is disabled.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the RefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.
If set to True (default) the redirect_uri will be sent in all cases. If set to False the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the ReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Note: This is required when OAuthWebServerSSLEnabled is set to True.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to True.
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to True.
The default value is localhost.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'.
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ('#13#10') .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
Trappable Errors (AzureBlob Component)
Common Errors
600 | A server error occurred, and/or the component was unable to process the server's response. Please refer to the error message for more information. |
601 | An unsupported operation or action was attempted. |
602 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
603 | The login credentials specified were invalid. Please refer to the error message for more information. |
604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
605 | An invalid index was specified. |
606 | An upload was aborted by the user before it could finish. |
607 | The specified resource is a folder and cannot be downloaded. |
608 | A download failed because the specified LocalFile already exists and Overwrite is False. |
609 | The component could not resume a download or upload. Please refer to the error message for more information. |
610 | An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set. |
611 | An exception occurred while working with the specified LocalFile (or the current value of LocalFile is invalid). Please refer to the error message for more information. |
612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |
The component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in URL |
153 | Specified URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |