# AzureBlob Component The AzureBlob component provides an easy to use interface to Microsoft's Azure Blob Storage service. ## Syntax ```text 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](#account-property-azureblob-component) property to the name of the Azure Storage account to operate against, and set the [AccessKey](#accesskey-property-azureblob-component) 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](#oauth-property-azureblob-component) 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](#OAuthSettings_f_ClientProfile) and [GrantType](#OAuthSettings_f_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](#authorize-method-azureblob-component) method should be called. If the authorization and authentication was successful, then the [AccessToken](#OAuthSettings_f_AccessToken) property will be populated. Additionally, if a *refresh token* was provided the [RefreshToken](#OAuthSettings_f_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](#OAuthSettings_f_AccessToken) will be expired. When a method that makes requests to the service provider is called or the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_AccessToken). If the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_GrantType) property. To force the component to only check the *access token* when the [Authorize](#authorize-method-azureblob-component) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false. A brief description of the supported values for the [GrantType](#OAuthSettings_f_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](#OAuthSettings_f_GrantType) the component expects a [ClientId](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), [ServerAuthURL](#OAuthSettings_f_ServerAuthURL), and [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) to be set. When the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_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](#OAuthSettings_f_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*. ```text 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](#OAuthSettings_f_GrantType) the component expects a [ClientId](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), and [ServerAuthURL](#OAuthSettings_f_ServerAuthURL) to be set. When the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_GrantType) the component requires [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername), [ClientSecret](#OAuthSettings_f_ClientSecret), and [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) to be set. The [ClientSecret](#OAuthSettings_f_ClientSecret) should be set to the password of the account instead of a typical secret. In some cases, the [ClientId](#OAuthSettings_f_ClientId) also needs to be set. When the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), [ServerAuthURL](#OAuthSettings_f_ServerAuthURL), [ServerTokenURL](#OAuthSettings_f_ServerTokenURL), and the [ReturnURL](#OAuthSettings_f_ReturnURL) properties to be set. Before calling the [Authorize](#authorize-method-azureblob-component) method, the [WebAuthURL](#OAuthSettings_f_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](#OAuthSettings_f_ReturnURL) property. The [ReturnURL](#OAuthSettings_f_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](#OAuthSettings_f_AuthorizationCode) property. Once that is set, the [Authorize](#authorize-method-azureblob-component) 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](#OAuthSettings_f_RefreshToken) field is set, or a *refresh token* is cached, then the [Authorize](#authorize-method-azureblob-component) 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 a separate OAuth client. Once complete you should have an authorization string which looks like: ```text Bearer ACCESS_TOKEN_VALUE ``` Assign this value to the [Authorization](#authorization-property-azureblob-component) property before attempting any operations. Setting the [Authorization](#authorization-property-azureblob-component) property will cause the component to ignore the values set in the [OAuth](#oauth-property-azureblob-component) 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](#listcontainers-method-azureblob-component), [GetContainerInfo](#getcontainerinfo-method-azureblob-component), [CreateContainer](#createcontainer-method-azureblob-component), [DeleteContainer](#deletecontainer-method-azureblob-component), [GetContainerACL](#getcontaineracl-method-azureblob-component), [SetContainerACL](#setcontaineracl-method-azureblob-component) - Blob management: [ListBlobs](#listblobs-method-azureblob-component), [GetBlobInfo](#getblobinfo-method-azureblob-component), [UpdateBlobInfo](#updateblobinfo-method-azureblob-component), [CreateBlob](#createblob-method-azureblob-component), [CopyBlob](#copyblob-method-azureblob-component), [GetBlob](#getblob-method-azureblob-component), [DeleteBlob](#deleteblob-method-azureblob-component), [UndeleteBlob](#undeleteblob-method-azureblob-component) - Block blob management: [ListBlocks](#listblocks-method-azureblob-component), [PutBlock](#putblock-method-azureblob-component), [PutBlockList](#putblocklist-method-azureblob-component) - Page blob management: [ListPageRanges](#listpageranges-method-azureblob-component), [PutPages](#putpages-method-azureblob-component), [ClearPages](#clearpages-method-azureblob-component), [UpdatePageBlob](#updatepageblob-method-azureblob-component) - Append blob management: [AppendBlock](#appendblock-method-azureblob-component) 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](#accesskey-property-azureblob-component) | The Azure access key to use for authentication. | | [AccessPolicies](#accesspolicies-property-azureblob-component) | A collection of access policies. | | [Account](#account-property-azureblob-component) | The Azure storage account name. | | [Authorization](#authorization-property-azureblob-component) | The OAuth 2.0 authorization token. | | [BlobData](#blobdata-property-azureblob-component) | The data that was downloaded, or that should be uploaded. | | [BlobDelimiter](#blobdelimiter-property-azureblob-component) | The delimiter string to use when listing blobs. | | [BlobMarker](#blobmarker-property-azureblob-component) | A marker indicating what page of blobs to return next. | | [Blobs](#blobs-property-azureblob-component) | A collection of blobs. | | [Blocks](#blocks-property-azureblob-component) | A collection of blocks. | | [Container](#container-property-azureblob-component) | Selects a container. | | [ContainerMarker](#containermarker-property-azureblob-component) | A marker indicating what page of containers to return next. | | [Containers](#containers-property-azureblob-component) | A collection of containers. | | [EncryptionAlgorithm](#encryptionalgorithm-property-azureblob-component) | The encryption algorithm. | | [EncryptionPassword](#encryptionpassword-property-azureblob-component) | The encryption password. | | [Firewall](#firewall-property-azureblob-component) | A set of properties related to firewall access. | | [Idle](#idle-property-azureblob-component) | The current status of the component. | | [LeaseId](#leaseid-property-azureblob-component) | The lease Id to include when making requests. | | [LocalFile](#localfile-property-azureblob-component) | The location of the local file. | | [LocalHost](#localhost-property-azureblob-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [Metadata](#metadata-property-azureblob-component) | A collection of metadata items. | | [OAuth](#oauth-property-azureblob-component) | The OAuth settings. | | [OtherHeaders](#otherheaders-property-azureblob-component) | Other headers as determined by the user (optional). | | [Overwrite](#overwrite-property-azureblob-component) | Whether to overwrite the local file, or remote blob. | | [PageRanges](#pageranges-property-azureblob-component) | A collection of page range items. | | [ParsedHeaders](#parsedheaders-property-azureblob-component) | This property includes a collection of headers returned from the last request. | | [Prefix](#prefix-property-azureblob-component) | A prefix used to restrict the results returned when listing blobs or containers. | | [Proxy](#proxy-property-azureblob-component) | A set of properties related to proxy access. | | [QueryParams](#queryparams-property-azureblob-component) | Additional query parameters to be included in the request. | | [Range](#range-property-azureblob-component) | The range of bytes to request. | | [Snapshot](#snapshot-property-azureblob-component) | The blob snapshot to make requests against. | | [SSLAcceptServerCert](#sslacceptservercert-property-azureblob-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-azureblob-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-azureblob-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-azureblob-component) | The server certificate for the last established connection. | | [StartByte](#startbyte-property-azureblob-component) | The byte offset from which to resume the upload or download. | | [Timeout](#timeout-property-azureblob-component) | The timeout for the component. | | [UseSSL](#usessl-property-azureblob-component) | 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](#abortcopy-method-azureblob-component) | Aborts a copy operation. | | [AddBlock](#addblock-method-azureblob-component) | Adds a block to the Blocks properties. | | [AddMetadata](#addmetadata-method-azureblob-component) | Adds a metadata item to the Metadata properties. | | [AddQueryParam](#addqueryparam-method-azureblob-component) | Adds a query parameter to the QueryParams properties. | | [AppendBlock](#appendblock-method-azureblob-component) | Appends a block of data to an append blob. | | [Authorize](#authorize-method-azureblob-component) | Get the authorization string required to access the protected resource. | | [ClearPages](#clearpages-method-azureblob-component) | Clears a range of pages in a page blob. | | [Config](#config-method-azureblob-component) | Sets or retrieves a configuration setting. | | [CopyBlob](#copyblob-method-azureblob-component) | Copies a blob. | | [CreateBlob](#createblob-method-azureblob-component) | Creates a new blob of the specified type. | | [CreateContainer](#createcontainer-method-azureblob-component) | Creates a new container. | | [CreateSnapshot](#createsnapshot-method-azureblob-component) | Creates a new snapshot of a blob. | | [DeleteBlob](#deleteblob-method-azureblob-component) | Deletes a blob. | | [DeleteContainer](#deletecontainer-method-azureblob-component) | Deletes a container. | | [GetBlob](#getblob-method-azureblob-component) | Downloads a blob. | | [GetBlobInfo](#getblobinfo-method-azureblob-component) | Gets a blob's information and metadata. | | [GetContainerACL](#getcontaineracl-method-azureblob-component) | Gets the stored access policies and public access level for a container. | | [GetContainerInfo](#getcontainerinfo-method-azureblob-component) | Gets a container's information and metadata. | | [GetLink](#getlink-method-azureblob-component) | Creates a link that provides access to a container, blob, or snapshot. | | [GetUserDelegationKey](#getuserdelegationkey-method-azureblob-component) | Requests a new user delegation key. | | [Interrupt](#interrupt-method-azureblob-component) | This method interrupts the current method. | | [Lease](#lease-method-azureblob-component) | Creates or manages a lease on a blob or container. | | [ListBlobs](#listblobs-method-azureblob-component) | Lists the blobs in a container. | | [ListBlocks](#listblocks-method-azureblob-component) | Lists the blocks associated with a block blob. | | [ListContainers](#listcontainers-method-azureblob-component) | Lists the containers in the blob storage account. | | [ListPageRanges](#listpageranges-method-azureblob-component) | Lists the page ranges of a page blob. | | [PutBlock](#putblock-method-azureblob-component) | Uploads a new block of data to a block blob. | | [PutBlockList](#putblocklist-method-azureblob-component) | Commits a list of data blocks to a block blob. | | [PutPages](#putpages-method-azureblob-component) | Uploads a range of pages to a page blob. | | [Reset](#reset-method-azureblob-component) | Resets the component to its initial state. | | [SendCustomRequest](#sendcustomrequest-method-azureblob-component) | Sends a custom request to the Azure Blob Storage service. | | [SetContainerACL](#setcontaineracl-method-azureblob-component) | Sets the stored access policies and public access level for a container. | | [SetDownloadStream](#setdownloadstream-method-azureblob-component) | Sets the stream to which downloaded data will be written. | | [SetUploadStream](#setuploadstream-method-azureblob-component) | Sets the stream from which data is read when uploading. | | [UndeleteBlob](#undeleteblob-method-azureblob-component) | Undeletes a soft-deleted blob. | | [UndeleteContainer](#undeletecontainer-method-azureblob-component) | Undeletes a soft-deleted container. | | [UpdateBlobInfo](#updateblobinfo-method-azureblob-component) | Updates a blob's information. | | [UpdateMetadata](#updatemetadata-method-azureblob-component) | Sets the metadata for a blob or container. | | [UpdatePageBlob](#updatepageblob-method-azureblob-component) | 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](#bloblist-event-azureblob-component) | Fires once for each blob returned when listing blobs. | | [BlockList](#blocklist-event-azureblob-component) | Fires once for each block returned when listing blocks. | | [ContainerList](#containerlist-event-azureblob-component) | Fires once for each container returned when listing containers. | | [EndTransfer](#endtransfer-event-azureblob-component) | Fired when a document finishes transferring. | | [Error](#error-event-azureblob-component) | Fired when information is available about errors during data delivery. | | [FragmentComplete](#fragmentcomplete-event-azureblob-component) | Fires after each block in an automatic block-based upload is complete. | | [Header](#header-event-azureblob-component) | Fired every time a header line comes in. | | [Log](#log-event-azureblob-component) | Fired once for each log message. | | [MetadataList](#metadatalist-event-azureblob-component) | Fires once for each metadata item returned when listing metadata. | | [PrefixList](#prefixlist-event-azureblob-component) | Fires once for each common prefix returned when listing blobs. | | [Progress](#progress-event-azureblob-component) | Fires during an upload or download to indicate transfer progress. | | [SSLServerAuthentication](#sslserverauthentication-event-azureblob-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-azureblob-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-azureblob-component) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-azureblob-component) | 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](#AccumulatePages) | Whether the component should accumulate subsequent pages of results when listing them. | | [APIVersion](#APIVersion) | The Azure Storage REST API version being used by the component. | | [AppendedBlockCount](#AppendedBlockCount) | The number of blocks that have been appended to the append blob. | | [AutoAddBlocks](#AutoAddBlocks) | Whether to automatically add an item to the Blocks collection after a block is uploaded. | | [BlobAccessTier\[i\]](#BlobAccessTier[i]) | The access tier of the specified blob. | | [BlobAccessTierChanged\[i\]](#BlobAccessTierChanged[i]) | The time at which the specified blob's access tier was last changed. | | [BlobAccessTierInferred\[i\]](#BlobAccessTierInferred[i]) | Whether the specified blob's access tier is inferred. | | [BlobArchiveStatus\[i\]](#BlobArchiveStatus[i]) | The rehydration status of the specified blob. | | [BlobCacheControl\[i\]](#BlobCacheControl[i]) | The Cache-Control value of the specified blob. | | [BlobContentLanguage\[i\]](#BlobContentLanguage[i]) | The content language of the specified blob. | | [BlobRetentionDaysLeft\[i\]](#BlobRetentionDaysLeft[i]) | The number of days left before the specified soft-deleted blob is permanently deleted. | | [BlobSoftDeleteTime\[i\]](#BlobSoftDeleteTime[i]) | The time at which the specified blob was soft-deleted. | | [BlockListStringSeparator](#BlockListStringSeparator) | The separator string to use when parsing a block list string. | | [CopyId](#CopyId) | The Id of a copy operation. | | [CopyProgress](#CopyProgress) | The progress of a copy operation. | | [CopySourceURL](#CopySourceURL) | The Azure storage URL to use as the source. | | [CopyStatus](#CopyStatus) | The status of a copy operation. | | [CopyStatusDesc](#CopyStatusDesc) | The status description for a copy operation. | | [DateFormat](#DateFormat) | The format to use for date and time. | | [DeletePermanently](#DeletePermanently) | Whether a blob should be permanently deleted. | | [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. | | [EncodeBlockIds](#EncodeBlockIds) | Whether the component should automatically Base64-encode and -decode block Ids. | | [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. | | [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. | | [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. | | [Endpoint](#Endpoint) | The Azure Storage endpoint suffix that the component should use. | | [FragmentSize](#FragmentSize) | The block size to use when uploading a new block blob. | | [IfMatch](#IfMatch) | The ETag which the blob must currently have in order for a request to succeed. | | [IncludeMetadata](#IncludeMetadata) | Whether to include metadata items when listing blobs or containers. | | [IncludeSnapshots](#IncludeSnapshots) | Whether blob snapshots should be included when listing blobs. | | [IncludeSoftDeleted](#IncludeSoftDeleted) | Whether soft-deleted blobs and containers should be included when listing. | | [IncludeSystemContainers](#IncludeSystemContainers) | Whether to include system containers when listing containers. | | [IncludeUncommittedBlobs](#IncludeUncommittedBlobs) | Whether uncommitted block blobs should be included when listing blobs. | | [LeaseBreakPeriod](#LeaseBreakPeriod) | The approximate number of seconds the lease will remain in the 'breaking' state. | | [MaxResults](#MaxResults) | The maximum number of results to return when listing blobs or containers. | | [PageRangeCleared\[i\]](#PageRangeCleared[i]) | Whether the specified page range has been cleared. | | [Prefix\[i\]](#Prefix[i]) | The i'th common prefix returned. | | [PrefixCount](#PrefixCount) | The number of common prefixed returned. | | [PreviousSnapshot](#PreviousSnapshot) | An opaque DateTime value that identifies the snapshot to list page range changes since. | | [ProgressAbsolute](#ProgressAbsolute) | Whether the component should track transfer progress absolutely. | | [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [SendMetadata](#SendMetadata) | Whether to send metadata items when creating blobs and containers. | | [SendMetadataOnCopy](#SendMetadataOnCopy) | Whether to send metadata items when copying blobs. | | [SendMetadataOnPutBlockList](#SendMetadataOnPutBlockList) | Whether to send metadata items when committing a new block list. | | [SendMetadataOnSnapshot](#SendMetadataOnSnapshot) | Whether to send metadata items when creating a blob snapshot. | | [SharedAccessSignature](#SharedAccessSignature) | Specifies a SAS token to use for authentication. | | [SimpleUploadLimit](#SimpleUploadLimit) | The maximum data size the component should attempt to upload directly when creating a block blob. | | [StorePrefixList](#StorePrefixList) | Whether to store the common prefixes returned when listing blobs. | | [TempPath](#TempPath) | The path to the directory where temporary files are created. | | [UserDelegationKey](#UserDelegationKey) | A user delegation key to use for constructing SAS tokens. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. | | [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. | | [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. | | [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. | | [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. | | [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. | | [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. | | [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. | | [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. | | [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. | | [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. | | [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. | | [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. | | [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. | | [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. | | [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. | | [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. | | [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. | | [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. | | [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. | | [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. | | [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. | | [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. | | [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. | | [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. | | [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the component. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the component will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the component. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the component. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessKey Property ([AzureBlob](#azureblob-component) Component) The Azure access key to use for authentication. ## Syntax *Delphi Syntax* ```text 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](#authorization-property-azureblob-component) property is populated. This property is not available at design time. # AccessPolicies Property ([AzureBlob](#azureblob-component) Component) A collection of access policies. ## Syntax *Delphi Syntax* ```text property AccessPolicies: TcsAzureAccessPolicyList read get_AccessPolicies write set_AccessPolicies; ``` ## Remarks This collection holds a list of [AzureAccessPolicy](#azureaccesspolicy-type) items. This collection is populated anytime [GetContainerACL](#getcontaineracl-method-azureblob-component) is called; and its items are used anytime [SetContainerACL](#setcontaineracl-method-azureblob-component) is called. This property is not available at design time. Please refer to the [AzureAccessPolicy](#azureaccesspolicy-type) type for a complete list of fields. # Account Property ([AzureBlob](#azureblob-component) Component) The Azure storage account name. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) The OAuth 2.0 authorization token. ## Syntax *Delphi Syntax* ```text property Authorization: String read get_Authorization write set_Authorization; ``` ## Default Value '' ## Remarks This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format: ```text Bearer ACCESS_TOKEN ``` The *ACCESS_TOKEN* segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth. Note: if both this property and [AccessKey](#accesskey-property-azureblob-component) are populated, this property takes precedence, and the component will use OAuth authentication instead of shared key authentication. The [Account](#account-property-azureblob-component) property must be set in either case. # BlobData Property ([AzureBlob](#azureblob-component) Component) The data that was downloaded, or that should be uploaded. ## Syntax *Delphi Syntax* ```text 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](#getblob-method-azureblob-component) if [SetDownloadStream](#setdownloadstream-method-azureblob-component) and [LocalFile](#localfile-property-azureblob-component) are not set. This property can also be set before calling [AppendBlock](#appendblock-method-azureblob-component), [CreateBlob](#createblob-method-azureblob-component) (for block blobs), [PutBlock](#putblock-method-azureblob-component), or [PutPages](#putpages-method-azureblob-component); its data will be uploaded if [SetUploadStream](#setuploadstream-method-azureblob-component) and [LocalFile](#localfile-property-azureblob-component) are not set. This property is not available at design time. # BlobDelimiter Property ([AzureBlob](#azureblob-component) Component) The delimiter string to use when listing blobs. ## Syntax *Delphi Syntax* ```text property BlobDelimiter: String read get_BlobDelimiter write set_BlobDelimiter; ``` ## Default Value '' ## Remarks If this property is non-empty when [ListBlobs](#listblobs-method-azureblob-component) is called, any blobs whose names contain the same string between the specified [Prefix](#prefix-property-azureblob-component) 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](#prefixlist-event-azureblob-component) event will fire once for each common prefix returned. If the [StorePrefixList](#StorePrefixList) configuration setting is enabled, the component will also populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) configuration settings ### Blob Namespace Traversal By using the BlobDelimiter and [Prefix](#prefix-property-azureblob-component) 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](#prefix-property-azureblob-component) to successively "deeper" values before calling [ListBlobs](#listblobs-method-azureblob-component) for the following effect: | [Prefix](#prefix-property-azureblob-component) 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](#azureblob-component) Component) A marker indicating what page of blobs to return next. ## Syntax *Delphi Syntax* ```text property BlobMarker: String read get_BlobMarker write set_BlobMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListBlobs](#listblobs-method-azureblob-component) is called if the results are paged and there are more pages. To list all blobs, continue to call [ListBlobs](#listblobs-method-azureblob-component) until this property returns empty string. Refer to [ListBlobs](#listblobs-method-azureblob-component) for more information. This property is not available at design time. # Blobs Property ([AzureBlob](#azureblob-component) Component) A collection of blobs. ## Syntax *Delphi Syntax* ```text property Blobs: TcsAzureBlobBlobList read get_Blobs write set_Blobs; ``` ## Remarks This collection holds a list of [AzureBlobBlob](#azureblobblob-type) items. Calling [ListBlobs](#listblobs-method-azureblob-component) or [GetBlobInfo](#getblobinfo-method-azureblob-component) will populate this collection. This property is not available at design time. Please refer to the [AzureBlobBlob](#azureblobblob-type) type for a complete list of fields. # Blocks Property ([AzureBlob](#azureblob-component) Component) A collection of blocks. ## Syntax *Delphi Syntax* ```text property Blocks: TcsAzureBlobBlockList read get_Blocks write set_Blocks; ``` ## Remarks This collection holds a list of [AzureBlobBlock](#azureblobblock-type) items. Calling [ListBlocks](#listblocks-method-azureblob-component) or [AddBlock](#addblock-method-azureblob-component) will populate this collection; and its items are used anytime [PutBlockList](#putblocklist-method-azureblob-component) is called. Additionally, if the [CreateBlob](#createblob-method-azureblob-component) 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](#createblob-method-azureblob-component) for more information. This property is not available at design time. Please refer to the [AzureBlobBlock](#azureblobblock-type) type for a complete list of fields. # Container Property ([AzureBlob](#azureblob-component) Component) Selects a container. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) A marker indicating what page of containers to return next. ## Syntax *Delphi Syntax* ```text property ContainerMarker: String read get_ContainerMarker write set_ContainerMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListContainers](#listcontainers-method-azureblob-component) is called if the results are paged and there are more pages. To list all containers, continue to call [ListContainers](#listcontainers-method-azureblob-component) until this property returns empty string. Refer to [ListContainers](#listcontainers-method-azureblob-component) for more information. This property is not available at design time. # Containers Property ([AzureBlob](#azureblob-component) Component) A collection of containers. ## Syntax *Delphi Syntax* ```text property Containers: TcsAzureBlobContainerList read get_Containers; ``` ## Remarks This collection holds a list of [AzureBlobContainer](#azureblobcontainer-type) items. Calling [ListContainers](#listcontainers-method-azureblob-component) or [GetContainerInfo](#getcontainerinfo-method-azureblob-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [AzureBlobContainer](#azureblobcontainer-type) type for a complete list of fields. # EncryptionAlgorithm Property ([AzureBlob](#azureblob-component) Component) The encryption algorithm. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) The encryption password. ## Syntax *Delphi Syntax* ```text 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](#EncryptionKey) and [EncryptionIV](#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](#azureblob-component) Component) A set of properties related to firewall access. ## Syntax *Delphi Syntax* ```text property Firewall: TcsFirewall read get_Firewall write set_Firewall; ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # Idle Property ([AzureBlob](#azureblob-component) Component) The current status of the component. ## Syntax *Delphi Syntax* ```text property Idle: Boolean read get_Idle; ``` ## Default Value true ## Remarks This property 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](#azureblob-component) Component) The lease Id to include when making requests. ## Syntax *Delphi Syntax* ```text 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](https://docs.microsoft.com/en-us/dotnet/api/system.guid.-ctor#System_Guid__ctor_System_String_) 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 | | | [DeleteContainer](#deletecontainer-method-azureblob-component) | [GetContainerACL](#getcontaineracl-method-azureblob-component)[GetContainerInfo](#getcontainerinfo-method-azureblob-component)[SetContainerACL](#setcontaineracl-method-azureblob-component)[UpdateMetadata](#updatemetadata-method-azureblob-component) | | Blobs | | | [AbortCopy](#abortcopy-method-azureblob-component)[AppendBlock](#appendblock-method-azureblob-component)[ClearPages](#clearpages-method-azureblob-component)[CopyBlob](#copyblob-method-azureblob-component) (but see below)[CreateBlob](#createblob-method-azureblob-component) (but see below)[DeleteBlob](#deleteblob-method-azureblob-component)[PutBlock](#putblock-method-azureblob-component)[PutBlockList](#putblocklist-method-azureblob-component)[PutPages](#putpages-method-azureblob-component)[UpdateBlobInfo](#updateblobinfo-method-azureblob-component)[UpdateMetadata](#updatemetadata-method-azureblob-component)[UpdatePageBlob](#updatepageblob-method-azureblob-component) | [CreateSnapshot](#createsnapshot-method-azureblob-component)[GetBlob](#getblob-method-azureblob-component)[GetBlobInfo](#getblobinfo-method-azureblob-component)[ListBlocks](#listblocks-method-azureblob-component)[ListPageRanges](#listpageranges-method-azureblob-component) | 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](#createblob-method-azureblob-component) and [CopyBlob](#copyblob-method-azureblob-component), 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](#lease-method-azureblob-component) method; refer to its documentation for more information. This property is not available at design time. # LocalFile Property ([AzureBlob](#azureblob-component) Component) The location of the local file. ## Syntax *Delphi Syntax* ```text 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](#appendblock-method-azureblob-component), [CreateBlob](#createblob-method-azureblob-component) (for block blobs), [PutBlock](#putblock-method-azureblob-component), or [PutPages](#putpages-method-azureblob-component); and as the destination file when calling [GetBlob](#getblob-method-azureblob-component). Note: Setting this property to a non-empty value will discard any streams set using [SetDownloadStream](#setdownloadstream-method-azureblob-component) and [SetUploadStream](#setuploadstream-method-azureblob-component). Similarly, passing a non-null value to either of the aforementioned methods will clear this property. # LocalHost Property ([AzureBlob](#azureblob-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Delphi Syntax* ```text property LocalHost: String read get_LocalHost write set_LocalHost; ``` ## Default Value '' ## Remarks This 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](#azureblob-component) Component) A collection of metadata items. ## Syntax *Delphi Syntax* ```text property Metadata: TcsAzureMetadataList read get_Metadata write set_Metadata; ``` ## Remarks This collection holds a list of [AzureMetadata](#azuremetadata-type) items. This collection is populated when [GetBlobInfo](#getblobinfo-method-azureblob-component) or [GetContainerInfo](#getcontainerinfo-method-azureblob-component) is called; and its items are used anytime [UpdateMetadata](#updatemetadata-method-azureblob-component) is called. Additionally, its items may be used when [CreateBlob](#createblob-method-azureblob-component), [CreateSnapshot](#createsnapshot-method-azureblob-component), [CopyBlob](#copyblob-method-azureblob-component), and/or [PutBlockList](#putblocklist-method-azureblob-component) 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](#azuremetadata-type) type for a complete list of fields. # OAuth Property ([AzureBlob](#azureblob-component) Component) The OAuth settings. ## Syntax *Delphi Syntax* ```text property OAuth: TcsOAuthSettings read get_OAuth; ``` ## Remarks This property is used to configure 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](#oauthsettings-type) type for a complete list of fields. # OtherHeaders Property ([AzureBlob](#azureblob-component) Component) Other headers as determined by the user (optional). ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) Whether to overwrite the local file, or remote blob. ## Syntax *Delphi Syntax* ```text property Overwrite: Boolean read get_Overwrite write set_Overwrite; ``` ## Default Value false ## Remarks When calling DownloadFile, this property determines if [LocalFile](#localfile-property-azureblob-component) should be overwritten if it already exists. When calling [CreateBlob](#createblob-method-azureblob-component) or [CopyBlob](#copyblob-method-azureblob-component), this property determines if the remote blob should be overwritten if it already exists. # PageRanges Property ([AzureBlob](#azureblob-component) Component) A collection of page range items. ## Syntax *Delphi Syntax* ```text property PageRanges: TcsAzureRangeList read get_PageRanges; ``` ## Remarks This collection holds a list of [AzureRange](#azurerange-type) items. This collection is populated when [ListPageRanges](#listpageranges-method-azureblob-component) is called. This property is read-only and not available at design time. Please refer to the [AzureRange](#azurerange-type) type for a complete list of fields. # ParsedHeaders Property ([AzureBlob](#azureblob-component) Component) This property includes a collection of headers returned from the last request. ## Syntax *Delphi Syntax* ```text 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](#header-type) in this collection contains information describing that header. [MaxHeaders](#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](#header-type) type for a complete list of fields. # Prefix Property ([AzureBlob](#azureblob-component) Component) A prefix used to restrict the results returned when listing blobs or containers. ## Syntax *Delphi Syntax* ```text 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](#listblobs-method-azureblob-component) or [ListContainers](#listcontainers-method-azureblob-component) to only the items whose names begin with the given value. ### Blob Namespace Traversal By using the [BlobDelimiter](#blobdelimiter-property-azureblob-component) 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](#blobdelimiter-property-azureblob-component) set to */*, we can set Prefix to successively "deeper" values before calling [ListBlobs](#listblobs-method-azureblob-component) 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](#azureblob-component) Component) A set of properties related to proxy access. ## Syntax *Delphi Syntax* ```text 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](#proxy-type) type for a complete list of fields. # QueryParams Property ([AzureBlob](#azureblob-component) Component) Additional query parameters to be included in the request. ## Syntax *Delphi Syntax* ```text 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](#addqueryparam-method-azureblob-component) method. Please refer to the [QueryParam](#queryparam-type) type for a complete list of fields. # Range Property ([AzureBlob](#azureblob-component) Component) The range of bytes to request. ## Syntax *Delphi Syntax* ```text 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](#getblob-method-azureblob-component) or [ListPageRanges](#listpageranges-method-azureblob-component) 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](#startbyte-property-azureblob-component) property is greater than zero when [GetBlob](#getblob-method-azureblob-component) 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](#startbyte-property-azureblob-component) 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](#azureblob-component) Component) The blob snapshot to make requests against. ## Syntax *Delphi Syntax* ```text 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](#copyblob-method-azureblob-component) (to copy *from* a blob snapshot) - [DeleteBlob](#deleteblob-method-azureblob-component) - [GetBlob](#getblob-method-azureblob-component) - [GetBlobInfo](#getblobinfo-method-azureblob-component) - [GetLink](#getlink-method-azureblob-component) (to build a link for a specific blob snapshot) - [ListPageRanges](#listpageranges-method-azureblob-component) - [SendCustomRequest](#sendcustomrequest-method-azureblob-component) Refer to the documentation of the methods listed above for more information. This property is not available at design time. # SSLAcceptServerCert Property ([AzureBlob](#azureblob-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax *Delphi Syntax* ```text 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](#certificate-type) type for a complete list of fields. # SSLCert Property ([AzureBlob](#azureblob-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text 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](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([AzureBlob](#azureblob-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Delphi Syntax* ```text 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. | **Additional Notes** 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](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([AzureBlob](#azureblob-component) Component) The server certificate for the last established connection. ## Syntax *Delphi Syntax* ```text property SSLServerCert: TcsCertificate read get_SSLServerCert; ``` ## Remarks This property 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](#certificate-type) type for a complete list of fields. # StartByte Property ([AzureBlob](#azureblob-component) Component) The byte offset from which to resume the upload or download. ## Syntax *Delphi Syntax* ```text 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](#createblob-method-azureblob-component), or a download of any blob type using [GetBlob](#getblob-method-azureblob-component). 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](#createblob-method-azureblob-component) is called. Keep this in mind when resuming interrupted block blob uploads. This property is not available at design time. # Timeout Property ([AzureBlob](#azureblob-component) Component) The timeout for the component. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) Whether to use SSL/TLS when connecting. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) Aborts a copy operation. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component). Note that the destination blob will still exist after aborting a copy operation, but it will be empty. # AddBlock Method ([AzureBlob](#azureblob-component) Component) Adds a block to the Blocks properties. ## Syntax *Delphi Syntax* ```text procedure AddBlock(Id: String; BlockListType: Integer); ``` ## Remarks This method adds a block to the [Blocks](#blocks-property-azureblob-component) collection. *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](#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](#putblocklist-method-azureblob-component) 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](#azureblob-component) Component) Adds a metadata item to the Metadata properties. ## Syntax *Delphi Syntax* ```text procedure AddMetadata(Name: String; Value: String); ``` ## Remarks This method adds a metadata item to the [Metadata](#metadata-property-azureblob-component) collection. *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](#azureblob-component) Component) Adds a query parameter to the QueryParams properties. ## Syntax *Delphi Syntax* ```text procedure AddQueryParam(Name: String; Value: String); ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#queryparams-property-azureblob-component) collection. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Value*s will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters. # AppendBlock Method ([AzureBlob](#azureblob-component) Component) Appends a block of data to an append blob. ## Syntax *Delphi Syntax* ```text procedure AppendBlock(AppendBlob: String); ``` ## Remarks This method appends a block of data to the specified *AppendBlob* in the container currently selected by [Container](#container-property-azureblob-component). 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](#leaseid-property-azureblob-component), or the request will fail. # Authorize Method ([AzureBlob](#azureblob-component) Component) Get the authorization string required to access the protected resource. ## Syntax *Delphi Syntax* ```text 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](#OAuthSettings_f_ClientProfile) property and the [GrantType](#OAuthSettings_f_GrantType) property. This method is **not** to be used in conjunction with the [Authorization](#authorization-property-azureblob-component) property. It should instead be used when setting the [OAuth](#oauth-property-azureblob-component) property. For more information, see the introduction section. # ClearPages Method ([AzureBlob](#azureblob-component) Component) Clears a range of pages in a page blob. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component). *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](#leaseid-property-azureblob-component), or the request will fail. # Config Method ([AzureBlob](#azureblob-component) Component) Sets or retrieves a configuration setting. ## Syntax *Delphi Syntax* ```text function Config(ConfigurationString: String): String; ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-azureblob-component) 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](#config-settings-azureblob-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # CopyBlob Method ([AzureBlob](#azureblob-component) Component) Copies a blob. ## Syntax *Delphi Syntax* ```text function CopyBlob(SrcBlob: String; DestBlob: String; DestContainer: String): String; ``` ## Remarks This method copies the specified *SrcBlob* (in the container currently selected by [Container](#container-property-azureblob-component)) 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](#snapshot-property-azureblob-component) 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](#container-property-azureblob-component) 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](#overwrite-property-azureblob-component) 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](#leaseid-property-azureblob-component), or the request will fail. (If it exists and has an active fixed-duration lease, the request will *always* fail.) If the [SendMetadataOnCopy](#SendMetadataOnCopy) configuration setting is enabled when this method is called, all items in the [Metadata](#metadata-property-azureblob-component) collection 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](#CopyId) and [CopyStatus](#CopyStatus) configuration settings (and clear [CopyProgress](#CopyProgress) and [CopyStatusDesc](#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](#getblobinfo-method-azureblob-component) method to poll the *DestBlob* blob's information, which will cause the [CopyStatus](#CopyStatus), [CopyStatusDesc](#CopyStatusDesc), and [CopyProgress](#CopyProgress) configuration settings to be refreshed. A copy operation whose [CopyStatus](#CopyStatus) is still *pending* may also be aborted by passing the copy operation Id returned by this method (or later retrieved from [CopyId](#CopyId)) to the [AbortCopy](#abortcopy-method-azureblob-component) method. ```text // 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](#azureblob-component) Component) Creates a new blob of the specified type. ## Syntax *Delphi Syntax* ```text procedure CreateBlob(Blob: String; BlobType: Integer; PageBlobSize: Int64); ``` ## Remarks This method creates a new blob named *Blob* in the container currently selected by [Container](#container-property-azureblob-component). *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](https://docs.microsoft.com/en-us/rest/api/storageservices/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](#overwrite-property-azureblob-component) 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](#leaseid-property-azureblob-component), or the request will fail. If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#metadata-property-azureblob-component) collection 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](#putblock-method-azureblob-component) and then committing a new block list using [PutBlockList](#putblocklist-method-azureblob-component). 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](#SimpleUploadLimit) configuration setting (*268435456* bytes (256MB), by default), it will be uploaded directly in the create blob request. If more than [SimpleUploadLimit](#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](#FragmentSize) configuration setting), uploading them individually, and then committing a new block list. To accomplish this, the component automatically makes calls to [PutBlock](#putblock-method-azureblob-component) and [PutBlockList](#putblocklist-method-azureblob-component) internally, tracks the blocks as they are uploaded using the [Blocks](#blocks-property-azureblob-component) collection, and tracks how much data has been uploaded using the [StartByte](#startbyte-property-azureblob-component) property. The [FragmentComplete](#fragmentcomplete-event-azureblob-component) event will fire after each block is uploaded. If, during a block-based upload, any individual [PutBlock](#putblock-method-azureblob-component) request (or the [PutBlockList](#putblocklist-method-azureblob-component) request) fails, the upload can be resumed be calling this method again with the same parameters, so long as the [Blocks](#blocks-property-azureblob-component) and [StartByte](#startbyte-property-azureblob-component) properties still hold the same information as they did when the upload was interrupted. When a block-based upload completes successfully, [StartByte](#startbyte-property-azureblob-component) is reset to *0*, but the [Blocks](#blocks-property-azureblob-component) collection 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](#putpages-method-azureblob-component) and [ClearPages](#clearpages-method-azureblob-component) 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](#appendblock-method-azureblob-component) method. # CreateContainer Method ([AzureBlob](#azureblob-component) Component) Creates a new container. ## Syntax *Delphi Syntax* ```text procedure CreateContainer(); ``` ## Remarks This method creates a new container using the name specified by the [Container](#container-property-azureblob-component) property; If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#metadata-property-azureblob-component) collection 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](#container-property-azureblob-component).) - All hyphens must be immediately preceded *and* followed by a letter or number (consecutive hyphens are not allowed). # CreateSnapshot Method ([AzureBlob](#azureblob-component) Component) Creates a new snapshot of a blob. ## Syntax *Delphi Syntax* ```text function CreateSnapshot(Blob: String): String; ``` ## Remarks This method creates a new snapshot of the specified *Blob* in the container currently selected by [Container](#container-property-azureblob-component), and returns the opaque DateTime value used to identify the newly-created snapshot. If the [SendMetadataOnSnapshot](#SendMetadataOnSnapshot) configuration setting is enabled when this method is called, all items in the [Metadata](#metadata-property-azureblob-component) collection 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](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # DeleteBlob Method ([AzureBlob](#azureblob-component) Component) Deletes a blob. ## Syntax *Delphi Syntax* ```text procedure DeleteBlob(Blob: String; DeleteAction: Integer); ``` ## Remarks This method deletes the specified *Blob* in the container currently selected by [Container](#container-property-azureblob-component). *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](#snapshot-property-azureblob-component) is non-empty, the specified snapshot of *Blob* is deleted, and *DeleteAction* is ignored. If the current Azure Storage account, specified by [Account](#account-property-azureblob-component), 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](#IncludeSoftDeleted) configuration setting before calling [ListBlobs](#listblobs-method-azureblob-component), and can be undeleted at any point before their retention period expires by calling [UndeleteBlob](#undeleteblob-method-azureblob-component). This method can alternatively permanently delete blobs and snapshots by enabling the [DeletePermanently](#DeletePermanently) configuration setting. If the specified blob has an active lease, its lease Id must be specified using [LeaseId](#leaseid-property-azureblob-component), or the request will fail. # DeleteContainer Method ([AzureBlob](#azureblob-component) Component) Deletes a container. ## Syntax *Delphi Syntax* ```text procedure DeleteContainer(); ``` ## Remarks This method deletes the container currently selected by [Container](#container-property-azureblob-component). 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](#account-property-azureblob-component), 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](#IncludeSoftDeleted) configuration setting before calling [ListContainers](#listcontainers-method-azureblob-component), and can be undeleted at any point before their retention period expires by calling [UndeleteContainer](#undeletecontainer-method-azureblob-component). If the specified container has an active lease, its lease Id must be specified using [LeaseId](#leaseid-property-azureblob-component), or the request will fail. # GetBlob Method ([AzureBlob](#azureblob-component) Component) Downloads a blob. ## Syntax *Delphi Syntax* ```text procedure GetBlob(Blob: String); ``` ## Remarks This methods downloads the specified *Blob* in the container currently selected by [Container](#container-property-azureblob-component). If [Snapshot](#snapshot-property-azureblob-component) is non-empty, the specified snapshot of *Blob* is downloaded instead. The [Range](#range-property-azureblob-component) 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](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. If a stream has been specified using [SetDownloadStream](#setdownloadstream-method-azureblob-component), the blob data will be sent through it. If a stream is not specified, and [LocalFile](#localfile-property-azureblob-component) 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](#encryptionalgorithm-property-azureblob-component) and [EncryptionPassword](#encryptionpassword-property-azureblob-component) before calling this method. ### Download Notes In the simplest use-case, downloading a blob looks like this: ```text azureblob.LocalFile = "../MyData.zip"; azureblob.GetBlob(azureblob.Blobs[0].Name); ``` **Resuming Downloads** The component also supports resuming failed downloads by using the [StartByte](#startbyte-property-azureblob-component) property. If a download is interrupted, set [StartByte](#startbyte-property-azureblob-component) to the appropriate offset before calling this method to resume the download. ```text 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](#localfile-property-azureblob-component) was set in the initial download attempt. If [LocalFile](#localfile-property-azureblob-component) is set when beginning an encrypted download, the component creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data. To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [StartByte](#startbyte-property-azureblob-component), 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](#localfile-property-azureblob-component). ```text 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](#azureblob-component) Component) Gets a blob's information and metadata. ## Syntax *Delphi Syntax* ```text procedure GetBlobInfo(Blob: String); ``` ## Remarks This method gets information and metadata for the specified *Blob* in the container currently selected by [Container](#container-property-azureblob-component). If [Snapshot](#snapshot-property-azureblob-component) is non-empty, information and metadata for the specified snapshot of *Blob* is retrieved instead. Calling this method will fire the [BlobList](#bloblist-event-azureblob-component) and [MetadataList](#metadatalist-event-azureblob-component) events, and will re-populate the [Blobs](#blobs-property-azureblob-component) and [Metadata](#metadata-property-azureblob-component) collection properties. If the specified blob has an active lease, a lease Id may optionally be specified using [LeaseId](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # GetContainerACL Method ([AzureBlob](#azureblob-component) Component) Gets the stored access policies and public access level for a container. ## Syntax *Delphi Syntax* ```text function GetContainerACL(): Integer; ``` ## Remarks This method retrieves the stored access policies and the public access level for the container currently selected by [Container](#container-property-azureblob-component). The stored access policies are used to populate the [AccessPolicies](#accesspolicies-property-azureblob-component) collection, 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](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # GetContainerInfo Method ([AzureBlob](#azureblob-component) Component) Gets a container's information and metadata. ## Syntax *Delphi Syntax* ```text procedure GetContainerInfo(); ``` ## Remarks This method gets information and metadata for the container currently selected by [Container](#container-property-azureblob-component). Calling this method will fire the [ContainerList](#containerlist-event-azureblob-component) and [MetadataList](#metadatalist-event-azureblob-component) events, and will re-populate the [Containers](#containers-property-azureblob-component) and [Metadata](#metadata-property-azureblob-component) collection properties. If the specified container has an active lease, a lease Id may optionally be specified using [LeaseId](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # GetLink Method ([AzureBlob](#azureblob-component) Component) Creates a link that provides access to a container, blob, or snapshot. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component), empty Blob, any [Snapshot](#snapshot-property-azureblob-component) (ignored) | | Blob | Non-empty [Container](#container-property-azureblob-component) and Blob, empty [Snapshot](#snapshot-property-azureblob-component) | | Snapshot | Non-empty [Container](#container-property-azureblob-component), Blob, and [Snapshot](#snapshot-property-azureblob-component) | *Permissions* specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to [this section](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas#specifying-permissions) 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](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas#specifying-the-signature-validity-interval) 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](#queryparams-property-azureblob-component) collection. If any of the query parameters listed below are present in the [QueryParams](#queryparams-property-azureblob-component) collection 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](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas) article. # GetUserDelegationKey Method ([AzureBlob](#azureblob-component) Component) Requests a new user delegation key. ## Syntax *Delphi Syntax* ```text procedure GetUserDelegationKey(StartTime: String; ExpiryTime: String); ``` ## Remarks This method requests a new user delegation key and populates [UserDelegationKey](#UserDelegationKey) with the returned information. NOTE: This method is not currently implemented; it is reserved for future use. # Interrupt Method ([AzureBlob](#azureblob-component) Component) This method interrupts the current method. ## Syntax *Delphi Syntax* ```text procedure Interrupt(); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # Lease Method ([AzureBlob](#azureblob-component) Component) Creates or manages a lease on a blob or container. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component) (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](#leaseid-property-azureblob-component) 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](#leaseid-property-azureblob-component). - 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](#leaseid-property-azureblob-component) to the one specified by *NewLeaseId*. - If this action is successful, the component will automatically set [LeaseId](#leaseid-property-azureblob-component) to the value passed for *NewLeaseId*. - *Release (3)*: Releases the lease specified by [LeaseId](#leaseid-property-azureblob-component). - If this action is successful, the component will automatically clear [LeaseId](#leaseid-property-azureblob-component). - *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](#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](https://docs.microsoft.com/en-us/dotnet/api/system.guid.-ctor#System_Guid__ctor_System_String_) 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](https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob) and [Lease Container](https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container) API documentation. # ListBlobs Method ([AzureBlob](#azureblob-component) Component) Lists the blobs in a container. ## Syntax *Delphi Syntax* ```text procedure ListBlobs(); ``` ## Remarks This method lists the blobs in the container currently selected by [Container](#container-property-azureblob-component). Before calling this method, the [Prefix](#prefix-property-azureblob-component) property may be set in order to restrict the results to only the items whose names begin with a given string. The [MaxResults](#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: - [BlobDelimiter](#blobdelimiter-property-azureblob-component) - [IncludeSnapshots](#IncludeSnapshots) - [IncludeSoftDeleted](#IncludeSoftDeleted) - [IncludeUncommittedBlobs](#IncludeUncommittedBlobs) - [ListWithMetadata](#ListWithMetadata) Calling this method will fire the [BlobList](#bloblist-event-azureblob-component) event once for each blob, and will also populate the [Blobs](#blobs-property-azureblob-component) collection. It may also fire the [PrefixList](#prefixlist-event-azureblob-component) and [MetadataList](#metadatalist-event-azureblob-component) events, and populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#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](#blobmarker-property-azureblob-component) property will be populated. Continue to call this method until [BlobMarker](#blobmarker-property-azureblob-component) is empty to accumulate all pages of results in the [Blobs](#blobs-property-azureblob-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Blobs](#blobs-property-azureblob-component) collection every time a page of results is returned. ### Blob Namespace Traversal By using the [BlobDelimiter](#blobdelimiter-property-azureblob-component) and [Prefix](#prefix-property-azureblob-component) 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](#blobdelimiter-property-azureblob-component) set to */*, we can set [Prefix](#prefix-property-azureblob-component) to successively "deeper" values before calling ListBlobs for the following effect: | [Prefix](#prefix-property-azureblob-component) 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](#azureblob-component) Component) Lists the blocks associated with a block blob. ## Syntax *Delphi Syntax* ```text procedure ListBlocks(BlockBlob: String; BlockListType: Integer); ``` ## Remarks This method lists the blocks associated with the specified *BlockBlob* in the container currently selected by [Container](#container-property-azureblob-component). *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](#putblocklist-method-azureblob-component) 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](#snapshot-property-azureblob-component) 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](#blocklist-event-azureblob-component) event once for each block, and will also repopulate the [Blocks](#blocks-property-azureblob-component) collection. # ListContainers Method ([AzureBlob](#azureblob-component) Component) Lists the containers in the blob storage account. ## Syntax *Delphi Syntax* ```text procedure ListContainers(); ``` ## Remarks This method lists the containers in the Azure blob storage account specified by the [Account](#account-property-azureblob-component) property. Before calling this method, the [Prefix](#prefix-property-azureblob-component) property may be set in order to restrict the results to only the items whose names begin with a given string. The [MaxResults](#MaxResults) configuration setting may also be used to limit the number of results returned. The [ListWithMetadata](#ListWithMetadata) and [IncludeSoftDeleted](#IncludeSoftDeleted) configuration settings can also be used to further tune the results returned. Calling this method will fire the [ContainerList](#containerlist-event-azureblob-component) event once for each container, and will also populate the [Containers](#containers-property-azureblob-component) collection. It may also fire the [MetadataList](#metadatalist-event-azureblob-component) event, depending on how the [ListWithMetadata](#ListWithMetadata) setting is configured. If there are still more containers available to list when this method returns, the [ContainerMarker](#containermarker-property-azureblob-component) property will be populated. Continue to call this method until [ContainerMarker](#containermarker-property-azureblob-component) is empty to accumulate all pages of results in the [Containers](#containers-property-azureblob-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Containers](#containers-property-azureblob-component) collection every time a page of results is returned. # ListPageRanges Method ([AzureBlob](#azureblob-component) Component) Lists the page ranges of a page blob. ## Syntax *Delphi Syntax* ```text procedure ListPageRanges(PageBlob: String); ``` ## Remarks This method lists the allocated page ranges of the specified *PageBlob* in the container currently selected by [Container](#container-property-azureblob-component). If [Snapshot](#snapshot-property-azureblob-component) is non-empty, the allocated page ranges for the specified snapshot of *PageBlob* are listed instead. The [Range](#range-property-azureblob-component) property can be used to restrict the results to only the page ranges within the specified range. Calling this method will repopulate the [PageRanges](#pageranges-property-azureblob-component) collection. 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](#clearpages-method-azureblob-component)) will not be returned by this method. However, setting the [PreviousSnapshot](#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](#snapshot-property-azureblob-component)); refer to [PreviousSnapshot](#PreviousSnapshot) for more information. If the specified blob has an active lease, a lease Id may optionally be specified using [LeaseId](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # PutBlock Method ([AzureBlob](#azureblob-component) Component) Uploads a new block of data to a block blob. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component). 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](#putblocklist-method-azureblob-component) operation. The Base64-encoded Id of the block is returned (if the [EncodeBlockIds](#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](#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](#addblock-method-azureblob-component) to add an item to the [Blocks](#blocks-property-azureblob-component) collection. This behavior can be changed using the [AutoAddBlocks](#AutoAddBlocks) configuration setting. If *BlockBlob* already exists and has an active lease, its lease Id must be specified using [LeaseId](#leaseid-property-azureblob-component), or the request will fail. # PutBlockList Method ([AzureBlob](#azureblob-component) Component) Commits a list of data blocks to a block blob. ## Syntax *Delphi Syntax* ```text procedure PutBlockList(BlockBlob: String; BlockList: String); ``` ## Remarks This method commits the blocks of data specified by the [Blocks](#blocks-property-azureblob-component) collection to the specified *BlockBlob* in the container currently selected by [Container](#container-property-azureblob-component). 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](#blocks-property-azureblob-component) collection 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](#blocks-property-azureblob-component) collection directly, or calling [AddBlock](#addblock-method-azureblob-component). 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](#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](#blocks-property-azureblob-component) collection will remain unchanged. If the specified blob has an active lease, its lease Id must be specified using [LeaseId](#leaseid-property-azureblob-component), 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](#otherheaders-property-azureblob-component) when this method is called, the component will send them rather than re-submitting any of the retrieved blob properties. Similarly, if the [SendMetadataOnPutBlockList](#SendMetadataOnPutBlockList) configuration setting is enabled, the component will send the metadata items currently present in the [Metadata](#metadata-property-azureblob-component) collection instead of those retrieved from the server. # PutPages Method ([AzureBlob](#azureblob-component) Component) Uploads a range of pages to a page blob. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component), 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](#clearpages-method-azureblob-component) method. If the specified blob has an active lease, its lease Id must be specified using [LeaseId](#leaseid-property-azureblob-component), or the request will fail. # Reset Method ([AzureBlob](#azureblob-component) Component) Resets the component to its initial state. ## Syntax *Delphi Syntax* ```text procedure Reset(); ``` ## Remarks This method resets the component to its initial state. # SendCustomRequest Method ([AzureBlob](#azureblob-component) Component) Sends a custom request to the Azure Blob Storage service. ## Syntax *Delphi Syntax* ```text 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: 1. Builds a request URL, including query parameters, using the following: - [UseSSL](#usessl-property-azureblob-component) - [Account](#account-property-azureblob-component) (must be non-empty) - [Container](#container-property-azureblob-component) (if non-empty) - *Blob* (if non-empty) - [Snapshot](#snapshot-property-azureblob-component) (if both it and *Blob* are non-empty) - [QueryParams](#queryparams-property-azureblob-component) 2. Adds request headers from: - [APIVersion](#APIVersion) - [LeaseId](#leaseid-property-azureblob-component) (if non-empty) - [IfMatch](#IfMatch) (if non-empty) - [OtherHeaders](#otherheaders-property-azureblob-component) 3. Authenticates the request using [Authorization](#authorization-property-azureblob-component) (if non-empty), or [AccessKey](#accesskey-property-azureblob-component) (in which case the request is signed). 4. Sends the request, including *RequestBody* if non-empty. 5. Stores the response headers in the [ParsedHeaders](#parsedheaders-property-azureblob-component) collection; and the response body in the stream specified using [SetDownloadStream](#setdownloadstream-method-azureblob-component), the specified [LocalFile](#localfile-property-azureblob-component), or [BlobData](#blobdata-property-azureblob-component) (using the same logic as [GetBlob](#getblob-method-azureblob-component)). If the response body is XML data, the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can then be used to navigate and extract information from it. # SetContainerACL Method ([AzureBlob](#azureblob-component) Component) Sets the stored access policies and public access level for a container. ## Syntax *Delphi Syntax* ```text procedure SetContainerACL(PublicAccess: Integer); ``` ## Remarks This method sets the stored access policies and the public access level for the container currently specified by [Container](#container-property-azureblob-component). The items in the [AccessPolicies](#accesspolicies-property-azureblob-component) collection 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](#getcontaineracl-method-azureblob-component) 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](#leaseid-property-azureblob-component); the request will only succeed if the correct lease Id is specified. # SetDownloadStream Method ([AzureBlob](#azureblob-component) Component) Sets the stream to which downloaded data will be written. ## Syntax *Delphi Syntax* ```text 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](#localfile-property-azureblob-component) to be cleared. Similarly, setting [LocalFile](#localfile-property-azureblob-component) to a non-empty value will discard any stream set using this method. # SetUploadStream Method ([AzureBlob](#azureblob-component) Component) Sets the stream from which data is read when uploading. ## Syntax *Delphi Syntax* ```text 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](#localfile-property-azureblob-component) to be cleared. Similarly, setting [LocalFile](#localfile-property-azureblob-component) to a non-empty value will discard any stream set using this method. # UndeleteBlob Method ([AzureBlob](#azureblob-component) Component) Undeletes a soft-deleted blob. ## Syntax *Delphi Syntax* ```text procedure UndeleteBlob(Blob: String); ``` ## Remarks This method undeletes the specified soft-deleted *Blob* in the container currently selected by [Container](#container-property-azureblob-component). 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](#deleteblob-method-azureblob-component) for more information about soft-deleting blobs. # UndeleteContainer Method ([AzureBlob](#azureblob-component) Component) Undeletes a soft-deleted container. ## Syntax *Delphi Syntax* ```text 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](#deletecontainer-method-azureblob-component) for more information about soft-deleting containers. # UpdateBlobInfo Method ([AzureBlob](#azureblob-component) Component) Updates a blob's information. ## Syntax *Delphi Syntax* ```text procedure UpdateBlobInfo(Blob: String); ``` ## Remarks This method updates the information of the specified *Blob* in the container currently selected by [Container](#container-property-azureblob-component). There must be an [AzureBlobBlob](#azureblobblob-type) collection whose [Name](#AzureBlobBlob_f_Name) property matches the specified *Blob* name (and whose [Snapshot](#AzureBlobBlob_f_Snapshot) property is empty) before this method is called. When this method is called, the values of the following properties on the aforementioned item are sent to the server (note that the last two are indexed configuration settings): - [ContentDisposition](#AzureBlobBlob_f_ContentDisposition) - [ContentEncoding](#AzureBlobBlob_f_ContentEncoding) - [ContentMD5](#AzureBlobBlob_f_ContentMD5) - [ContentType](#AzureBlobBlob_f_ContentType) - [BlobCacheControl\[i\]](#BlobCacheControl[i]) - [BlobContentLanguage\[i\]](#BlobContentLanguage[i]) 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 properties will be replaced with the values sent in the request. To prevent data loss, applications should call [GetBlobInfo](#getblobinfo-method-azureblob-component) 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](#leaseid-property-azureblob-component), or the request will fail. # UpdateMetadata Method ([AzureBlob](#azureblob-component) Component) Sets the metadata for a blob or container. ## Syntax *Delphi Syntax* ```text procedure UpdateMetadata(Blob: String); ``` ## Remarks This method sets the metadata for the container currently selected by [Container](#container-property-azureblob-component) (if *Blob* is empty), or for the specified *Blob* in that container, to the items currently held by the [Metadata](#metadata-property-azureblob-component) collection. 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](#getblobinfo-method-azureblob-component) or [GetContainerInfo](#getcontainerinfo-method-azureblob-component) 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](#leaseid-property-azureblob-component); 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](#leaseid-property-azureblob-component), or the request will fail. # UpdatePageBlob Method ([AzureBlob](#azureblob-component) Component) Updates a page blob's size and/or sequence number. ## Syntax *Delphi Syntax* ```text 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](#container-property-azureblob-component). *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](#leaseid-property-azureblob-component), or the request will fail. # BlobList Event ([AzureBlob](#azureblob-component) Component) Fires once for each blob returned when listing blobs. ## Syntax *Delphi Syntax* ```text 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](#listblobs-method-azureblob-component) or [GetBlobInfo](#getblobinfo-method-azureblob-component) 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](https://docs.microsoft.com/en-us/rest/api/storageservices/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](#azureblob-component) Component) Fires once for each block returned when listing blocks. ## Syntax *Delphi Syntax* ```text 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](#listblocks-method-azureblob-component) 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](#azureblob-component) Component) Fires once for each container returned when listing containers. ## Syntax *Delphi Syntax* ```text 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](#listcontainers-method-azureblob-component) or [GetContainerInfo](#getcontainerinfo-method-azureblob-component) 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](#azureblob-component) Component) Fired when a document finishes transferring. ## Syntax *Delphi Syntax* ```text type TEndTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer; ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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](#azureblob-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Delphi Syntax* ```text 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](#trappable-errors-azureblob-component) section. # FragmentComplete Event ([AzureBlob](#azureblob-component) Component) Fires after each block in an automatic block-based upload is complete. ## Syntax *Delphi Syntax* ```text type TFragmentCompleteEvent = procedure ( Sender: TObject; FragmentNumber: Integer; FragmentCount: Integer; var Interrupt: Boolean ) of Object; property OnFragmentComplete: TFragmentCompleteEvent read FOnFragmentComplete write FOnFragmentComplete; ``` ## Remarks When [CreateBlob](#createblob-method-azureblob-component) is used to create a new block blob, and more than [SimpleUploadLimit](#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](#createblob-method-azureblob-component) for more information. # Header Event ([AzureBlob](#azureblob-component) Component) Fired every time a header line comes in. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) Fired once for each log message. ## Syntax *Delphi Syntax* ```text 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 is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#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](#azureblob-component) Component) Fires once for each metadata item returned when listing metadata. ## Syntax *Delphi Syntax* ```text 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](#getblobinfo-method-azureblob-component) or [GetContainerInfo](#getcontainerinfo-method-azureblob-component) is called. If the [ListWithMetadata](#ListWithMetadata) configuration setting is enabled, it also fires as metadata for each individual blob or container is returned when [ListBlobs](#listblobs-method-azureblob-component) or [ListContainers](#listcontainers-method-azureblob-component) 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](#azureblob-component) Component) Fires once for each common prefix returned when listing blobs. ## Syntax *Delphi Syntax* ```text 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](#listblobs-method-azureblob-component) is called when [BlobDelimiter](#blobdelimiter-property-azureblob-component) is non-empty. Refer to [BlobDelimiter](#blobdelimiter-property-azureblob-component) for more information. *Prefix* is the common prefix. # Progress Event ([AzureBlob](#azureblob-component) Component) Fires during an upload or download to indicate transfer progress. ## Syntax *Delphi Syntax* ```text 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](#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](#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](#azureblob-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Delphi Syntax* ```text type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; const CertEncoded: String; const 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](#azureblob-component) Component) Fired when secure connection progress messages are available. ## Syntax *Delphi Syntax* ```text 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](#azureblob-component) Component) Fired when a document starts transferring (after the headers). ## Syntax *Delphi Syntax* ```text type TStartTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer; ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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](#azureblob-component) Component) Fired while a document transfers (delivers document). ## Syntax *Delphi Syntax* ```text type TTransferEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; PercentDone: Integer; const Text: String; const 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. The following fields are available: - [ExpiryTime](#AzureAccessPolicy_f_ExpiryTime) - [Id](#AzureAccessPolicy_f_Id) - [Permissions](#AzureAccessPolicy_f_Permissions) - [StartTime](#AzureAccessPolicy_f_StartTime) ## 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](https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl#request-body) 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](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas#specifying-permissions) 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](https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl#request-body) in Azure's documentation. This property can be empty if the access policy doesn't include a start time. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valId: String; valPermissions: String; valStartTime: String; valExpiryTime: String); ``` # AzureBlobBlob Type An Azure storage blob. ## Remarks This type represents an Azure storage blob. The following fields are available: - [BlobType](#AzureBlobBlob_f_BlobType) - [Container](#AzureBlobBlob_f_Container) - [ContentDisposition](#AzureBlobBlob_f_ContentDisposition) - [ContentEncoding](#AzureBlobBlob_f_ContentEncoding) - [ContentLength](#AzureBlobBlob_f_ContentLength) - [ContentMD5](#AzureBlobBlob_f_ContentMD5) - [ContentType](#AzureBlobBlob_f_ContentType) - [CreatedTime](#AzureBlobBlob_f_CreatedTime) - [ETag](#AzureBlobBlob_f_ETag) - [IsLeased](#AzureBlobBlob_f_IsLeased) - [IsLeaseInfinite](#AzureBlobBlob_f_IsLeaseInfinite) - [LeaseState](#AzureBlobBlob_f_LeaseState) - [ModifiedTime](#AzureBlobBlob_f_ModifiedTime) - [Name](#AzureBlobBlob_f_Name) - [SequenceNum](#AzureBlobBlob_f_SequenceNum) - [Snapshot](#AzureBlobBlob_f_Snapshot) - [SoftDeleted](#AzureBlobBlob_f_SoftDeleted) ## Fields **BlobType** *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](https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs) article for more information about blob types. **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](#AzureBlobBlob_f_SoftDeleted) is *True* and/or [Snapshot](#AzureBlobBlob_f_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](#AzureBlobBlob_f_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](#AzureBlobBlob_f_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](#blobs-property-azureblob-component) collection for use with [UpdateBlobInfo](#updateblobinfo-method-azureblob-component) (which looks up items in said collection 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](#AzureBlobBlob_f_Snapshot) is non-empty) has been soft-deleted. ## Constructors *Delphi Syntax* ```text 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. The following fields are available: - [BlockType](#AzureBlobBlock_f_BlockType) - [Id](#AzureBlobBlock_f_Id) - [Size](#AzureBlobBlock_f_Size) ## Fields **BlockType** *TcsAzureBlockTypes* *Default Value: 0* The type of block. When populated by [ListBlocks](#listblocks-method-azureblob-component), this property reflects the block's type (one of the first two values listed below). When used during a [PutBlockList](#putblocklist-method-azureblob-component) operation, this property specifies which block list the server should search for the block Id specified by [Id](#AzureBlobBlock_f_Id). Possible values are: | Value | Meaning During [PutBlockList](#putblocklist-method-azureblob-component) 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. | **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](#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](#listblocks-method-azureblob-component), and will be *-1* in all other cases. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # AzureBlobContainer Type An Azure storage container. ## Remarks This type represents an Azure storage container. The following fields are available: - [DeletedVersion](#AzureBlobContainer_f_DeletedVersion) - [ETag](#AzureBlobContainer_f_ETag) - [HasImmutabilityPolicy](#AzureBlobContainer_f_HasImmutabilityPolicy) - [HasLegalHold](#AzureBlobContainer_f_HasLegalHold) - [IsLeased](#AzureBlobContainer_f_IsLeased) - [IsLeaseInfinite](#AzureBlobContainer_f_IsLeaseInfinite) - [LeaseState](#AzureBlobContainer_f_LeaseState) - [ModifiedTime](#AzureBlobContainer_f_ModifiedTime) - [Name](#AzureBlobContainer_f_Name) - [PublicAccess](#AzureBlobContainer_f_PublicAccess) - [SoftDeleted](#AzureBlobContainer_f_SoftDeleted) ## 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](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-immutable-storage#time-based-retention) 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](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-immutable-storage#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](#AzureBlobContainer_f_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](#AzureBlobContainer_f_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. The following fields are available: - [Name](#AzureMetadata_f_Name) - [Value](#AzureMetadata_f_Value) ## 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 *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # AzureRange Type An Azure byte range. ## Remarks This type represents an Azure byte range. The following fields are available: - [First](#AzureRange_f_First) - [Last](#AzureRange_f_Last) ## 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. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [Encoded](#Certificate_f_Encoded) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [Subject](#Certificate_f_Subject) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* 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. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *TBytes* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which 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: ""* 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: ""* 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: ""* 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: ""* 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: ""* 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: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *Boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* 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 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"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *TBytes* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, 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* 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr component by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | **Subject** *String* *Default Value: ""* 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=example@email.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. **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* 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: ""* 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: ""* 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: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be 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* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_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](#Certificate_f_Usage) property for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". ## Constructors > *Delphi Syntax* ```text constructor Create(); ``` Creates a instance whose properties can be set. > *Delphi Syntax* ```text constructor Create(valEncoded: TBytes); ``` Parses * Encoded * as an X.509 public key. > *Delphi Syntax* ```text constructor Create(valStoreType: TcsCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See 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. > *Delphi Syntax* ```text constructor Create(valStoreType: TcsCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array 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](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *TcsFirewallTypes* *Default Value: 0* 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](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_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: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_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* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) property for details. NOTE: This property is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) property for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this property and the [Password](#Firewall_f_Password) property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component raises an exception. ## Constructors *Delphi Syntax* ```text 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](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value). The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valField: String; valValue: String); ``` # OAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the component the necessary information needed to complete the OAuth process. The following fields are available: - [AccessToken](#OAuthSettings_f_AccessToken) - [AuthorizationCode](#OAuthSettings_f_AuthorizationCode) - [AuthorizationScope](#OAuthSettings_f_AuthorizationScope) - [ClientId](#OAuthSettings_f_ClientId) - [ClientProfile](#OAuthSettings_f_ClientProfile) - [ClientSecret](#OAuthSettings_f_ClientSecret) - [GrantType](#OAuthSettings_f_GrantType) - [RefreshToken](#OAuthSettings_f_RefreshToken) - [RequestRefreshToken](#OAuthSettings_f_RequestRefreshToken) - [ReturnURL](#OAuthSettings_f_ReturnURL) - [ServerAuthURL](#OAuthSettings_f_ServerAuthURL) - [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) - [Timeout](#OAuthSettings_f_Timeout) - [WebAuthURL](#OAuthSettings_f_WebAuthURL) ## 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. **Timeout** *Integer* *Default Value: 60* The amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 60. **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 *Delphi Syntax* ```text 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](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *TcsProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set, the component will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_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](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *False*. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. **Port** *Integer* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) property for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) property is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *TcsProxySSLTypes* *Default Value: 0* 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: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valServer: String; valPort: Integer); ``` *Delphi Syntax* ```text 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. The following fields are available: - [Name](#QueryParam_f_Name) - [Value](#QueryParam_f_Value) ## 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 *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # Config Settings ([AzureBlob](#azureblob-component) 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](#config-method-azureblob-component) method. ### AzureBlob Config Settings **AccumulatePages**: Whether the component should accumulate subsequent pages of results when listing them.This setting controls how the component behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **APIVersion**: The Azure Storage REST API version being used by the component.This setting can be queried to obtain the version of the Azure Storage REST APIs being used by the component. Note that this setting cannot be changed. **AppendedBlockCount**: The number of blocks that have been appended to the append blob.After calling [GetBlobInfo](#getblobinfo-method-azureblob-component) on an append blob, this setting can be queried to determine the number of blocks that have been appended to it. If [GetBlobInfo](#getblobinfo-method-azureblob-component) is called on a block blob or a page blob, this setting will be *-1*. **AutoAddBlocks**: Whether to automatically add an item to the Blocks collection after a block is uploaded.This property specifies whether the component should automatically call [AddBlock](#addblock-method-azureblob-component) to add an item to the [Blocks](#blocks-property-azureblob-component) collection after a block is successfully uploaded with [PutBlock](#putblock-method-azureblob-component). By default, this setting is enabled. **BlobAccessTier[i]**: The access tier of the specified blob.This setting can be queried to obtain the access tier of the blob at index *i*. Refer to Azure's [Blob Storage Access Tiers](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers) article for more information. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobAccessTierChanged[i]**: The time at which the specified blob's access tier was last changed.This setting can be queried to obtain the time at which the access tier of the blob at index *i* was last changed, formatted according to RFC 1123. May be empty. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobAccessTierInferred[i]**: Whether the specified blob's access tier is inferred.This setting can be queried to determine whether the access tier of the blob at index *i* is inferred. If a blob access tier has not been explicitly set, it is inferred based on the account's settings. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobArchiveStatus[i]**: The rehydration status of the specified blob.If the blob at index *i* is being rehydrated, this setting can be queried to obtain its rehydration status. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobCacheControl[i]**: The Cache-Control value of the specified blob.This setting specifies the "Cache-Control" value of the blob at index *i*. (Always empty for uncommitted block blobs.) Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobContentLanguage[i]**: The content language of the specified blob.This setting specifies the content language of the blob at index *i*. (Always empty for uncommitted block blobs.) Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobRetentionDaysLeft[i]**: The number of days left before the specified soft-deleted blob is permanently deleted.If the blob at index *i* is soft-deleted, this setting can be queried to determine how many days are left before it is permanently deleted. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlobSoftDeleteTime[i]**: The time at which the specified blob was soft-deleted.If the blob at index *i* is soft-deleted, this setting can be queried to obtain the soft-deletion time, formatted according to RFC 1123. Valid values for *i* are from *0* to *(BlobCount - 1)*. **BlockListStringSeparator**: The separator string to use when parsing a block list string.This setting specifies what separator string the component should use when parsing values passed for the [PutBlockList](#putblocklist-method-azureblob-component) method's *BlockList* parameter. By default, a comma (*,*) is used as the separator string. **CopyId**: The Id of a copy operation.This setting can be queried to obtain the Id of a copy operation. This setting is populated after calling [CopyBlob](#copyblob-method-azureblob-component), or after calling [GetBlobInfo](#getblobinfo-method-azureblob-component) for the destination blob in a copy operation. **CopyProgress**: The progress of a copy operation.This setting can be queried to obtain the progress of a copy operation, which is representing as the number of bytes copied out of the total number of bytes (e.g., *273/3620*). Calling [CopyBlob](#copyblob-method-azureblob-component) will clear this setting; call [GetBlobInfo](#getblobinfo-method-azureblob-component) for the destination blob in a copy operation to populate it. **CopySourceURL**: The Azure storage URL to use as the source.This setting can be used to explicitly specify the URL of the source blob used by an [AppendBlock](#appendblock-method-azureblob-component), [CreateBlob](#createblob-method-azureblob-component), [CopyBlob](#copyblob-method-azureblob-component), or [PutPages](#putpages-method-azureblob-component) operation. This is typically only needed in advanced scenarios, such as copying across Azure blob storage accounts, or from an Azure file storage resource. 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](#copyblob-method-azureblob-component), the *SrcBlob* parameter will be ignored. Refer to Azure's [Append Block From URL](https://learn.microsoft.com/en-us/rest/api/storageservices/append-block-from-url?tabs=microsoft-entra-id), [Copy Blob From URL](https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url?tabs=microsoft-entra-id), [Put Blob From URL](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob-from-url?tabs=microsoft-entra-id), and [Put Page From URL](https://learn.microsoft.com/en-us/rest/api/storageservices/put-page-from-url?tabs=microsoft-entra-id) API documentation (and particularly, the description of the *x-ms-copy-source* header) for more information. **CopyStatus**: The status of a copy operation.This setting can be queried to obtain the status of a copy operation. Possible values are: - *pending* - *success* - *aborted* - *failed* This setting is populated after calling [CopyBlob](#copyblob-method-azureblob-component), or after calling [GetBlobInfo](#getblobinfo-method-azureblob-component) for the destination blob in a copy operation. **CopyStatusDesc**: The status description for a copy operation.This setting can be queried to obtain a description of a copy operation's status. The description will vary based on the operation's current [CopyStatus](#CopyStatus): - 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](#copyblob-method-azureblob-component) will clear this setting; call [GetBlobInfo](#getblobinfo-method-azureblob-component) for the destination blob in a copy operation to populate it. **DateFormat**: The format to use for date and time.This setting specifies the date format for the date/time fields(e.g ModifiedTime). Below are the custom date and time format specifiers that can be used: | | | | --- | --- | | yyyy | year | | MM | month | | dd | day | | hh | hours | | mm | minutes | | ss | seconds | These format specifiers can be written in any combination. For example: ```csharp AzureBlob.Config("DateFormat=yyyy-MM-ddThh:mm:ss"); ``` ```csharp 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. **DeletePermanently**: Whether a blob should be permanently deleted.This setting controls whether a blob will be permanently deleted when calling the [DeleteBlob](#deleteblob-method-azureblob-component) method. Normally, the [DeleteBlob](#deleteblob-method-azureblob-component) method will only *soft-delete* blobs (and snapshots). Soft-deleted blobs and snapshots can be undeleted before their retention period expires by calling the [UndeleteBlob](#undeleteblob-method-azureblob-component) method. By default, this setting is disabled. **DownloadTempFile**: The temporary file used when downloading encrypted data.This setting specifies the temporary file used when downloading encrypted data. When downloading encrypted data with [LocalFile](#localfile-property-azureblob-component) set, the component will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data is decrypted to [LocalFile](#localfile-property-azureblob-component). 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. **EncodeBlockIds**: Whether the component should automatically Base64-encode and -decode block Ids.This setting controls whether the component will automatically Base64-encode block Ids as they are sent to the server, and Base64-decode them as they are received. Refer to the [Id](#AzureBlobBlock_f_Id) property for more information. By default, this setting is enabled. **EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the component will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-azureblob-component). This setting accepts a hex encoded value. **EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the component will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-azureblob-component). This setting accepts a hex encoded value. **EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [EncryptionPassword](#encryptionpassword-property-azureblob-component). Possible values are: - 0 (default) - PBKDF1 - 1 - PBKDF2 Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used. **Endpoint**: The Azure Storage endpoint suffix that the component should use.This setting specifies the base Azure Storage endpoint suffix that the component should use. By default, the component uses the global Azure Storage endpoint, *https://[ACCOUNT].[blob|file]**.core.windows.net*** (this setting controls the bolded suffix only). 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](https://docs.microsoft.com/en-us/graph/deployments), 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](https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-national-cloud) article for more information. **FragmentSize**: The block size to use when uploading a new block blob.When [CreateBlob](#createblob-method-azureblob-component) is used to create a new block blob, and more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data is provided, the component will automatically split the upload data up into blocks to perform the upload. This setting specifies the block size to use. 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](#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. **IfMatch**: The ETag which the blob must currently have in order for a request to succeed.If this setting is non-empty, the component will *If-Match* header with the specified ETag value in the request. 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](#otherheaders-property-azureblob-component) property can be used to include additional conditional headers as needed; refer to the Azure Blob REST API documentation for more information. **IncludeMetadata**: Whether to include metadata items when listing blobs or containers.This setting indicates whether the server should include metadata items in the results returned by [ListBlobs](#listblobs-method-azureblob-component) or [ListContainers](#listcontainers-method-azureblob-component). If this setting is enabled, the [MetadataList](#metadatalist-event-azureblob-component) event will fire once for each metadata item returned. By default, this setting is disabled, and results are returned without metadata items. Note that calls to [ListBlobs](#listblobs-method-azureblob-component) and [ListContainers](#listcontainers-method-azureblob-component) will never repopulate the [Metadata](#metadata-property-azureblob-component) collection, regardless of this setting's value. **IncludeSnapshots**: Whether blob snapshots should be included when listing blobs.This setting specifies whether blob snapshots should be included when [ListBlobs](#listblobs-method-azureblob-component) is called. By default, this setting is disabled. **IncludeSoftDeleted**: Whether soft-deleted blobs and containers should be included when listing.This setting specifies whether soft-deleted blobs (and blob snapshots, if [IncludeSnapshots](#IncludeSnapshots) is enabled) and containers should be included when [ListBlobs](#listblobs-method-azureblob-component) and [ListContainers](#listcontainers-method-azureblob-component) are called, respectively. By default, this setting is disabled. **IncludeSystemContainers**: Whether to include system containers when listing containers.This setting indicates whether the server should include system containers in the results returned by [ListContainers](#listcontainers-method-azureblob-component), such as *$logs* and *$changefeed*. By default, this setting is disabled, and results are returned without system containers. Note that calls to [ListBlobs](#listblobs-method-azureblob-component) and [ListContainers](#listcontainers-method-azureblob-component) will never repopulate the [Metadata](#metadata-property-azureblob-component) collection, regardless of this setting's value. **IncludeUncommittedBlobs**: Whether uncommitted block blobs should be included when listing blobs.This setting specifies whether uncommitted block blobs should be included when [ListBlobs](#listblobs-method-azureblob-component) is called. Uncommitted block blobs are those for which one or more blocks have been uploaded, but none have been committed. By default, this setting is disabled. **LeaseBreakPeriod**: The approximate number of seconds the lease will remain in the 'breaking' state.After a successful call to [Lease](#lease-method-azureblob-component) where *Break (4)* was passed for the *LeaseAction* parameter, this setting will reflect the approximate number of seconds that the lease will remain in the "breaking" state (a value of *0* indicates that the lease was broken immediately). A successful call to [Lease](#lease-method-azureblob-component) where *LeaseAction* was *not* *Break (4)* will set this setting back to *-1*. **MaxResults**: The maximum number of results to return when listing blobs or containers.This setting specifies the maximum number of results that should be returned by a call to [ListBlobs](#listblobs-method-azureblob-component) or [ListContainers](#listcontainers-method-azureblob-component). If this setting is *-1* (default), the server's default (*5000*) is used. Acceptable values are *1* to *5000* (inclusive). **PageRangeCleared[i]**: Whether the specified page range has been cleared.After calling [ListPageRanges](#listpageranges-method-azureblob-component) with [PreviousSnapshot](#PreviousSnapshot) set to a non-empty value, this setting can be queried to determine if the page range at index *i* has been completely cleared since the snapshot specified by [PreviousSnapshot](#PreviousSnapshot). 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](#PreviousSnapshot) was empty when [ListPageRanges](#listpageranges-method-azureblob-component) was last called, this setting will always return *False*. Valid values for *i* are from *0* to *(PageRangeCount - 1)*. **Prefix[i]**: The i'th common prefix returned.When [StorePrefixList](#StorePrefixList) is enabled, this setting can be used to retrieve the common prefixes returned by the most recent [ListBlobs](#listblobs-method-azureblob-component) request. Refer to that method, as well as the [BlobDelimiter](#blobdelimiter-property-azureblob-component) property, for more information. Valid values for *i* are from *0* to *([PrefixCount](#PrefixCount) - 1)*. **PrefixCount**: The number of common prefixed returned.When [StorePrefixList](#StorePrefixList) is enabled, this setting reflects the number of common prefixes returned by the most recent [ListBlobs](#listblobs-method-azureblob-component) request. This setting is always *-1* when [StorePrefixList](#StorePrefixList) is disabled. **PreviousSnapshot**: An opaque DateTime value that identifies the snapshot to list page range changes since.If this setting is non-empty when [ListPageRanges](#listpageranges-method-azureblob-component) is called, the server will return a list of page ranges that differ between the snapshot that this setting specifies, and the base page blob specified by the [ListPageRanges](#listpageranges-method-azureblob-component) method's *PageBlob* parameter. Any page ranges that have been completely cleared are explicitly marked as such; use the [PageRangeCleared\[i\]](#PageRangeCleared[i]) after calling [ListPageRanges](#listpageranges-method-azureblob-component) to determine whether a page range was changed or cleared. If the [Snapshot](#snapshot-property-azureblob-component) property is *also* non-empty when [ListPageRanges](#listpageranges-method-azureblob-component) 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](#snapshot-property-azureblob-component) specifies. ([Snapshot](#snapshot-property-azureblob-component) 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. **ProgressAbsolute**: Whether the component should track transfer progress absolutely.This setting controls whether the component tracks upload and download progress absolutely or relatively, with regards to the values reported via the [Progress](#progress-event-azureblob-component) event when an interrupted transfer is resumed. If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [Progress](#progress-event-azureblob-component) 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](#progress-event-azureblob-component) event will start at *0* rather than from the number of bytes already transferred. Refer to the [Progress](#progress-event-azureblob-component) event for more information. **ProgressStep**: How often the progress event should be fired, in terms of percentage.This setting controls how often the component will fire the [Progress](#progress-event-azureblob-component) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive. The default value, *1*, will cause the [Progress](#progress-event-azureblob-component) event to fire each time the event's *PercentDone* parameter value increases by one percent. Setting this setting to *0* will cause the [Progress](#progress-event-azureblob-component) event to fire *every* time data is transferred. Note that the [Progress](#progress-event-azureblob-component) 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. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **SendMetadata**: Whether to send metadata items when creating blobs and containers.This setting specifies whether the component should include [Metadata](#metadata-property-azureblob-component) items when creating blobs or containers with [CreateBlob](#createblob-method-azureblob-component) or [CreateContainer](#createcontainer-method-azureblob-component). By default, this setting is disabled, and blobs and containers are created without metadata. **SendMetadataOnCopy**: Whether to send metadata items when copying blobs.This setting specifies whether the component should include [Metadata](#metadata-property-azureblob-component) items, to apply to the *destination* blob, when [CopyBlob](#copyblob-method-azureblob-component) is called. If this setting is disabled (default), or if this setting is enabled but there are no [Metadata](#metadata-property-azureblob-component) items, then the server will copy the source blob's current metadata to the destination blob. **SendMetadataOnPutBlockList**: Whether to send metadata items when committing a new block list.This setting specifies whether the component should include [Metadata](#metadata-property-azureblob-component) items when a new block list is committed to a block blob using [PutBlockList](#putblocklist-method-azureblob-component). 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](#putblocklist-method-azureblob-component)'s documentation). **SendMetadataOnSnapshot**: Whether to send metadata items when creating a blob snapshot.This setting specifies whether the component should include [Metadata](#metadata-property-azureblob-component) items when creating a blob snapshot with [CreateSnapshot](#createsnapshot-method-azureblob-component). If this setting is disabled (default), or if this setting is enabled but there are no [Metadata](#metadata-property-azureblob-component) items, the server will copy the base blob's current metadata to the snapshot. **SharedAccessSignature**: Specifies a SAS token to use for authentication.This setting can be used to specify a URL-encoded Shared Access Signature (SAS) token that will be included in the request. To generate a Shared Access Signature for specific resources, you can use the [GetLink](#getlink-method-azureblob-component) method. **SimpleUploadLimit**: The maximum data size the component should attempt to upload directly when creating a block blob.When [CreateBlob](#createblob-method-azureblob-component) is used to create a new block blob, the component will automatically split the upload data into blocks to perform the upload if its size is greater than the amount specified by this setting. If the upload data size is less than or equal to the amount specified by this setting, it will be uploaded directly in the blob creation request. 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. **StorePrefixList**: Whether to store the common prefixes returned when listing blobs.If this setting is enabled, the component will populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) settings anytime [ListBlobs](#listblobs-method-azureblob-component) is called. By default, this setting is disabled. **TempPath**: The path to the directory where temporary files are created.This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and DownloadFile for more information. **UserDelegationKey**: A user delegation key to use for constructing SAS tokens.NOTE: This setting is not currently implemented; it is reserved for future use. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#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](#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. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "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. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### OAuth Config Settings **OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated. **OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [Authorize](#authorize-method-azureblob-component) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. | **OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *True* and the [Authorization](#authorization-property-azureblob-component) property is not set, the component will automatically get a new access token if it has the necessary properties to do so without user interaction. For example, when using the Authorization Code grant type, the [RefreshToken](#OAuthSettings_f_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. **OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the component will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the component will wait indefinitely. **OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [Authorize](#authorize-method-azureblob-component) if it is empty. 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. **OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the component is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath). **OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. 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. | Here are some examples of valid XPaths and some common claims: | 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](#OAuthJWTXText). **OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [ClientProfile](#OAuthSettings_f_ClientProfile) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance: ```text 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. ```text for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName[" + i + "]"); string value = component.Config("OAuthParamValue[" + i + "]"); } ``` **OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the [GrantType](#OAuthSettings_f_GrantType) is set to the password grant type and [Authorize](#authorize-method-azureblob-component) is called. **OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *True*. Possible values are: - 1 (Plain) - 2 (S256/SHA256 - default) **OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [Authorize](#authorize-method-azureblob-component) method and the [WebAuthURL](#OAuthSettings_f_WebAuthURL) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [ClientProfile](#OAuthSettings_f_ClientProfile), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *True* (default), the [Reset](#reset-method-azureblob-component) method will reset the OAuth settings including any authorization fields like [AccessToken](#OAuthSettings_f_AccessToken) and [RefreshToken](#OAuthSettings_f_RefreshToken). This means the [Authorize](#authorize-method-azureblob-component) method must be called again to get new authorization information. When set to *False*, the [Reset](#reset-method-azureblob-component) method will **not** reset the [OAuth](#oauth-property-azureblob-component) property and the OAuth* configuration settings. This allows for the component to be reset without having to get authorization again. **OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *True* (default), the same embedded web server instance will be used for multiple requests. If set to *False* the embedded web server will be created and destroyed on each call to [Authorize](#authorize-method-azureblob-component) **OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Gmail gmail = new Gmail(); gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); Console.WriteLine(gmail.Config("OAuthTransferredRequest")); ``` C++ ```text Gmail gmail; gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); printf("%s\r\n", gmail.Config("OAuthTransferredRequest")); ``` **OAuthUsePKCE**: Specifies if PKCE should be used.If set to *True* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [GrantType](#OAuthSettings_f_GrantType). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. **OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*. 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](#authorize-method-azureblob-component) is called. In certain cases, it is required to start the webserver before calling [Authorize](#authorize-method-azureblob-component). For example, if the [ReturnURL](#OAuthSettings_f_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](#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. **OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL. The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword). [OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, 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](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are: | | | | --- | --- | | 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. | Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate. 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=example@email.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](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [Authorize](#authorize-method-azureblob-component) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser. **OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [ClientProfile](#OAuthSettings_f_ClientProfile) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [ReturnURL](#OAuthSettings_f_ReturnURL). This should be set to the hostname only, not the full URL. The default value is *localhost*. **OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server. **OAuthWebServerResponse**: The custom response that will be displayed to the user.When [Authorize](#authorize-method-azureblob-component) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. **OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the component adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The component only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms. When True, the component adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". 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. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#localfile-property-azureblob-component). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-azureblob-component). This may be used in conjunction with [Range](#range-property-azureblob-component) to resume a failed download. This is applicable only when [LocalFile](#localfile-property-azureblob-component) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. 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](#authorization-property-azureblob-component) property in the form 'Basic [encoded-user-password]'. **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-azureblob-component) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the component.If set to True, the URL passed to the component will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. 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 **GetOn302Redirect**: If set to True the component will perform a GET on the new location.The default value is False. If set to True, the component will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#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. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-azureblob-component) event. 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). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. 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. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the component.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. 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. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-azureblob-component) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-azureblob-component) setting 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 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](#localhost-property-azureblob-component) 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). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. 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. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#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](#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](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-azureblob-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-azureblob-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-azureblob-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. 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". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. 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. **ReuseSSLSession**: Determines if the SSL session is reused. 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. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-azureblob-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-azureblob-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component raises an exception. 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. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component raises an exception. 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. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. 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](#sslstatus-event-azureblob-component) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. 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](#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](#sslprovider-property-azureblob-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-azureblob-component) 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 Example values when [SSLProvider](#sslprovider-property-azureblob-component) is set to *Internal*include the following: ```text 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](#sslprovider-property-azureblob-component) 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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. 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 first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-azureblob-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-azureblob-component) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#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](#sslprovider-property-azureblob-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-azureblob-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-azureblob-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-azureblob-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-azureblob-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-azureblob-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. 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](#sslprovider-property-azureblob-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 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. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-azureblob-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. 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: ```csharp 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. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-azureblob-component) 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) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. 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" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* 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) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-azureblob-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. 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. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. 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 **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - 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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *True*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. 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](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the component will use the system security libraries by default to perform cryptographic functions where applicable. 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](#azureblob-component) 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](#RawRequest) or [RawResponse](#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](#localfile-property-azureblob-component) already exists and [Overwrite](#overwrite-property-azureblob-component) 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](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [LocalFile](#localfile-property-azureblob-component) (or the current value of [LocalFile](#localfile-property-azureblob-component) 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. The error description contains the 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 | Cannot 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](#localhost-property-azureblob-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#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). |