Skip to content

Commit e17c87a

Browse files
committed
Update open source doc for client credentials
1 parent ad6c43c commit e17c87a

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

docs/integrations/sources/azure-blob-storage.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<HideInUI>
44

5-
This page contains the setup guide and reference information for the [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/?product=popular) source connector.
5+
This page contains the setup guide and reference information for the [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/) source connector.
66

77
</HideInUI>
88

@@ -41,10 +41,10 @@ Minimum permissions (role [Storage Blob Data Reader](https://learn.microsoft.com
4141

4242
### Step 1: Set up Azure Blob Storage
4343

44-
- Create a storage account with the permissions [details](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal)
44+
- Create a storage account and grant roles [details](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal)
4545

4646
:::warning
47-
To use Oauth 2.0 Authentication method, Access Control (IAM) should be setup.
47+
To use Oauth2 or Client Credentials Authentication methods, Access Control (IAM) should be setup.
4848
It is recommended
4949
to use role [Storage Blob Data Reader](https://learn.microsoft.com/en-gb/azure/storage/blobs/assign-azure-role-data-access?tabs=portal)
5050

@@ -62,6 +62,20 @@ Follow these steps to set up an IAM role:
6262
</details>
6363
:::
6464

65+
<details>
66+
<summary>
67+
Follow these steps to set up a Service Principal to use the Client Credentials authentication method.
68+
</summary>
69+
70+
In the Azure portal, navigate to your Service Principal's App Registration.
71+
72+
Note the `Directory (tenant) ID` and `Application (client) ID` in the Overview panel.
73+
74+
In the `Manage / Certificates & secrets` panel, click `Client Secrets` and create a new secret. Note the `Value` of the secret.
75+
76+
</details>
77+
78+
6579
### Step 2: Set up the Azure Blob Storage connector in Airbyte
6680

6781
<!-- env:cloud -->
@@ -93,10 +107,14 @@ Follow these steps to set up an IAM role:
93107
2. Click Sources and then click + New source.
94108
3. On the Set up the source page, select Azure Blob Storage from the Source type dropdown.
95109
4. Enter a name for the Azure Blob Storage connector.
96-
5. Enter the name of your Azure **Account**.
97-
6. Enter your Tenant ID and Click **Authenticate your Azure Blob Storage account**.
98-
7. Log in and authorize the Azure Blob Storage account.
99-
8. Enter the name of the **Container** containing your files to replicate.
110+
5. Enter the name of your Azure **Storage Account** and **container**.
111+
6. Choose the Authentication method.
112+
1. If you are accessing through a Storage Account Key, choose `Authenticate via Storage Account Key` and enter the key.
113+
1. If you are accessing through a Service Principal, choose the `Authenticate via Client Credentials`.
114+
0. See [above](#step-1-set-up-azure-blob-storage) regarding setting IAM role bindings for the Service Principal and getting detail of the app registration
115+
1. Enter the `Directory (tenant) ID` value from app registration in Azure Portal into the `Tenant ID` field.
116+
2. Enter the `Application (client) ID` from Azure Portal into the `Tenant ID` field. Note this is **not** the secret ID
117+
3. Enter the Secret `Value` from Azure Portal into the `Client Secret` field.
100118
9. Add a stream
101119
1. Write the **File Type**
102120
2. In the **Format** box, use the dropdown menu to select the format of the files you'd like to replicate. The supported formats are **CSV**, **Parquet**, **Avro** and **JSONL**. Toggling the **Optional fields** button within the **Format** box will allow you to enter additional configurations based on the selected format. For a detailed breakdown of these settings, refer to the [File Format section](#file-format-settings) below.

0 commit comments

Comments
 (0)