(SQL Server) Azure Blob - Get Tags (Check if Blob Exists)

See more Azure Cloud Storage Examples

Gets the user-defined tags for a specified blob. This can also be used as a way to check to see if a blob exists.

For more information, see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-tags

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
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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.blob.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', 'Blob'
    -- 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: Content-Length, x-ms-date, Authorization.  These headers
    -- are automatically set by Chilkat.

    -- The Azure blob container is "test", the file is "helloWorld.txt"
    -- Add "?comp=tags" to get the user-defined tags instead of the actual blob content.
    DECLARE @sb int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sb OUT

    EXEC sp_OAMethod @rest, 'FullRequestNoBodySb', @success OUT, 'GET', '/test/helloWorldajdfadf.txt?comp=tags', @sb
    IF @success = 0
      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 '---'

        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
        EXEC @hr = sp_OADestroy @sb
        RETURN
      END

    -- A typical blob with no tags will return this:

    -- <?xml version="1.0" encoding="utf-8"?>
    -- <Tags><TagSet/></Tags>

    -- If the blob does not exist, you get this:

    -- <?xml version="1.0" encoding="utf-8"?>
    -- <Error>
    --     <Code>BlobNotFound</Code>
    --     <Message>The specified blob does not exist.
    -- 	RequestId:fcfefdd9-301e-001a-2135-3a23d2000000
    -- 	Time:2023-02-06T14:17:00.7805577Z
    --     </Message>
    -- </Error>

    EXEC sp_OAMethod @sb, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    -- To see if we got Tags or an Error, then examine the XML.
    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, 'LoadSb', @success OUT, @sb, 1

    -- Examine the tag..
    EXEC sp_OAMethod @xml, 'TagEquals', @iTmp0 OUT, 'Tags'
    IF @iTmp0 = 1
      BEGIN

        PRINT 'Blob exists!'
      END
    ELSE
      BEGIN

        EXEC sp_OAMethod @xml, 'ChildContentMatches', @iTmp0 OUT, 'Code', 'BlobNotFound', 1
        IF @iTmp0 = 1
          BEGIN

            PRINT 'Blob does not exist.'
          END
        ELSE
          BEGIN

            PRINT 'Some other error...'
          END

      END


    PRINT 'Success.'

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


END
GO