AuthAzureStorage SQL Server Reference Documentation
AuthAzureStorage
Current Version: 11.6.0
Chilkat.AuthAzureStorage
Hold the storage account name and Base64 account access key used to sign
Azure Storage REST requests.
Configure Azure Storage authentication using
Specify the Azure Storage service being accessed, such as
Set the
Use the configured object with
Pair this authentication object with manually constructed REST requests
when application code needs direct control over Azure Storage operations.
For an extended overview, see
AuthAzureStorage Class Overview.
Authenticate Azure Storage REST requests with account-key Shared Key signing.
Chilkat.AuthAzureStorage is a credential object for Azure
Storage Services authentication. It stores the storage account name, Base64
account access key, Azure Storage service type, authentication scheme, and
x-ms-version API version used when signing REST requests for
Blob, Queue, File, or Table storage.
Azure Storage credentials
Shared Key signing
SharedKey or
SharedKeyLite, depending on the service and request style.
Service targeting
Blob, Queue, File, or
Table.
API version header
x-ms-version value required by the Azure Storage
REST API version being used.
REST integration
Chilkat.Rest so requests are
signed automatically before being sent.
Low-level control
AuthAzureStorage object, set the storage
Account, Base64 AccessKey, Service,
Scheme, and XMsVersion, then attach it to a
Chilkat.Rest request workflow. Use
AuthAzureStorage for Shared Key authorization headers; use
Chilkat.AuthAzureSAS when the request should be authorized with
a SAS query token instead.
Object Creation
DECLARE @hr int
DECLARE @authAzureStorage int
EXEC @hr = sp_OACreate 'Chilkat.AuthAzureStorage', @authAzureStorage OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @authAzureStorage ...
EXEC @hr = sp_OADestroy @authAzureStorageT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.AuthAzureStorage.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @authAzureStorage, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
AccessKey
EXEC sp_OASetProperty @authAzureStorage, 'AccessKey', @sValue
Account
EXEC sp_OASetProperty @authAzureStorage, 'Account', @sValue
The Azure storage account name. (A storage account can contain zero or more containers. A container contains properties, metadata, and zero or more blobs. A blob is any single entity comprised of binary data, properties, and metadata. )
topDebugLogFilePath
EXEC sp_OASetProperty @authAzureStorage, 'DebugLogFilePath', @sValue
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
EXEC sp_OASetProperty @authAzureStorage, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topScheme
EXEC sp_OASetProperty @authAzureStorage, 'Scheme', @sValue
Can be SharedKey or SharedKeyLite. The default value is SharedKey.
Service
EXEC sp_OASetProperty @authAzureStorage, 'Service', @sValue
Can be Blob, Queue, File, or Table. The default is Blob.
Note: Authentication for the Table service did not work in versions prior to v9.5.0.83.
VerboseLogging
EXEC sp_OASetProperty @authAzureStorage, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
XMsVersion
EXEC sp_OASetProperty @authAzureStorage, 'XMsVersion', @sValue
If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests. The default value is 2014-02-14.