Micronaut Azure Configuration Reference

Every documented configuration property of Micronaut Azure, with types, descriptions, and defaults.

89 properties across 5 sections

Micronaut Azure Cosmos Config Properties

Configuration properties for CosmosClientConfiguration

Property	Type	Description
`azure.cosmos.default-gateway-mode`	boolean	When the value is true then default gateway configuration will be used in cosmos client.

Configuration properties for CosmosClientBuilder

Property	Type	Description
`azure.cosmos.container-creation-interceptor`	java.util.function.Function
`azure.cosmos.add-operation-policy`	com.azure.cosmos.CosmosOperationPolicy
`azure.cosmos.session-capturing-override-enabled`	boolean
`azure.cosmos.connection-sharing-across-clients-enabled`	boolean
`azure.cosmos.authorization-token-resolver`	com.azure.cosmos.models.CosmosAuthorizationTokenResolver
`azure.cosmos.endpoint`	java.lang.String
`azure.cosmos.key`	java.lang.String
`azure.cosmos.resource-token`	java.lang.String
`azure.cosmos.credential`	com.azure.core.credential.AzureKeyCredential
`azure.cosmos.permissions`	java.util.List
`azure.cosmos.consistency-level`	com.azure.cosmos.ConsistencyLevel
`azure.cosmos.read-consistency-strategy`	com.azure.cosmos.ReadConsistencyStrategy
`azure.cosmos.content-response-on-write-enabled`	boolean
`azure.cosmos.gateway-mode`	com.azure.cosmos.GatewayConnectionConfig
`azure.cosmos.user-agent-suffix`	java.lang.String
`azure.cosmos.additional-headers`	java.util.Map
`azure.cosmos.throttling-retry-options`	com.azure.cosmos.ThrottlingRetryOptions
`azure.cosmos.preferred-regions`	java.util.List
`azure.cosmos.endpoint-discovery-enabled`	boolean
`azure.cosmos.multiple-write-regions-enabled`	boolean
`azure.cosmos.read-requests-fallback-enabled`	boolean
`azure.cosmos.non-idempotent-write-retry-options`	com.azure.cosmos.NonIdempotentWriteRetryOptions
`azure.cosmos.open-connections-and-init-caches`	com.azure.cosmos.CosmosContainerProactiveInitConfig
`azure.cosmos.end-to-end-operation-latency-policy-config`	com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
`azure.cosmos.session-retry-options`	com.azure.cosmos.SessionRetryOptions
`azure.cosmos.excluded-regions-supplier`	java.util.function.Supplier
`azure.cosmos.client-telemetry-config`	com.azure.cosmos.models.CosmosClientTelemetryConfig
`azure.cosmos.custom-item-serializer`	com.azure.cosmos.CosmosItemSerializer

Configuration properties for CosmosClientBuilder

Property	Type	Description
`azure.cosmos.container-creation-interceptor`	java.util.function.Function
`azure.cosmos.add-operation-policy`	com.azure.cosmos.CosmosOperationPolicy
`azure.cosmos.session-capturing-override-enabled`	boolean
`azure.cosmos.connection-sharing-across-clients-enabled`	boolean
`azure.cosmos.authorization-token-resolver`	com.azure.cosmos.models.CosmosAuthorizationTokenResolver
`azure.cosmos.endpoint`	java.lang.String
`azure.cosmos.key`	java.lang.String
`azure.cosmos.resource-token`	java.lang.String
`azure.cosmos.credential`	com.azure.core.credential.AzureKeyCredential
`azure.cosmos.permissions`	java.util.List
`azure.cosmos.consistency-level`	com.azure.cosmos.ConsistencyLevel
`azure.cosmos.read-consistency-strategy`	com.azure.cosmos.ReadConsistencyStrategy
`azure.cosmos.content-response-on-write-enabled`	boolean
`azure.cosmos.gateway-mode`	com.azure.cosmos.GatewayConnectionConfig
`azure.cosmos.user-agent-suffix`	java.lang.String
`azure.cosmos.additional-headers`	java.util.Map
`azure.cosmos.throttling-retry-options`	com.azure.cosmos.ThrottlingRetryOptions
`azure.cosmos.preferred-regions`	java.util.List
`azure.cosmos.endpoint-discovery-enabled`	boolean
`azure.cosmos.multiple-write-regions-enabled`	boolean
`azure.cosmos.read-requests-fallback-enabled`	boolean
`azure.cosmos.non-idempotent-write-retry-options`	com.azure.cosmos.NonIdempotentWriteRetryOptions
`azure.cosmos.open-connections-and-init-caches`	com.azure.cosmos.CosmosContainerProactiveInitConfig
`azure.cosmos.end-to-end-operation-latency-policy-config`	com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
`azure.cosmos.session-retry-options`	com.azure.cosmos.SessionRetryOptions
`azure.cosmos.excluded-regions-supplier`	java.util.function.Supplier
`azure.cosmos.client-telemetry-config`	com.azure.cosmos.models.CosmosClientTelemetryConfig
`azure.cosmos.custom-item-serializer`	com.azure.cosmos.CosmosItemSerializer

Micronaut Azure Logging Config Properties

Configuration properties for AzureLoggingConfigurationProperties

Property	Type	Description
`azure.logging.enabled`	boolean	true if enabled
`azure.logging.data-collection-endpoint`	java.lang.String	data collection endpoint URL
`azure.logging.rule-id`	java.lang.String	data collection rule id
`azure.logging.stream-name`	java.lang.String	stream name

Micronaut Azure Sdk Config Properties

Configuration properties for AzureCredentialsConfiguration$AzureCliCredentialConfiguration

Property	Type	Description
`azure.credential.cli.enabled`	boolean

Configuration properties for AzureCredentialsConfiguration$ClientCertificateCredentialConfiguration

Property	Type	Description
`azure.credential.client-certificate.client-id`	java.lang.String	Gets the client ID of the application.
`azure.credential.client-certificate.pem-certificate-path`	java.util.Optional	Gets the path of the PEM certificate for authenticating to AAD.
`azure.credential.client-certificate.pfx-certificate-path`	java.util.Optional	Gets the path of the PFX certificate for authenticating to AAD.
`azure.credential.client-certificate.pfx-certificate-password`	java.lang.String	Gets the password protecting the PFX certificate file.
`azure.credential.client-certificate.tenant-id`	java.lang.String	Gets the tenant ID of the application.

Configuration properties for AzureCredentialsConfiguration$ClientSecretCredentialConfiguration

Property	Type	Description
`azure.credential.client-secret.client-id`	java.lang.String	Gets the client ID of the application.
`azure.credential.client-secret.secret`	java.lang.String	Gets the client secret for the authentication.
`azure.credential.client-secret.tenant-id`	java.lang.String	Gets the tenant ID of the application.

Configuration properties for AzureCredentialsConfiguration$IntelliJCredentialConfiguration

Property	Type	Description
`azure.credential.intellij.enabled`	boolean
`azure.credential.intellij.tenant-id`	java.util.Optional	The tenant id. The default is the tenant the user originally authenticated to via the Azure Toolkit for IntelliJ plugin.
`azure.credential.intellij.kee-pass-database-path`	java.util.Optional	Specifies the KeePass database path to read the cached credentials of Azure toolkit for IntelliJ plugin. The databasePath is required on Windows platform. For macOS and Linux platform native key chain / key ring will be accessed respectively to retrieve the cached credentials.

Configuration properties for AzureCredentialsConfiguration$ManagedIdentityCredentialConfiguration

Property	Type	Description
`azure.credential.managed-identity.enabled`	boolean
`azure.credential.managed-identity.client-id`	java.util.Optional	Specifies the client ID of user assigned or system assigned identity. Required only for user-assigned identity.

Configuration properties for AzureCredentialsConfiguration$StorageSharedKeyCredentialConfiguration

Property	Type	Description
`azure.credential.storage-shared-key.connection-string`	java.util.Optional	an Azure Storage connection string.
`azure.credential.storage-shared-key.account-name`	java.util.Optional	an Azure Storage account name.
`azure.credential.storage-shared-key.account-key`	java.util.Optional	an Azure Storage account password.

Configuration properties for AzureCredentialsConfiguration$UsernamePasswordCredentialConfiguration

Property	Type	Description
`azure.credential.username-password.client-id`	java.lang.String	Gets the client ID of the application.
`azure.credential.username-password.username`	java.lang.String	Gets the username of the user.
`azure.credential.username-password.password`	java.lang.String	Gets the password of the user.
`azure.credential.username-password.tenant-id`	java.util.Optional	Gets the tenant ID of the application.

Configuration properties for AzureCredentialsConfiguration$VisualStudioCodeCredentialConfiguration

Property	Type	Description
`azure.credential.visual-studio-code.enabled`	boolean
`azure.credential.visual-studio-code.tenant-id`	java.util.Optional	The tenant id. The default is the tenant the user originally authenticated to via the Visual Studio Code Azure Account plugin.

Micronaut Azure Secret Manager Config Properties

Configuration properties for AzureKeyVaultConfigurationProperties

Property	Type	Description
`azure.key-vault.vault-url`	java.lang.String	key vault url.

Configuration properties for AzureKeyVaultConfigurationProperties$KeysConfiguration

Property	Type	Description
`azure.key-vault.keys.enabled`	boolean	true if the key configuration client should be enabled.

Configuration properties for AzureKeyVaultConfigurationProperties$KeysConfiguration$SigningConfiguration

Property	Type	Description
`azure.key-vault.keys.signing.enabled`	boolean	true if signing support is enabled.
`azure.key-vault.keys.signing.default-algorithm`	java.lang.String	the default signature algorithm (e.g. RS256).

Micronaut Azure Tracing Config Properties

Configuration properties for AzureTracingConfigurationProperties

Property	Type	Description
`azure.tracing.connection-string`	java.lang.String	Set the connection string.