Skip to content

Commit c23db8d

Browse files
committed
docs
1 parent bf7c4bd commit c23db8d

1 file changed

Lines changed: 22 additions & 4 deletions

File tree

mkdocs/docs/configuration.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,7 @@ The RESTCatalog supports pluggable authentication via the `auth` configuration b
395395
- `oauth2`: OAuth2 client credentials flow.
396396
- `custom`: Custom authentication manager (requires `auth.impl`).
397397
- `google`: Google Authentication support
398+
- `entra`: Microsoft Entra ID (Azure AD) authentication support
398399

399400
###### Configuration Properties
400401

@@ -422,6 +423,7 @@ catalog:
422423
| `auth.oauth2` | If type is `oauth2` | Block containing OAuth2 configuration (see below). |
423424
| `auth.custom` | If type is `custom` | Block containing configuration for the custom AuthManager. |
424425
| `auth.google` | If type is `google` | Block containing `credentials_path` to a service account file (if using). Will default to using Application Default Credentials. |
426+
| `auth.entra` | If type is `entra` | Block containing Entra ID configuration. Will default to using DefaultAzureCredential. |
425427

426428
###### Examples
427429

@@ -578,22 +580,38 @@ catalog:
578580

579581
See [OneLake table APIs for Iceberg](https://aka.ms/onelakeircdocs) for detailed documentation.
580582

583+
Using Entra ID authentication (recommended):
584+
585+
```yaml
586+
catalog:
587+
onelake_catalog:
588+
type: rest
589+
uri: https://onelake.table.fabric.microsoft.com/iceberg
590+
warehouse: <fabric_workspace_id>/<fabric_data_item_id>
591+
auth:
592+
type: entra
593+
adls.account-name: onelake
594+
adls.account-host: onelake.blob.fabric.microsoft.com
595+
```
596+
597+
Using static token:
598+
581599
```yaml
582600
catalog:
583601
onelake_catalog:
584602
type: rest
585603
uri: https://onelake.table.fabric.microsoft.com/iceberg
586604
warehouse: <fabric_workspace_id>/<fabric_data_item_id> # Example : DB0CE1EE-B014-47D3-8F0C-9D64C39C0FC2/F470A1D2-6D6D-4C9D-8796-46286C80B7C0
587-
token: <token>,
588-
adls.account-name: onelake,
589-
adls.account-host: onelake.blob.fabric.microsoft.com,
605+
token: <token>
606+
adls.account-name: onelake
607+
adls.account-host: onelake.blob.fabric.microsoft.com
590608
adls.credential: <credential>
591609
```
592610

593611
<!-- prettier-ignore-start -->
594612

595613
!!! Note "OneLake Authentication Models"
596-
For Authentication: You can use DefautlAzureCredential from `azure.identity` package or refer to other [authentication flows](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-flows-app-scenarios) for detailed documentation.
614+
For Authentication: You can use the `entra` auth type which leverages `DefaultAzureCredential` from the `azure.identity` package. This supports multiple authentication methods including environment variables, managed identity, Azure CLI, and interactive browser login. Install with `pip install pyiceberg[entra-auth]`. Refer to [DefaultAzureCredential overview](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication/credential-chains?tabs=dac#defaultazurecredential-overview) for detailed documentation.
597615
<!-- prettier-ignore-end -->
598616

599617
### SQL Catalog

0 commit comments

Comments
 (0)