Basic configuration properties - Basic configuration properties - Alfresco - Alfresco Content Connector for Azure - Alfresco/Alfresco-Content-Connector-for-Azure/3.1/Alfresco-Content-Connector-for-Azure/Alfresco-Content-Connector-for-Azure/Configure/Basic-configuration-properties - 3.1

Alfresco Content Connector for Azure

Platform
Alfresco
Product
Alfresco Content Connector for Azure
Release
3.1
ft:lastPublication
2026-05-06T14:44:21.907000
ft:locale
en-US
ArchiveStatus
Archived

The following properties needs to be set up specifically for your environment and access to Azure storage.

  1. Open the <classpathRoot>/alfresco-global.properties file.

    If you have existing content in a local contentstore (i.e. where Content Services is deployed on-premises), it won't be migrated automatically but it'll still be available in the original location. New content will always be written to Azure.

  2. Add the connector.az.authentication.mode property, for example:

    connector.az.authentication.mode=
    

    The authentication modes and supported values (shown in brackets) are:

    • Shared Key credentials (sharedKey)
    • Shared Access Signatures (sas)
    • Managed Identity with Azure AD (managedIdentityAD)
    • Application registered with Azure AD (applicationAD)
    • Key Vault with Secret Key (keyVault)
  3. Choose your preferred authentication mechanism, and add any additional properties based on the following options.

    The Azure storage account name must be unique across all Azure accounts. See Azure storage account overview for more.

    Remember to replace the placeholder values (i.e. my*) with your own values.

    1. Using Azure storage Shared Key credentials:

      connector.az.account.name=myazureaccount
      connector.az.authentication.mode=sharedKey
      connector.az.account.key=mysharedkey
      

      connector.az.account.key is the Azure storage account access key, for example:

      connector.az.account.key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      

      See Azure storage account overview for more.

    2. Using Azure storage Shared Access Signatures (SAS):

      connector.az.account.name=myazureaccount
      connector.az.authentication.mode=sas
      connector.az.container.sasToken=mysastoken
      

      See Create a user delegation SAS for a container for more.

    3. Using Azure Managed Identity with Azure Active Directory (AD):

      connector.az.account.name=myazureaccount
      connector.az.authentication.mode=managedIdentityAD
      

      See Configure managed identities for Azure resources for more.

Note

This authentication mode can only be used in an Azure cloud environment, such as an Azure Virtual Machine running with RBAC access granted to Azure storage account. See RBAC roles for blobs and queues for more details.

  1. Using Azure Application with Azure Active Directory (AD):

    connector.az.account.name=myazureaccount
    connector.az.authentication.mode=applicationAD
    connector.az.application.clientId=myclientid
    connector.az.application.clientSecret=myclientsecret
    connector.az.application.tenantId=mytenantid
    

    See Acquire a token from Azure AD for authorizing requests from a client application for more.

  2. Using Azure Key Vault with Storage Shared Key stored as Key Vault secret:

    connector.az.account.name=myazureaccount
    connector.az.authentication.mode=keyVault
    connector.az.application.clientId=myclientid
    connector.az.application.clientSecret=myclientsecret
    connector.az.application.tenantId=mytenantid
    connector.az.keyVault.name=mykeyvaultname
    connector.az.keyVault.secret.name=mykeyvaultsecretname
    

    See Manage storage account access keys for more.

  1. Add the connector.az.containerName property, for example:

    connector.az.containerName=myazurecontainer
    

    Within a given storage account, every container must have a unique name. If the container does not already exist, it will be created, but the name must not have already been taken. Note that two storage accounts can have containers with the same name. For more details on what a content store is, see Manage content stores.

    See Naming and Referencing Containers, Blobs, and Metadata for more.

  2. Add the connector.az.deleted.containerName property, for example:

    connector.az.deleted.containerName=myazuredeletedcontainer
    

    This is the container that stores content once it has been deleted. For more details on what a content store is, see Manage content stores.

  3. Set where the cached content is stored, and how much cache size you need.

    The cached content location (and default value) is dir.cachedcontent=${dir.root}/cachedcontent.

    See CachingContentStore properies for more information on the caching content store.

    Note

    The size of the local caching content store can be configured as necessary to limit its use to a maximum overall size or by files with a maximum file size.

    For example:

    # Maximum disk usage for the cache in MB
    system.content.caching.maxUsageMB=51200
    # Maximum size of files which can be stored in the cache in MB (zero implies no limit)
    system.content.caching.maxFileSizeMB=0
    

    The Azure Connector supports multipart uploads where files larger than 20MB are split. The file upload is attempted and retried, in case there are issues, up to a specific limit.

    !!! Note Starting from version 1.2, the Azure Connector has the deleted content store disabled by default, since this feature is already present in Microsoft's Azure Storage services. For details on how to re-enable it, see Azure Connector deleted content store.

  4. Save the alfresco-global.properties file.

    You are now ready to start Content Services.