Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add a Microsoft Azure connector

Connect Harness to your Azure accounts and services.

Use the Microsoft Azure connector to connect Harness to your Azure accounts and services. With this connector, Harness pipelines can pull artifacts from Azure Container Registry (ACR), provision infrastructure with Azure Resource Manager (ARM) and Azure Blueprints, and deploy applications to Azure Kubernetes Service (AKS), Azure Web Apps, Azure App Service Environments, and virtual machines using SSH or WinRM.

Use the Azure Repos connector to connect to Azure SCM repositories.

If you use Harness Cloud Cost Management (CCM), go to Set up Cloud Cost Management for Azure to configure the Azure connector for CCM.

What will you learn in this topic?

Before you begin

  • Azure subscription: Owner or Contributor access on the subscription or resource group where you want Harness to operate.

  • Microsoft Entra ID: Permission to create App Registrations or Managed Identities and assign roles. Go to Create a Microsoft Entra application and service principal to understand the required setup.

  • Harness delegate: A running Harness delegate connected to your Azure environment for delegate-based connectivity. Go to Delegate installation overview to install one.

  • Harness account ID (OIDC only): Navigate to Account Settings in Harness to find your account ID.

Auth Provider API and TokenRequest API options

Harness supports both the Auth Provider API and the TokenRequest API for AKS authentication.

Auth Provider API vs. TokenRequest API

In Kubernetes 1.22, the Auth Provider API was deprecated and replaced with the TokenRequest API. The TokenRequest API lets client libraries and tools request an authentication token from the Kubernetes API server dynamically, based on audience, scopes, and other parameters.

The key advantages of the TokenRequest API are finer-grained control over authentication and easier integration with external identity providers such as OAuth 2.0 providers.

To select which API to use:

  • Auth Provider API: the current default. You do not have to change the default settings of Harness connectors or the Harness delegates you use.

  • TokenRequest API: you must install the provider-specific plugin on the Harness delegate to use the TokenRequest API introduced in Kubernetes 1.22.

Install the kubelogin client-go credential (exec) plugin on the delegate

When using the Harness Azure connector with Kubernetes version 1.22 or later, you can use the kubelogin client-go credential plugin to authenticate to an AKS cluster.

The Azure connector supports four authentication types. Install the following dependencies on the Harness delegates you use, or Harness will fall back to the Auth Provider API format.

  • Secret (SERVICE_PRINCIPAL_SECRET): kubelogin binary.

  • Certificate (SERVICE_PRINCIPAL_CERT): kubelogin binary and Azure CLI (required because kubelogin does not support PEM format certificates).

  • System Assigned Managed Identity (MANAGED_IDENTITY_SYSTEM_ASSIGNED): kubelogin binary.

  • User Assigned Managed Identity (MANAGED_IDENTITY_USER_ASSIGNED): kubelogin binary.

Secret and Certificate are available when you select Specify credentials here. System Assigned Managed Identity and User Assigned Managed Identity are available when you select Use the credentials of a specific Harness Delegate.

Perform the following steps to install kubelogin on the delegate using an immutable delegate image and INIT_SCRIPT:

RHEL 7
Ubuntu

Go to kubelogin releases on Azure and Delegate installation overview for further details.

Roles, permissions, and cluster requirements

This section covers the minimum Azure Role-Based Access Control (RBAC) roles and cluster configuration required for each Azure service. This section assumes you are familiar with Azure RBAC. Go to Assign Azure roles using the Azure portal for a refresher.

For security reasons, Harness uses an application object and service principal rather than a user identity. Go to Create a Microsoft Entra application and service principal that can access resources for details.

ACR role requirements

The Azure connector you use to connect Harness to ACR must have the Reader role at minimum. You can also use a custom role that includes the Reader permissions.

The following tabs describe the Reader role requirements and a sample custom role definition.

Assign the Reader role at the Subscription or Resource Group level for the Application (client) ID used in the Azure connector. The application must have permission to list all container registries.

  • Do not assign the Reader role in a different IAM section of Azure.

  • Do not assign only the AcrPull role instead of Reader. AcrPull grants access to a specific registry, but Harness requires the Reader role to list all registries.

The following permissions are required for any Service Principal or Managed Identity user, regardless of whether you use Kubernetes RBAC or Azure RBAC:

  • Microsoft.ContainerRegistry/registries/read

  • Microsoft.ContainerRegistry/registries/builds/read

  • Microsoft.ContainerRegistry/registries/metadata/read

  • Microsoft.ContainerRegistry/registries/pull/read

  • Microsoft.ContainerService/managedClusters/read

  • Microsoft.ContainerService/managedClusters/listClusterUserCredential/action

  • Microsoft.Resource/subscriptions/resourceGroup/read

For Helm deployments, Helm version 3.2.0 or later is required and the HELM_VERSION_3_8_0 feature flag must be enabled.

You cannot use Pod Assigned Managed Identity and System Assigned Managed Identity on the same cluster.

The following JSON creates a custom role with the required permissions. Replace xxxx with your role name, subscription ID, and resource group ID.

Harness supports up to 500 images from an ACR repo. If you do not see all your images, you may have exceeded this limit due to an Azure API restriction. If you connect to ACR via the platform-agnostic Docker connector, the limit is 100.

Azure Web App role requirements

The Azure connector used to connect to Azure Web Apps with Service Principal or Managed Identity credentials must have the Contributor role at minimum. You can also use a custom role that includes the Contributor permissions.

The following tabs describe the Contributor role permissions and a sample custom role definition.

The following are the Azure RBAC permissions used for System Assigned Managed Identity to perform Azure Web App deployments for container and non-container artifacts:

The following permissions are required for any Service Principal or Managed Identity user, regardless of whether you use Kubernetes RBAC or Azure RBAC:

  • Microsoft.ContainerRegistry/registries/read

  • Microsoft.ContainerRegistry/registries/builds/read

  • Microsoft.ContainerRegistry/registries/metadata/read

  • Microsoft.ContainerRegistry/registries/pull/read

  • Microsoft.ContainerService/managedClusters/read

  • Microsoft.ContainerService/managedClusters/listClusterUserCredential/action

  • Microsoft.Resource/subscriptions/resourceGroup/read

For Helm deployments, Helm version 3.2.0 or later is required and the HELM_VERSION_3_8_0 feature flag must be enabled.

You cannot use Pod Assigned Managed Identity and System Assigned Managed Identity on the same cluster.

Replace xxxx with your role name, subscription ID, and resource group ID.

Connect Harness to Azure Kubernetes Service (AKS)

There are three options for connecting Harness to an AKS cluster. Each option differs in the type of credentials required and the delegate placement.

AKS cluster setup requirements

The following AKS cluster configuration is required to use the Azure connector:

  • AKS managed Azure Active Directory (AAD): enabled or disabled.

  • Kubernetes RBAC: enabled.

  • Azure RBAC: enabled or disabled.

Go to the Deployments (CD) section of the Kubernetes cluster connector settings reference for full details.

AKS role requirements

If you use the Microsoft Azure connector to connect to AKS with Service Principal or Managed Identity credentials, assign the Owner role or a custom role that includes the Owner permissions.

The following tabs provide example role definitions for AKS.

The following permissions are required for any Service Principal or Managed Identity user, regardless of whether you use Kubernetes RBAC or Azure RBAC. Replace xxxx with your role name, subscription ID, and resource group ID.

The following is an example of Kubernetes RBAC permissions for System Assigned Managed Identity.

The following is an example of Azure RBAC permissions for System Assigned Managed Identity. Replace xxxx with your subscription ID and resource group ID.

Azure Resource Management (ARM) role requirements

The roles required for ARM depend on the scope type of your ARM template:

  • Resource group: requires the Contributor role.

  • Subscription: requires the Contributor role.

  • Management group: requires the Contributor role.

  • Tenant: requires the Contributor or Owner role. Creating a Tenant requires Contributor, but creating role assignments requires Owner.

  • Key Vault access: to enable access to Key Vaults from ARM templates, select the Azure Resource Manager for template deployment option in the Key Vault Access Policy.

The Azure roles provided in the connector must allow Harness to provision the Azure resources in your ARM templates. For example, to create a policy assignment, the Resource Policy Contributor role is required.

Azure Blueprints role requirements

Go to Permissions in Azure Blueprints for the full list of roles required to create and delete Blueprints.

The Azure roles required on the service principal depend on the scope of your Blueprint definition.

Management scope:

  • System-assigned managed identity: Contributor role at the management group scope where Blueprint definitions are created and published; Owner role at the subscription scope where the assignment is done.

  • User-assigned managed identity: Contributor role at the management group scope where Blueprint definitions are created and published. Harness does not manage the lifecycle of user-managed identities; you are responsible for that.

Subscription scope:

  • System-assigned managed identity: Owner role at the subscription scope.

  • User-assigned managed identity: Contributor role to create and publish the Blueprint definition. Harness does not manage the lifecycle of user-managed identities; you are responsible for that.

Add an Azure connector

You can add Azure connectors at the account, org, or project level at any time, or while setting up pipelines.

Perform the following steps to add an Azure connector:

  1. Navigate to Project Setup (or Account Settings or Organization Settings), then select Connectors.

  2. Select New Connector, then under Cloud Providers, select Azure Cloud Provider.

  3. Enter a Name. Harness automatically creates an Id based on the name using the Entity Identifier format. You can edit the ID before saving; once saved, the ID is immutable.

  4. Optionally, add a description and tags.

  5. Select Continue to configure credentials.

Configure credentials

The Azure connector supports three credential methods. Select the method that matches your Azure setup.

Specify credentials

Select Specify credentials here to authenticate using an Azure App Registration with a client secret or certificate. Provide the App Registration's Application (client) ID and Directory (tenant) ID.

Perform the following steps to configure credentials:

  1. In Microsoft Azure, go to the App Registration Overview page and note the Application (client) ID and Directory (tenant) ID.

  2. In the Harness Azure connector settings, select the Environment: Azure Global or US Government.

  3. Enter the Application (client) ID in the Application Id field.

  4. Enter the Directory (tenant) ID in the Tenant Id field.

  5. For Authentication, select Secret or Certificate, then select or create a Harness Text Secret or Harness File Secret.

    Harness supports PEM files only. PFX files are not supported.

    To create a new client secret, go to App Registrations in Microsoft Entra ID, select your app, select Certificates & secrets, then select New client secret. Go to Creating a new application secret for steps.

  6. Select Continue.

OIDC authentication

Select OIDC Authentication to connect Harness to Azure without storing client secrets or certificates. Harness acts as an identity provider and issues short-lived JSON Web Tokens (JWTs) that Azure Active Directory (AD) validates directly using workload identity federation. Supported services: ACR, AKS, and Azure Web Apps. Go to Workload identity federation in the Microsoft documentation to understand the underlying Azure mechanism.

Azure OIDC authentication is behind the feature flag CDS_AZURE_OIDC_AUTHENTICATION. Contact Harness Support to enable it on your account.

How OIDC authentication works

When a CD pipeline runs a stage that uses an Azure connector with OIDC authentication:

  1. Harness generates a short-lived ID token (valid for 60 minutes) for the pipeline execution.

  2. The delegate presents this token to Azure AD.

  3. Azure AD validates the token against the federated credential you configured on the App Registration or Managed Identity.

  4. Azure AD issues an access token that grants access to Azure resources based on the RBAC roles you assigned.

Issuer URL

The Harness OIDC issuer URL format depends on the environment cluster where your Harness account resides. To find your cluster, navigate to Account Settings, then select Overview. The cluster hosting your account is displayed on the account details page.

The issuer URL format is:

Use the hostname that matches your cluster, even if a vanity URL is set up for your account:

Cluster
Hostname

Prod1/Prod2

app.harness.io

Prod3

app3.harness.io

Prod0/Prod4

accounts.harness.io

EU clusters

accounts.eu.harness.io

To find your Harness Account ID, navigate to Account Settings, then select Overview. Your account ID is also visible in your browser URL: app.harness.io/ng/account/<YOUR_ACCOUNT_ID>/....

You can test connectivity to the issuer URL by running:

This should return valid information from the endpoint, including the issuer, JWKS URI, and supported claims.

Subject identifier

The subject claim in the Harness-issued token uses this format:

Enter this exact value as the Subject identifier when configuring federated credentials in Azure. Azure uses it to match the incoming token to the correct identity.

Step 1: Configure federated credentials in Azure

You can configure OIDC using an App Registration (Service Principal) or a User-Assigned Managed Identity. Use App Registration when you need a service principal with explicit RBAC role assignments across one or more subscriptions. Use User-Assigned Managed Identity when the delegate runs inside an AKS cluster and you want tighter integration with Azure's managed identity service.

Perform the following steps to add a federated credential to an App Registration:

  1. In the Azure portal, navigate to Microsoft Entra ID, then select App registrations.

  2. Select New registration, enter a name (for example, harness-oidc), and select Register.

  3. On the Overview page, note the Application (client) ID and Directory (tenant) ID.

  4. Select Certificates & secrets, then select the Federated credentials tab.

  5. Select Add credential, then for Federated credential scenario, select Other issuer.

  6. Enter the following values:

    Field
    Value

    Issuer

    https://<HOSTNAME>/ng/api/oidc/account/<YOUR_HARNESS_ACCOUNT_ID> (Replace <HOSTNAME> with your cluster hostname from the Issuer URL table)

    Subject identifier

    Provider:Harness:Account:<YOUR_HARNESS_ACCOUNT_ID>

    Audience

    api://AzureADTokenExchange

    Name

    A descriptive name, for example harness-pipeline

  7. Select Add.

Go to Configure an app to trust an external identity provider in the Microsoft documentation for additional configuration options.

To add the federated credential using the Azure CLI instead, run the following command:

Where federated-credential.json contains:

Replace <HOSTNAME> with your cluster hostname from the Issuer URL table.

Perform the following steps to add a federated credential to a User-Assigned Managed Identity:

  1. In the Azure portal, navigate to Managed Identities.

  2. Select Create, choose your subscription, resource group, and region, enter a name, and select Review + create.

  3. On the managed identity Overview page, note the Client ID.

  4. Navigate back to Managed Identities, select the identity you created, then select Federated credentials under Settings.

  5. Select Add credential, then enter the following values:

    Field
    Value

    Federated credential scenario

    Other issuer

    Issuer

    https://<HOSTNAME>/ng/api/oidc/account/<YOUR_HARNESS_ACCOUNT_ID> (Replace <HOSTNAME> with your cluster hostname from the Issuer URL table)

    Subject identifier

    Provider:Harness:Account:<YOUR_HARNESS_ACCOUNT_ID>

    Audience

    api://AzureADTokenExchange

    Name

    A descriptive name, for example harness-pipeline

  6. Select Add.

Go to Configure a user-assigned managed identity to trust an external identity provider in the Microsoft documentation for additional configuration options.

To add the federated credential using the Azure CLI instead, run the following command:

Assign Azure RBAC roles

Assign the App Registration or Managed Identity the minimum role required for each Azure service you intend to use with this connector:

Service
Minimum role
Assign at scope

Azure Container Registry (ACR)

Reader

Subscription or Resource Group

Azure Kubernetes Service (AKS)

Owner or custom equivalent

Subscription or Resource Group

Azure Web Apps

Contributor

Subscription or Resource Group

Go to Roles, permissions, and cluster requirements for the full role details and custom role JSON examples.

Step 2: Configure the OIDC connector in Harness

After completing the Azure setup above, return to the Details screen in the Harness connector wizard (the screen where you selected OIDC authentication).

Perform the following steps to complete the configuration:

  1. Select the Environment: Azure Global or US Government.

  2. Enter the Application (client) ID of the App Registration or User-Assigned Managed Identity in the Application Id field.

  3. Enter the Directory (tenant) ID in the Tenant Id field.

  4. Optionally, enter the Subscription ID.

  5. Leave Audience as api://AzureADTokenExchange unless you configured a custom audience in Azure.

  6. Select Continue.

OIDC authentication requires Connect through a Harness Delegate as the connectivity mode. Connect through Harness Platform is not supported with OIDC.

YAML reference

Inherit from delegate

Select Use the credentials of a specific Harness Delegate to allow the connector to inherit authentication credentials from a Harness delegate running in your Azure subscription or AKS cluster. This option is useful when the delegate itself has the appropriate Managed Identity or service account permissions.

Perform the following steps to configure inherited credentials:

  1. For Environment, select Azure Global or US Government.

  2. For Authentication, select System Assigned Managed Identity or User Assigned Managed Identity.

    System Assigned Managed Identity uses the AKS cluster's predefined Kubelet Managed Identity. The Control plane AKS Managed Identity (named <AKSName>) must have the Reader permission on the AKS cluster itself. If used for image storage, the Kubelet Managed Identity (named <AKSName>-agentpool) must have the acrPull permission on ACR.

    Go to Use managed identities in Azure Kubernetes Service and How to use managed identities with Azure Container Instances for further details.

  3. If you selected User Assigned Managed Identity, enter the Managed Identity's Client Id from your Azure Managed Identities. You can also use a Pod Assigned Managed Identity.

  4. Select Continue.

Select connectivity mode

The connectivity mode determines how Harness communicates with Azure. Perform the following steps to complete the connectivity configuration:

  1. Select how you want Harness to connect to Azure:

    • Connect through Harness Platform: direct, secure communication between Harness and Azure. This mode is required for Harness Cloud build infrastructure. Not available with OIDC authentication.

    • Connect through a Harness Delegate: Harness communicates with Azure through a Harness delegate in your Azure subscription or AKS cluster. Required when using inherited delegate credentials or OIDC authentication.

  2. If connecting through a Harness delegate, select one of the following:

    • Use any available Delegate: Harness selects an available delegate at runtime.

    • Only use Delegates with all of the following tags: use tags to target one or more specific delegates. You can also install a new delegate at this time.

  3. Select Save and Continue to run the connection test. If the test succeeds, select Finish. The connection test confirms that your authentication and delegate selections are valid.

    If the connection test fails, confirm that your delegate is running and that your credentials are valid. For example, check that the client secret has not expired in your App Registration.

Use ${HARNESS_KUBE_CONFIG_PATH} with Azure

The Harness expression ${HARNESS_KUBE_CONFIG_PATH} resolves to the path of a Harness-generated kubeconfig file containing the credentials you provided to the connector.

You can use these credentials with kubectl commands by exporting the expression value to the KUBECONFIG environment variable. For example, add the following to a Harness Shell Script step:

Go to Select delegates with selectors to run steps on a specific delegate.

Note the following for Azure deployments:

  • If the Azure connector uses Azure Managed Identity for authentication, the Shell Script step must use a Delegate Selector for a delegate running in AKS.

  • If the Azure connector uses Azure Service Principal for authentication, the Shell Script step can use any delegate.

Next steps

You have configured the Microsoft Azure connector. Continue your learning journey with the following:

PreviousAdd an AWS connector
NextAdd a Google Cloud Platform (GCP) connector

Last updated

Was this helpful?