ExAzureCore.Auth.ManagedIdentity.EnvironmentDetector (ex_azure_core v0.2.0)

Detects the Azure environment for managed identity authentication.

Detection order:

Summary

environment()

Checks if App Service environment is available.

Detects the current Azure environment.

Returns environment variables for the detected environment.

Checks if IMDS endpoint is reachable.

Checks if AKS Workload Identity environment is available.

@type detection_result() ::
  {:ok, environment()}
  | {:error, ExAzureCore.Auth.Errors.ManagedIdentityError.t()}

@type environment() :: :workload_identity | :app_service | :imds

@spec app_service_available?() :: boolean()

Checks if App Service environment is available.

Requires both IDENTITY_ENDPOINT and IDENTITY_HEADER environment variables.

@spec detect(keyword()) :: detection_result()

Detects the current Azure environment.

Returns the detected environment type or an error if no Azure environment is detected.

:probe_timeout - Timeout in ms for IMDS probe (default: 1000)
:skip_imds_probe - Skip IMDS network probe, useful for testing (default: false)

@spec get_environment_info() :: map()

Returns environment variables for the detected environment.

Useful for debugging and logging.

@spec imds_available?(keyword()) :: boolean()

Checks if IMDS endpoint is reachable.

Makes a lightweight probe request to the IMDS endpoint.

@spec workload_identity_available?() :: boolean()

Checks if AKS Workload Identity environment is available.

Requires both AZURE_FEDERATED_TOKEN_FILE and AZURE_CLIENT_ID environment variables.