Configuration Reference

Version:3.7.0

Azure Cosmos Config Properties

🔗
Table 1. Configuration Properties for CosmosClientConfiguration
Property Type Description

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.TokenCredential

azure.cosmos.permissions

java.util.List

azure.cosmos.consistency-level

com.azure.cosmos.ConsistencyLevel

azure.cosmos.content-response-on-write-enabled

boolean

azure.cosmos.gateway-mode

com.azure.cosmos.GatewayConnectionConfig

azure.cosmos.direct-mode

com.azure.cosmos.DirectConnectionConfig

azure.cosmos.user-agent-suffix

java.lang.String

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.client-telemetry-enabled

boolean

azure.cosmos.read-requests-fallback-enabled

boolean

azure.cosmos.client-telemetry-config

com.azure.cosmos.models.CosmosClientTelemetryConfig

azure.cosmos.default-gateway-mode

boolean

When the value is true then default gateway configuration will be used in cosmos client.

Azure Sdk Config Properties

🔗
Table 2. Configuration Properties for StorageSharedKeyCredentialConfiguration
Property Type Description

azure.credential.storage-shared-key.connection-string

java.util.Optional

@return an Azure Storage connection string.

azure.credential.storage-shared-key.account-name

java.util.Optional

@return an Azure Storage account name.

azure.credential.storage-shared-key.account-key

java.util.Optional

@return an Azure Storage account password.

🔗
Table 3. Configuration Properties for VisualStudioCodeCredentialConfiguration
Property Type Description

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.

@return tenant id

🔗
Table 4. Configuration Properties for IntelliJCredentialConfiguration
Property Type Description

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.

@return tenant id

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.

@return path to KeePass database

🔗
Table 5. Configuration Properties for ClientCertificateCredentialConfiguration
Property Type Description

azure.credential.client-certificate.client-id

java.lang.String

Gets the client ID of the application.

@return the client id

azure.credential.client-certificate.pem-certificate-path

java.util.Optional

Gets the path of the PEM certificate for authenticating to AAD.

@return the pem certificate path

azure.credential.client-certificate.pfx-certificate-path

java.util.Optional

Gets the path of the PFX certificate for authenticating to AAD.

@return the pfx certificate path

azure.credential.client-certificate.pfx-certificate-password

java.lang.String

Gets the password protecting the PFX certificate file.

@return the pfx certificate password

azure.credential.client-certificate.tenant-id

java.lang.String

Gets the tenant ID of the application.

@return tenant id

🔗
Table 6. Configuration Properties for ManagedIdentityCredentialConfiguration
Property Type Description

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.

@return client id

🔗
Table 7. Configuration Properties for ClientSecretCredentialConfiguration
Property Type Description

azure.credential.client-secret.client-id

java.lang.String

Gets the client ID of the application.

@return the client id

azure.credential.client-secret.secret

java.lang.String

Gets the client secret for the authentication.

@return client secret

azure.credential.client-secret.tenant-id

java.lang.String

Gets the tenant ID of the application.

@return tenant id

🔗
Table 8. Configuration Properties for UsernamePasswordCredentialConfiguration
Property Type Description

azure.credential.username-password.client-id

java.lang.String

Gets the client ID of the application.

@return the client id

azure.credential.username-password.username

java.lang.String

Gets the username of the user.

@return the username

azure.credential.username-password.password

java.lang.String

Gets the password of the user.

@return the password

azure.credential.username-password.tenant-id

java.util.Optional

Gets the tenant ID of the application.

@return tenant id

Azure Secret Manager Config Properties

🔗
Table 9. Configuration Properties for AzureKeyVaultConfigurationProperties
Property Type Description

azure.key-vault.vault-url

java.lang.String

key vault url.