|
| 1 | +--- |
| 2 | +title: Configure QGIS to access Microsoft Planetary Computer Pro |
| 3 | +description: Learn how to configure and authenticate QGIS to read STAC data from Microsoft Planetary Computer Pro. |
| 4 | +author: prasadko |
| 5 | +ms.author: prasadkomma |
| 6 | +ms.service: planetary-computer-pro |
| 7 | +ms.topic: how-to |
| 8 | +ms.date: 10/15/2025 |
| 9 | + |
| 10 | +# customer intent: As a GeoCatalog user, I want to configure and authenticate QGIS to operate with Microsoft Planetary Computer Pro so that I can view imagery stored in my GeoCatalog within the QGIS tool. |
| 11 | +--- |
| 12 | + |
| 13 | +# Configure QGIS to access a GeoCatalog resource |
| 14 | + |
| 15 | +This guide explains how to configure the open-source [QGIS](https://qgis.org/) desktop GIS software to access geospatial datasets from the Microsoft Planetary Computer Pro GeoCatalog using Microsoft Entra ID authentication. |
| 16 | + |
| 17 | +QGIS enables direct interaction with STAC collections in Microsoft Planetary Computer Pro. With QGIS, you can visualize, analyze, and style data on the fly, and integrate it with local layers from Azure. |
| 18 | + |
| 19 | +All GeoCatalog assets can be downloaded to your desktop. Assets in Cloud Optimized GeoTIFF (COG) or Cloud Optimized Point Cloud (COPC) format stream directly. |
| 20 | + |
| 21 | +Configuration consists of two parts: |
| 22 | +- [Microsoft Entra app registration](#register-the-microsoft-entra-application-for-qgis) |
| 23 | +- [STAC connection inside QGIS](#create-the-stac-connection) |
| 24 | + |
| 25 | +Registering the Microsoft Entra application is a one-time task for your tenant. After registration, users enter the Application (client) ID and Directory (tenant) ID in QGIS to set up the STAC connection. |
| 26 | + |
| 27 | + |
| 28 | +## Prerequisites |
| 29 | + |
| 30 | +### Microsoft Entra App registrations |
| 31 | +- Access to a Microsoft Entra ID tenant |
| 32 | +- Azure subscription where your identity has one of these roles: Application Developer, Cloud Application Administrator, or Application Administrator. |
| 33 | + |
| 34 | +### QGIS STAC connection |
| 35 | +- Download and install [QGIS Developer](https://qgis.org/download/) (`qgis-dev`) on your desktop machine<br> |
| 36 | + > [!NOTE] |
| 37 | + > This feature is available only in the QGIS nightly builds until the release of QGIS 4.0 |
| 38 | +- GeoCatalog Reader or GeoCatalog Administrator [role-based access controls](./manage-access.md). |
| 39 | +- Microsoft Planetary Computer Pro GeoCatalog deployment that contains at least one collection. |
| 40 | + |
| 41 | + |
| 42 | +## Register the Microsoft Entra application for QGIS |
| 43 | + |
| 44 | +> [!TIP] |
| 45 | +> Review [Register an application in Microsoft Entra ID](/entra/identity-platform/quickstart-register-app) for background information on app registration. |
| 46 | +
|
| 47 | +Register QGIS as an application in Microsoft Entra ID and grant it delegated permissions so it can act on behalf of the signed-in user. |
| 48 | + |
| 49 | +In the Azure portal, go to Microsoft Entra ID > App registrations > New registration: |
| 50 | + |
| 51 | +[](./media/app-registration.png#lightbox) |
| 52 | + |
| 53 | +### Register the application |
| 54 | +1. Enter a descriptive name for the application. |
| 55 | +2. For supported account types, select the tenant option your organization uses (single tenant or multitenant only). |
| 56 | +3. Under Redirect URI, choose Public client/native (mobile & desktop) and set the URI to `http://localhost:7070`. |
| 57 | +4. Select Register. |
| 58 | +[](./media/qgis-registration.png#lightbox) |
| 59 | + |
| 60 | +### Configure API permissions |
| 61 | + |
| 62 | +Configure delegated API permissions: |
| 63 | + |
| 64 | +1. In the app registration, select **API permissions** > **Add a permission**. |
| 65 | + |
| 66 | + [](./media/qgis-api-permissions.png#lightbox) |
| 67 | + |
| 68 | +2. Select **APIs my organization uses**, search for `Azure Orbital Spatio`, and pick the service to open the permission dialog. |
| 69 | + |
| 70 | + [](./media/add-azure-orbital-spatio.png#lightbox) |
| 71 | + |
| 72 | +3. In **Request API permissions**, select **Delegated permissions**, check **user_impersonation**, and then select **Add permissions** to grant the scope. |
| 73 | + |
| 74 | + [](./media/configure-api-permissions.png#lightbox) |
| 75 | + |
| 76 | +### Reviewing the Application and Directory IDs |
| 77 | + |
| 78 | +Return to **Overview** and record the **Application (client) ID** and **Directory (tenant) ID**. You need to enter them in QGIS later to configure the STAC connection. |
| 79 | + |
| 80 | +[](./media/qgis-client-id.png#lightbox) |
| 81 | + |
| 82 | +## Configure QGIS for GeoCatalog access |
| 83 | + |
| 84 | +A STAC catalog in QGIS is a browsable data source. It exposes hierarchical STAC metadata (catalog → collection → item → asset) instead of a single static file. When you expand nodes, QGIS issues live API requests to the GeoCatalog STAC endpoint so you always see the latest collections and items in your GeoCatalog. |
| 85 | + |
| 86 | +### Create the STAC connection |
| 87 | + |
| 88 | +Create the STAC connection inside QGIS by following these steps: |
| 89 | + |
| 90 | +1. In the **Browser** panel, expand **STAC** to view the connection menu. |
| 91 | +2. Right-click **STAC** and select **New STAC Connection** to open the configuration dialog. |
| 92 | + [](./media/qgis-add-stac-catalog.png#lightbox) |
| 93 | + |
| 94 | +### Configure STAC connection authentication |
| 95 | + |
| 96 | +1. In the "Name" field, name this connection. |
| 97 | +2. Enter the URL of your GeoCatalog and add the STAC API path by appending `/stac` to the URL. |
| 98 | +3. Select the **plus (+)** button to configure the authentication. |
| 99 | +[](./media/qgis-stac-connection-configuration.png#lightbox) |
| 100 | + |
| 101 | +### STAC connection authentication configuration |
| 102 | + |
| 103 | +1. From Authentication, select **Microsoft Planetary Computer**. |
| 104 | +[](./media/select-microsoft-planetary-computer.png#lightbox) |
| 105 | + |
| 106 | +2. Select **Planetary Computer Pro** from the "Server type" drop-down. |
| 107 | +[](./media/select-microsoft-planetary-computer-pro.png#lightbox) |
| 108 | + |
| 109 | +3. Enter the following information into the text boxes: |
| 110 | + |
| 111 | + - A name for the authentication settings |
| 112 | + - GeoCatalog URL |
| 113 | + - [Application and Directory ID](#reviewing-the-application-and-directory-ids) |
| 114 | + |
| 115 | + |
| 116 | +[](./media/authorization-configuration.png#lightbox) |
| 117 | + |
| 118 | +Once these settings are complete, your GeoCatalog is configured for access through the QGIS STAC connection. |
| 119 | + |
| 120 | +## Using the QGIS STAC connection |
| 121 | + |
| 122 | +To browse the collections, select your GeoCatalog in the data layer browser, and expand it. |
| 123 | + |
| 124 | +Once you expand, QGIS will redirect you to a web browser to authenticate with Microsoft Entra. Complete the authentication process for your organization to continue. |
| 125 | + |
| 126 | +[](./media/stac-catalog-in-qgis.png#lightbox) |
| 127 | + |
| 128 | + |
| 129 | +> [!TIP] |
| 130 | +> If your GeoCatalog has zero STAC Collections, you see a `Host requires authentication` error. To resolve this error, create a [STAC Collection](./create-collection-web-interface.md). |
| 131 | +
|
| 132 | +Continue to expand the collections until you locate a STAC Item. To visualize this item, select the item and drag it to the map view. If the data is a Cloud Optimized GeoTIFF (COG) or Cloud Optimized Point Cloud (COPC), it automatically imports and projects onto the map. |
| 133 | + |
| 134 | +[](./media/add-data-to-map.png#lightbox) |
| 135 | + |
| 136 | + |
| 137 | + |
| 138 | +### STAC search and filtering |
| 139 | + |
| 140 | +If you want to search for data or run a STAC filter in your catalog, the STAC API is exposed through the Layer manager. |
| 141 | + |
| 142 | +1. On the **Layer** menu, select **Add Layer** > **Add Layer from STAC Catalog**. |
| 143 | +[](./media/add-stac-catalog-layer.png#lightbox) |
| 144 | + |
| 145 | +1. Select your STAC connection to the GeoCatalog, and then select **Connect**. |
| 146 | +[](./media/data-source-manager.png#lightbox) |
| 147 | + |
| 148 | +1. Choose the index you want to filter on. You can filter on spatial, temporal, or collection extent. |
| 149 | +[](./media/filter-spatial-extent.png#lightbox) |
| 150 | + |
| 151 | +1. Select the item to add it to the map extent or download the assets directly to your local machine. If you hover over the item, the spatial extent previews on the map canvas in red. |
| 152 | +[](./media/add-cog-to-map.png#lightbox) |
| 153 | + |
| 154 | +## Related content |
| 155 | + |
| 156 | +- [Configure the Planetary Computer collection web interface](./configure-collection-web-interface.md) |
| 157 | +- [Create a connection from ArcGIS Pro to the STAC API](./create-connection-arc-gis-pro.md) |
| 158 | +- [Use the Planetary Computer Explorer](./use-explorer.md) |
| 159 | +- [Manage access to Planetary Computer resources](./manage-access.md) |
| 160 | +- [Visualize assets in Planetary Computer](./visualize-assets.md) |
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments