You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-netapp-files/object-rest-api-access-configure.md
+94-33Lines changed: 94 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.author: anfdocs
11
11
12
12
# Configure object REST API in Azure NetApp Files (preview)
13
13
14
-
Azure NetApp Files supports access to S3 objects with the [object REST API](object-rest-api-introduction.md) feature. With the object REST API, you can connect to services such as Azure AI Search, Microsoft Fabric (Foundry), Azure Databricks, OneLake, and other S3‑compatible clients.
14
+
Azure NetApp Files supports access to S3 objects with the [object REST API](object-rest-api-introduction.md) feature. With the object REST API, you can connect to services such as Azure AI Search, Microsoft Fabric, Microsoft Foundry, Azure Databricks, OneLake, and other S3‑compatible clients.
15
15
16
16
This article describes how to configure object REST API access and walks you through the two supported certificate workflows. Choose the workflow that best matches your security and operational requirements.
17
17
@@ -26,7 +26,7 @@ Azure NetApp Files supports two mutually exclusive certificate workflows for obj
26
26
1.**Azure Key Vault–based certificates (recommended)**: Certificates are created and stored in Azure Key Vault and the certificate is retrieved directly from Azure Key Vault during bucket creation.
27
27
1.**Direct certificate upload**: PEM certificates are generated locally and uploaded manually during bucket creation.
28
28
29
-
>IMPORTANT
29
+
>[!IMPORTANT]
30
30
> The workflow you select determines the certificate format you must generate (PKCS#12 vs PEM), how the certificate is supplied during bucket creation, and how access credentials are generated and retrieved.
31
31
32
32
You must select one of the following workflows:
@@ -35,6 +35,8 @@ You must select one of the following workflows:
35
35
36
36
Use this option if you want Azure NetApp Files to read the certificate directly from Azure Key Vault during bucket creation.
37
37
38
+
See the [Azure Key Vault documentation for adding a certificate to Key Vault](/key-vault/certificates/quick-create-portal#add-a-certificate-to-key-vault).
39
+
38
40
When creating the certificate in Azure Key Vault, ensure:
39
41
40
42
***Content Type**: PKCS#12
@@ -43,17 +45,22 @@ When creating the certificate in Azure Key Vault, ensure:
43
45
44
46
:::image type="content" source="./media/object-rest-api-access-configure/create-certificate.png" alt-text="Screenshot of create certificate options." lightbox="./media/object-rest-api-access-configure/create-certificate.png":::
45
47
48
+
Once the certificate is successfully created, click on the certificate from the list and review the properties.
49
+
50
+
* In the Certificate identifier field, note the URI of the certificate “https://<vault_name>.azure.net”
51
+
* Note the name of the certificate
52
+
46
53
### Required Azure Key Vault permissions
47
54
48
55
To avoid bucket creation failures, ensure that the Azure NetApp Files service has permission to read the certificate from Azure Key Vault.
49
56
50
57
At a minimum, the following permissions must be granted:
51
58
52
-
* Certificates: Get, List
53
-
* Secrets: Get (PKCS#12 certificates are accessed as secrets)
59
+
* Certificates: Get, List, Update, Create, Import, Manage Certificate Authorities, Get Certificate Authorities, List Certificate Authorities, Set Certificate Authorities, Delete Certificate Authorities
60
+
* Secrets: Get, List, Set, Delete (PKCS#12 certificates are accessed as secrets)
54
61
55
-
>NOTE
56
-
>If these permissions are missing, bucket creation fails when Azure NetApp Files attempts to retrieve the certificate.
62
+
>[!NOTE]
63
+
>If these permissions are missing, bucket creation fails when Azure NetApp Files attempts to retrieve the certificate.
57
64
58
65
59
66
### Option 2: Direct certificate upload
@@ -100,7 +107,7 @@ After the certificate is created, you will need to create a bucket.
100
107
101
108
## Create a bucket
102
109
103
-
To enable object REST API, you must create a bucket.
110
+
To enable object REST API, you must create a bucket on an Azure NetApp Files volume.
104
111
105
112
1. From your NetApp volume, select **Buckets**.
106
113
1. Select **+Create**.
@@ -132,30 +139,100 @@ To enable object REST API, you must create a bucket.
132
139
133
140
Select Read or Read-Write.
134
141
142
+
:::image type="content" source="./media/object-rest-api-access-configure/create-bucket.png" alt-text="Screenshot of create a bucket menu." lightbox="./media/object-rest-api-access-configure/create-bucket.png":::
143
+
144
+
1. Select **Save**.
145
+
146
+
Additional details are needed to create the first bucket on a set of volumes sharing the same IP address.
147
+
148
+
**Certificate management**
149
+
135
150
***Fully qualified domain name**
136
151
137
152
Enter the endpoint FQDN used by clients to access the buckets.
138
153
139
-
:::image type="content" source="./media/object-rest-api-access-configure/create-bucket.png" alt-text="Screenshot of create a bucket menu." lightbox="./media/object-rest-api-access-configure/create-bucket.png":::
154
+
**Certificate source**
140
155
141
-
***Certificate source**
156
+
***Azure Key Vault**
142
157
143
-
***Azure Key Vault**
158
+
***Vault URI**
144
159
145
160
Select the **Vault URL** and **Certificate name** option to use a certificate stored in Azure Key Vault.
146
-
147
-
***Upload certificate**
148
161
149
-
Select the **certificate** option to upload a certificate file directly.
162
+
***Secret name**
163
+
164
+
Enter the name of the certificate
165
+
166
+
***Upload certificate**
167
+
168
+
Select the **certificate** option to upload a certificate file directly.
169
+
170
+
If you haven't provided a certificate, upload the PEM file in the **Certificate source**.
150
171
151
-
***Credentials storage**
172
+
**Credentials storage**
173
+
174
+
***Azure Key Vault**
175
+
176
+
***Vault URI**
177
+
178
+
Select the name from the drop-down list.
179
+
180
+
***Secret name**
181
+
182
+
Enter the name of the certificate. The secret name is user-defined and can be any value.
183
+
184
+
***Access key**
185
+
186
+
Select access key to indicate this bucket will use keys.
152
187
153
-
Displayed in portal or stored in Azure Key Vault.
154
-
155
-
1. Select **Create**.
188
+
Access keys are generated after the bucket is created and are displayed once in the Azure portal. You must manually copy both these values and store them securely.
189
+
190
+
1. Select **Save** to validate the configuration.
191
+
192
+
1. Select **Create** to provision the bucket.
156
193
157
194
After you create a bucket, you need to generate credentials to access the bucket.
158
195
196
+
## Generate credentials
197
+
198
+
The credential generation behavior depends on the credential storage option you selected.
199
+
200
+
1. Navigate to the newly created bucket.
201
+
202
+
1. Select **Generate credentials**.
203
+
204
+
1. Enter the desired access key lifespan in days and then select **Generate credentials**.
205
+
206
+
**Azure Key Vault–based**
207
+
208
+
* The credentials are generated and stored securely in Azure Key Vault.
209
+
* The credentials and are not displayed in the Azure portal.
210
+
* You should retrieve the credentials directly from the configured Key Vault.
211
+
212
+
After the credential are generated, perform the following:
213
+
214
+
1. Ensure that the secret is created in the specified Key Vault.
215
+
1. Verify the secret:
216
+
217
+
1. Navigate to your key vault in the Azure portal.
218
+
1. Select **Objects** then select **Secrets**.
219
+
1. Confirm that <secret_name> has been created.
220
+
221
+
**Direct certificate upload**
222
+
223
+
When using direct certificate upload:
224
+
225
+
* The access key and secret access key are displayed once in the Azure portal.
226
+
* You should copy and store both the values securely.
227
+
* The credentials cannot be retrieved again after the initial display.
228
+
229
+
**Regenerating credentials**
230
+
231
+
After the credentials are set, you can generate new credentials by selecting the three dots (`…`) on the bucket and choosing **Generate credentials**.
232
+
233
+
> [!IMPORTANT]
234
+
> Generating new credentials immediately invalidates existing credentials.
235
+
159
236
## Update bucket access
160
237
161
238
You can modify a bucket's access management settings.
@@ -164,7 +241,6 @@ You can modify a bucket's access management settings.
164
241
* Group ID
165
242
* Permissions
166
243
167
-
168
244
1. From your NetApp volume, select **Buckets**.
169
245
1. Select **+Create**.
170
246
1. Enter the name of the bucket you want to modify.
@@ -174,21 +250,6 @@ You can modify a bucket's access management settings.
174
250
> [!NOTE]
175
251
> You cannot modify a bucket’s path. To update a bucket’s path, delete and re-create the bucket with the new path.
176
252
177
-
## Generate credentials
178
-
179
-
The credential generation behavior depends on the workflow you selected.
180
-
181
-
### Azure Key Vault–based
182
-
183
-
The credentials are generated and stored securely in Azure Key Vault and are not displayed in the portal. You should retrieve the credentials directly from the configured Key Vault.
184
-
185
-
### Direct certificate upload
186
-
187
-
The credentials are displayed once in the Azure portal. You should copy and store them securely. The credentials cannot be retrieved again after the initial display.
188
-
189
-
>IMPORTANT
190
-
>Generating new credentials immediately invalidates existing credentials.
0 commit comments