Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new JDBC parameter description #43837

Merged
merged 1 commit into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -255,22 +255,23 @@ Connection connection=DriverManager.getConnection(url,properties);

## JDBC Parameters

| Parameter Key | Description|
|----------------------------------------|---|
| azure.clientId |Client ID to use when performing service principal authentication with Azure.|
| azure.clientSecret |Client secret to use when performing service principal authentication with Azure.|
| azure.clientCertificatePath |Path of a PEM/PFX certificate file to use when performing service principal authentication with Azure.|
| azure.clientCertificatePassword |Password of the certificate file.|
| azure.username |Username to use when performing username/password authentication with Azure.|
| azure.password |Password to use when performing username/password authentication with Azure.|
| azure.managedIdentityEnabled |Whether to enable managed identity to authenticate with Azure.|
| azure.authorityHost |The well known authority hosts for the Azure Public Cloud and sovereign clouds.|
| azure.tenantId |Tenant ID for Azure resources.|
| azure.claims |Claims for Azure resources.|
| azure.scopes |Scopes for Azure resources.|
| azure.accessTokenTimeoutInSeconds |Max time to get an access token.|
| azure.tokenCredentialProviderClassName |The canonical class name of a class that implements 'TokenCredentialProvider'.|
| azure.tokenCredentialBeanName |The given bean name of a TokenCredential bean in the Spring context.|
| Parameter Key | Description |
|----------------------------------------|--------------------------------------------------------------------------------------------------------|
| azure.clientId | Client ID to use when performing service principal authentication with Azure. |
| azure.clientSecret | Client secret to use when performing service principal authentication with Azure. |
| azure.clientCertificatePath | Path of a PEM/PFX certificate file to use when performing service principal authentication with Azure. |
| azure.clientCertificatePassword | Password of the certificate file. |
| azure.username | Username to use when performing username/password authentication with Azure. |
| azure.password | Password to use when performing username/password authentication with Azure. |
| azure.managedIdentityEnabled | Whether to enable managed identity to authenticate with Azure. |
| azure.authorityHost | The well known authority hosts for the Azure Public Cloud and sovereign clouds. |
| azure.tenantId | Tenant ID for Azure resources. |
| azure.claims | Claims for Azure resources. |
| azure.scopes | Scopes for Azure resources. |
| azure.accessTokenTimeoutInSeconds | Max time to get an access token. The default value is `30` seconds. |
| azure.tokenCredentialProviderClassName | The canonical class name of a class that implements 'TokenCredentialProvider'. |
| azure.tokenCredentialBeanName | The given bean name of a TokenCredential bean in the Spring context. |
| azure.tokenCredentialCacheEnabled | Whether to enable the token credential cache. Enabled by default. |

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,22 +257,23 @@ Connection connection=DriverManager.getConnection(url,properties);

## JDBC Parameters

| Parameter Key | Description|
|----------------------------------------|---|
| azure.clientId |Client ID to use when performing service principal authentication with Azure.|
| azure.clientSecret |Client secret to use when performing service principal authentication with Azure.|
| azure.clientCertificatePath |Path of a PEM/PFX certificate file to use when performing service principal authentication with Azure.|
| azure.clientCertificatePassword |Password of the certificate file.|
| azure.username |Username to use when performing username/password authentication with Azure.|
| azure.password |Password to use when performing username/password authentication with Azure.|
| azure.managedIdentityEnabled |Whether to enable managed identity to authenticate with Azure.|
| azure.authorityHost |The well known authority hosts for the Azure Public Cloud and sovereign clouds.|
| azure.tenantId |Tenant ID for Azure resources.|
| azure.claims |Claims for Azure resources.|
| azure.scopes |Scopes for Azure resources.|
| azure.accessTokenTimeoutInSeconds |Max time to get an access token.|
| azure.tokenCredentialProviderClassName |The canonical class name of a class that implements 'TokenCredentialProvider'.|
| azure.tokenCredentialBeanName |The given bean name of a TokenCredential bean in the Spring context.|
| Parameter Key | Description |
|----------------------------------------|--------------------------------------------------------------------------------------------------------|
| azure.clientId | Client ID to use when performing service principal authentication with Azure. |
| azure.clientSecret | Client secret to use when performing service principal authentication with Azure. |
| azure.clientCertificatePath | Path of a PEM/PFX certificate file to use when performing service principal authentication with Azure. |
| azure.clientCertificatePassword | Password of the certificate file. |
| azure.username | Username to use when performing username/password authentication with Azure. |
| azure.password | Password to use when performing username/password authentication with Azure. |
| azure.managedIdentityEnabled | Whether to enable managed identity to authenticate with Azure. |
| azure.authorityHost | The well known authority hosts for the Azure Public Cloud and sovereign clouds. |
| azure.tenantId | Tenant ID for Azure resources. |
| azure.claims | Claims for Azure resources. |
| azure.scopes | Scopes for Azure resources. |
| azure.accessTokenTimeoutInSeconds | Max time to get an access token. The default value is `30` seconds. |
| azure.tokenCredentialProviderClassName | The canonical class name of a class that implements 'TokenCredentialProvider'. |
| azure.tokenCredentialBeanName | The given bean name of a TokenCredential bean in the Spring context. |
| azure.tokenCredentialCacheEnabled | Whether to enable the token credential cache. Enabled by default. |

## Troubleshooting

Expand Down
Loading