Establishing the Connection to Azure Blob Storage

{"URL":["/*.*/awa/pa_view_pa_view_CONN_blob"],"heroDescriptionIdentifier":"ice_hero_CONN_Azure_Blob","customCards":[{"id":"ice_specific_CONN_Azure_Blob","title":"Defining the Connection Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_BLOB/*.*/Agent%20Guide/Content/Azure_Blob/Azure_Blob_EstablishConnection.htm","languages":["en-us"]},{"id":"ice_video_CONN_Azure_Authentication","title":"Watch the Video: Azure Authentication Methods","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_BLOB/*.*/Agent%20Guide/Content/_CommonTopics/Video_Azure_AuthMethods.htm","languages":["en-us"]},{"id":"ice_Proxy_CONN_Azure_Blob","title":"Defining the Proxy Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_BLOB/*.*/Agent%20Guide/Content/Azure_Blob/Azure_Blob_EstablishConnection.htm","languages":["en-us"]},{"id":"ice_related_information_CONN_Azure_Blob","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_BLOB/*.*/Agent%20Guide/Content/Azure_Blob/Azure_Blob_EstablishConnection.htm","languages":["en-us"]}]}

A Connection object contains the parameters that make the communication between the Agent and the target system possible. These parameters (target system endpoint, login data and so on) are required to authenticate on and connect to the target cloud solution.

As an administrator user, you create the Blob Connection objects that provide the log in data required to establish the connection to the Azure Blob Storage system.

This page includes the following:

Adding an Azure Blob Storage Connection Object

  1. In the Automic Web Interface, go to the Process Assembly perspective. It opens to the Explorer view which contains the list of jobs that are available to you in your system.

  2. You have two options:

    • Right-click anywhere on the list and select Add > Add Object.

    • Click the Add Object button on the toolbar.

  3. On the Add Object dialog, start typing the name of the relevant integration in the Search field.

  4. Select the corresponding Connection object and click Add. The Object Name dialog is displayed.

  5. Enter a descriptive Name.

  6. Optionally, enter a short and descriptive Title that helps you recognize the purpose of the object.

  7. Click OK. A new page opens where you can start with the object definitions.

Blob Page

This page contains a Connection and a Proxy section.

Connection Section

On this page you specify the parameters that are necessary to connect to your Azure Blob Storage environment:

  • Endpoint

    URL that identifies the network address of the storage account in your Azure Blob Storage environment. This URL contains the name of the storage account with which the Agent will interact when connected to the Azure Blob Storage environment through this Connection object.

    Example:

    https://myaccount.blob.core.windows.net, where myaccount is the name of your storage account.

    Important!

    The example above describes the correct endpoint syntax at the time of writing this document. Please be aware that Microsoft might change it at any time. For information about what this endpoint looks like, please refer to the Azure Blob Storage official product documentation at https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction.

  • Authentication Type

    Mechanism to authenticate to Azure Blob Storage. You have the following options:

    • Service Principal

      Azure's identity that lets you access Azure resources. This access is restricted to roles that are assigned to the service principal.

      • Azure AD URL

        URL that identifies the network address of the Azure AD used to secure the application.

        By default, the URL (https://login.microsoftonline.com) points to the Azure AD log in. If you do not want to use this URL, make sure you change the default definition.

      • Tenant ID

        Identifier of the Azure AD tenant.

      • Client ID

        Identifier of the application in the Azure portal.

      • Client Secret

        Encrypted secret value used as the application password.

      • OAuth2

        Version of the OAuth2 authentication method. The available versions are v1.0 and v2.0. Depending on the version that you select, you must define either the Resource (v1.0) or the Scope (v2.0).

      • Resource / Scope

        URL of the application within Azure Blob Storage to grant access to. The default URL points to the Azure Blob Storage log in.

        • Resource: https://storage.azure.com/

        • Scope: https://storage.azure.com/.default

        If you do not want to use the default URL, make sure you change the definition.

    • OAuth2 Token

      • Token: The bearer token used to log into the Azure Blob Storage environment.

    • Token From File

      • Token File Path: Path to the file in which the token is stored.

Proxy Section

If the Azure Blob Storage system is behind a proxy server, you define the parameters relevant for the connection to that system in this section.

  • Proxy Host Name

    Host name or IP address of the proxy server to which you want to connect.

  • Proxy Port

    Port used by the proxy server.

  • Proxy Username

    User name used to authenticate the proxy server.

  • Proxy Password

    Password of the user used to authenticate the proxy server.

Common Definition Pages

In addition to the Agent-specific connection parameters, you can also specify optional properties. You do so on the following definition pages:

Once the Connection object is configured, developers and object designers can select it when defining the Azure Blob Storage Jobs.

See also: