(Ruby) Azure Storage: Set Blob Service Properties

Azure Storage Blob Service REST API: Sample code to set a blob's service properties.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# Azure Blob Service Example: Set Blob Service Properties
# See also: https://msdn.microsoft.com/en-us/library/azure/hh452235.aspx

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

rest = Chilkat::CkRest.new()

# Connect to the Azure Storage Blob Service
bTls = true
port = 443
bAutoReconnect = true
# In this example, the storage account name is "chilkat".
success = rest.Connect("chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide Azure Cloud credentials for the REST call.
azAuth = Chilkat::CkAuthAzureStorage.new()
azAuth.put_AccessKey("AZURE_ACCESS_KEY")
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
azAuth.put_Account("chilkat")
azAuth.put_Scheme("SharedKey")
azAuth.put_Service("Blob")
# This causes the "x-ms-version: 2020-08-04" header to be automatically added.
azAuth.put_XMsVersion("2020-08-04")
success = rest.SetAuthAzureStorage(azAuth)

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

# This example will set logging properties.  The XML body of the request
# will look like this:

# <?xml version="1.0" encoding="utf-8"?>
# <StorageServiceProperties>
#     <Logging>
#         <Version>version-number</Version>
#         <Delete>true|false</Delete>
#         <Read>true|false</Read>
#         <Write>true|false</Write>
#         <RetentionPolicy>
#             <Enabled>true|false</Enabled>
#             <Days>number-of-days</Days>
#         </RetentionPolicy>
#     </Logging>

# Build the request:
xml = Chilkat::CkXml.new()
xml.put_Tag("StorageServiceProperties")
# xLogging is a CkXml
xLogging = xml.NewChild("Logging","")
xLogging.NewChild2("Version","1.0")
xLogging.NewChild2("Delete","true")
xLogging.NewChild2("Read","true")
xLogging.NewChild2("Write","true")
# xRetension is a CkXml
xRetension = xLogging.NewChild("RetentionPolicy","")
xRetension.NewChild2("Enabled","true")
xRetension.NewChild2("Days","7")

# The expected response is a 202 response status code with no response body.
responseStr = rest.fullRequestString("PUT","/?restype=service&comp=properties",xml.getXml())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# When successful, the Azure Storage service will respond with a 202 response code,
# with no response body.
if (rest.get_ResponseStatusCode() != 202)
    # Examine the request/response to see what happened.
    print "response status code = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "response status text = " + rest.responseStatusText() + "\n";
    print "response header: " + rest.responseHeader() + "\n";
    print "response body (if any): " + responseStr + "\n";
    print "---" + "\n";
    print "LastRequestStartLine: " + rest.lastRequestStartLine() + "\n";
    print "LastRequestHeader: " + rest.lastRequestHeader() + "\n";
    exit
end

print "Success: Blob service properties updated!" + "\n";