--- title: Charmhub | Deploy Azure Auth Integrator using Charmhub - The Open Operator Collection description: Deploy the latest version of Azure Auth Integrator on any cloud. url: https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal --- # Azure Auth Integrator [Canonical Data Platform](https://charmhub.io/publisher/dataplatformbot "View all packages from Canonical Data Platform") * [Canonical Data Platform](https://charmhub.io/publisher/dataplatformbot "View all packages from Canonical Data Platform") Platform: 24.04 edge 1 ``` juju deploy azure-auth-integrator --channel edge ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) [Toggle side navigation](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#drawer) ## charms.azure\_auth\_integrator.v0.azure\_service\_principal * [*Docstrings*Docstrings](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal) [*Code*Source code](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal/source-code) * + Download Fetch library ``` charmcraft fetch-lib charms.azure_auth_integrator.v0.azure_service_principal ``` [Download azure\_service\_principal.py](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal/download) + *Last updated* 18 Mar 2026 + *Revision* Library version 0.3 Library to manage Azure Service Principal credentials. The design of the interface and the library has been specified in: https://docs.google.com/document/d/1RvpKpL2nxwzFmPHX9NJGe1h3J0lPQ\_YltXROIB1TicI/edit?tab=t.0. This library contains a Requirer and a Provider class for handling the relation and transmission of Azure Service Principal credentials. It depends on the `data_interfaces` Charmhub hosted-library in order to transmit sensitive information as secrets. Make sure to also include it as dependency in your `charmcraft.yaml`: ``` # charmcraft.yaml charm-libs: - lib: azure_auth_integrator.azure_service_principal version: "0" - lib: data_platform_libs.data_interfaces version: "1" ``` The source code for `data_interfaces` is located at: https://github.com/canonical/data-platform-libs The library also provides custom events to relay information about the status of the credentials. ###### Requirer charm On the requirer side of the charm, instantiate an `AzureServicePrincipalRequirer` object: ``` # charm.py from charms.azure_auth_integrator.v0.azure_service_principal import ( AzureServicePrincipalRequirer, ) class RequirerCharm(CharmBase): def __init__(self, *args): super().__init__(*args) ... self.azure_service_principal_client = AzureServicePrincipalRequirer( self, relation_name="azure-service-principal-credentials" ) ``` Using this instance of class `AzureServicePrincipalRequirer`, the requirer charm then needs to listen to custom events `service_principal_info_changed` and `service_principal_info_gone` and handle them appropriately in the charm code. * The event `service_principal_info_changed` is fired whenever `azure-auth-integrator` has written new data to the relation databag, which needs to be handled by the requirer charm by updating its state with the new Azure Service Principal connection information. * The event `service_principal_info_gone` is fired when the relation with `azure-auth-integrator` is broken, which needs to be handled by the requirer charm by updating its state to not use the Azure Service principal connection information anymore. ``` # charm.py from charms.azure_auth_integrator.v0.azure_service_principal import ( AzureServicePrincipalRequirer, ServicePrincipalInfoChangedEvent, ServicePrincipalInfoGoneEvent, ) class RequirerCharm(CharmBase): def __init__(self, *args): super().__init__(*args) self.azure_service_principal_client = AzureServicePrincipalRequirer( self, relation_name="azure-service-prinicpal-credentials" ) # Observe custom events self.framework.observe( self.azure_service_principal_client.on.service_principal_info_changed, self._on_service_principal_info_changed, ) self.framework.observe( self.azure_service_principal_client.on.service_principal_info_gone, self._on_service_principal_info_gone, ) def _on_service_principal_info_changed(self, event: ServicePrincipalInfoChangedEvent): # access and consume data from the provider connection_info = self.azure_service_principal_client.get_azure_service_principal_info() process_connection_info(connection_info) def _on_service_principal_info_gone(self, event: ServicePrincipalInfoGoneEvent): # notify charm code that credentials are removed process_connection_info(None) ``` The latest Azure Service Principal connection information shared by the `azure-auth-integrator` over the relation can be fetched using the utility method `get_azure_service_principal_info()` available in the `AzureServicePrincipalRequirer` instance, which returns a dictionary: ``` AzureServicePrincipalInfo = { "subscription-id": str, "tenant-id": str, "client-id": str, "client-secret": str, } ``` ###### Provider charm If you need a provider charm that only relays the Azure Service Principal credentials to a requirer, then you probably don't need to implement your own provider, and can just use `azure-auth-integrator`: https://github.com/canonical/azure-auth-integrator On the provider side of the charm, instantiate an `AzureServicePrincipalProvider` object: ``` # charm.py from charms.azure_auth_integrator.v0.azure_service_principal import ( AzureServicePrincipalProvider, ) class ProviderCharm(CharmBase): def __init__(self, *args): super().__init__(*args) ... self.azure_service_principal_provider = AzureServicePrincipalProvider( self, relation_name="azure-service-principal-credentials" ) ``` Using this instance of class `AzureServicePrincipalProvider`, the provider charm then needs to listen to the custom event `service_principal_info_requested`, which is emitted when the integration with requirer charm is initially made. The relation data can be set and/or updated with the `update_response` method. To make sure the data stays updated, make sure to call this method whenever any of the provided credentials may have changed: ``` # charm.py from charms.azure_auth_integrator.v0.azure_service_principal import ( AzureServicePrincipalProvider, ServicePrincipalInfoRequestedEvent, ) AZURE_SERVICE_PRINCIPAL_RELATION_NAME = "azure-service-principal-credentials" class ProviderCharm(CharmBase): def __init__(self, *args): super().__init__(*args) self.azure_service_principal_provider = AzureServicePrincipalProvider( self, relation_name=AZURE_SERVICE_PRINCIPAL_RELATION_NAME ) # Observe custom events self.framework.observe( self.azure_service_principal_provider.on.service_principal_info_requested, self._update_provider_data, ) # Also observe events in which data may have changed self.framework.observe( self.charm.on_config_changed, self._update_provider_data, ) def _update_provider_data(self, event: ServicePrincipalInfoRequestedEvent): # Gather data as a dictionary data = ... # Get instances of the relation relations = self.model.relations[AZURE_SERVICE_PRINCIPAL_RELATION_NAME] for relation in relations: self.azure_service_principal_provider.update_response(relation, data) ``` --- Index * [class ServicePrincipalEvent](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#serviceprincipalevent) * [class ServicePrincipalInfoRequestedEvent](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#serviceprincipalinforequestedevent) * [class ServicePrincipalInfoChangedEvent](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#serviceprincipalinfochangedevent) * [class ServicePrincipalInfoGoneEvent](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#serviceprincipalinfogoneevent) * [class AzureServicePrincipalRequirerEvents](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalrequirerevents) * [class AzureServicePrincipalProviderEvents](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalproviderevents) * [class AzureServicePrincipalProviderModel](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalprovidermodel) * [class AzureServicePrincipalRequirer](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalrequirer) * + [def \_\_init\_\_( self, charm, relation\_name, unique\_key)](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalrequirer-__init__) * + [def get\_azure\_service\_principal\_info( self)](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalrequirer-get_azure_service_principal_info) * [class AzureServicePrincipalProvider](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalprovider) * + [def \_\_init\_\_( self, charm, relation\_name, unique\_key)](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalprovider-__init__) * + [def update\_response( self, relation, response\_data)](https://charmhub.io/azure-auth-integrator/libraries/azure_service_principal#azureserviceprincipalprovider-update_response) #### class ServicePrincipalEvent Description Base class for Azure service principal events. None #### class ServicePrincipalInfoRequestedEvent Description Event for requesting data from the interface. None #### class ServicePrincipalInfoChangedEvent Description Event for changing data from the interface. None #### class ServicePrincipalInfoGoneEvent Description Event for the removal of data from the interface. None #### class AzureServicePrincipalRequirerEvents Description Events for the AzureServicePrincipalRequirer side implementation. None #### class AzureServicePrincipalProviderEvents Description Events for the AzureServicePrincipalProvider side implementation. None #### class AzureServicePrincipalProviderModel Description Data abstraction of the provider side of Azure service principal relation. None #### class AzureServicePrincipalRequirer Description The requirer side of Azure service principal relation. None Methods AzureServicePrincipalRequirer. \_\_init\_\_( *self* , charm: CharmBase , relation\_name: str , unique\_key: str ) AzureServicePrincipalRequirer. get\_azure\_service\_principal\_info( *self* ) Description Return the Azure service principal info as a dictionary. None #### class AzureServicePrincipalProvider Description The provider side of Azure service principal relation. None Methods AzureServicePrincipalProvider. \_\_init\_\_( *self* , charm: CharmBase , relation\_name: str , unique\_key: str ) AzureServicePrincipalProvider. update\_response( *self* , relation: Relation , response\_data ) Description Update the response to the requirer. None