(SQL Server) Azure File Service: List Shares

Sample code to list the file shares in an Azure storage account.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @iTmp1 int
    DECLARE @iTmp2 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- Azure File Service Example: List all the file shares in a storage account.
    -- See also: https://docs.microsoft.com/en-us/rest/api/storageservices/list-shares

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @rest int
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Connect to the Azure Storage Blob Service
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    -- In this example, the storage account name is "chilkat".
    DECLARE @success int
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'chilkat.file.core.windows.net', @port, @bTls, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    -- Provide Azure Cloud credentials for the REST call.
    DECLARE @azAuth int
    -- Use "Chilkat_9_5_0.AuthAzureStorage" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.AuthAzureStorage', @azAuth OUT

    EXEC sp_OASetProperty @azAuth, 'AccessKey', 'AZURE_ACCESS_KEY'
    -- The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    EXEC sp_OASetProperty @azAuth, 'Account', 'chilkat'
    EXEC sp_OASetProperty @azAuth, 'Scheme', 'SharedKey'
    EXEC sp_OASetProperty @azAuth, 'Service', 'File'
    -- This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    EXEC sp_OASetProperty @azAuth, 'XMsVersion', '2021-08-06'
    EXEC sp_OAMethod @rest, 'SetAuthAzureStorage', @success OUT, @azAuth

    -- Note: The application does not need to explicitly set the following
    -- headers: x-ms-date, Authorization.  These headers
    -- are automatically set by Chilkat.

    -- Send the GET request to list the shares.
    DECLARE @responseStr nvarchar(4000)
    EXEC sp_OAMethod @rest, 'FullRequestNoBody', @responseStr OUT, 'GET', '/?comp=list'
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @azAuth
        RETURN
      END

    -- When successful, the Azure Storage service will respond with a 200 response status code,
    -- with an XML response body.

    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        -- Examine the request/response to see what happened.

        EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
        PRINT 'response status code = ' + @iTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseStatusText', @sTmp0 OUT
        PRINT 'response status text = ' + @sTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT 'response header: ' + @sTmp0

        PRINT 'response body (if any): ' + @responseStr

        PRINT '---'

        EXEC sp_OAGetProperty @rest, 'LastRequestStartLine', @sTmp0 OUT
        PRINT 'LastRequestStartLine: ' + @sTmp0

        EXEC sp_OAGetProperty @rest, 'LastRequestHeader', @sTmp0 OUT
        PRINT 'LastRequestHeader: ' + @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @azAuth
        RETURN
      END

    -- Load the XML response for parsing.
    -- An example of the response XML is shown below.
    DECLARE @xml int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OAMethod @xml, 'LoadXml', @success OUT, @responseStr

    EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    -- Here's a sample response:

    -- <?xml version="1.0" encoding="utf-8" ?>
    -- <EnumerationResults ServiceEndpoint="https://chilkat.file.core.windows.net/">
    --     <Shares>
    --         <Share>
    --             <Name>beardie</Name>
    --             <Properties>
    --                 <Last-Modified>Mon, 26 Jun 2017 21:24:57 GMT</Last-Modified>
    --                 <Etag>"0x8D4BCD9CBD872E5"</Etag>
    --                 <Quota>5120</Quota>
    --             </Properties>
    --         </Share>
    --         <Share>
    --             <Name>pip</Name>
    --             <Properties>
    --                 <Last-Modified>Mon, 26 Jun 2017 21:24:44 GMT</Last-Modified>
    --                 <Etag>"0x8D4BCD9C3D823D1"</Etag>
    --                 <Quota>5120</Quota>
    --             </Properties>
    --         </Share>
    --     </Shares>
    --     <NextMarker />
    -- </EnumerationResults>

    -- Let's iterate over the file shares
    DECLARE @lastMod int
    -- Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @lastMod OUT

    DECLARE @numShares int
    EXEC sp_OAMethod @xml, 'NumChildrenAt', @numShares OUT, 'Shares'
    DECLARE @i int
    SELECT @i = 0
    WHILE @i < @numShares
      BEGIN


        PRINT '---- Share ' + @i + ' ----'
        EXEC sp_OASetProperty @xml, 'I', @i

        EXEC sp_OAMethod @xml, 'GetChildContent', @sTmp0 OUT, 'Shares|Share[i]|Name'
        PRINT 'Name: ' + @sTmp0
        EXEC sp_OAMethod @xml, 'GetChildContent', @sTmp0 OUT, 'Shares|Share[i]|Properties|Last-Modified'
        EXEC sp_OAMethod @lastMod, 'SetFromRfc822', @success OUT, @sTmp0
        DECLARE @dt int
        EXEC sp_OAMethod @lastMod, 'GetDtObj', @dt OUT, 1

        EXEC sp_OAGetProperty @dt, 'Year', @iTmp0 OUT

        EXEC sp_OAGetProperty @dt, 'Month', @iTmp1 OUT

        EXEC sp_OAGetProperty @dt, 'Day', @iTmp2 OUT
        PRINT 'Last-Modified YMD: ' + @iTmp0 + ',' + @iTmp1 + ',' + @iTmp2
        EXEC @hr = sp_OADestroy @dt

        SELECT @i = @i + 1
      END

    -- Output for the above loop:

    -- ---- Share 0 ----
    -- Name: beardie
    -- Last-Modified YMD: 2017,6,26
    -- ---- Share 1 ----
    -- Name: pip
    -- Last-Modified YMD: 2017,6,26
    -- 


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @azAuth
    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @lastMod


END
GO