Skip to content

Commit 4f618a4

Browse files
Updating TME and PM comments
1 parent 6b86284 commit 4f618a4

2 files changed

Lines changed: 38 additions & 27 deletions

File tree

-22.8 KB
Loading

articles/azure-netapp-files/object-rest-api-access-configure.md

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.date: 02/16/2026
99
ms.author: anfdocs
1010
---
1111

12-
# Configure object REST API in Azure NetApp Files (preview)
12+
# Configure object REST API for Azure NetApp Files (preview)
1313

1414
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.
1515

@@ -21,15 +21,16 @@ The object REST API feature in Azure NetApp Files is currently in preview. You m
2121

2222
## Create the self-signed certificate
2323

24-
Azure NetApp Files supports two mutually exclusive certificate workflows for object REST API access:
24+
Azure NetApp Files supports two certificate options for object REST API access:
2525

2626
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-
1. **Direct certificate upload**: PEM certificates are generated locally and uploaded manually during bucket creation.
27+
28+
1. **Direct certificate upload**: PEM certificates are generated and uploaded manually during bucket creation.
2829

2930
> [!IMPORTANT]
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+
> The options you select determines the certificate format you must generate (PKCS#12 vs PEM), and how the certificate is supplied during bucket creation.
3132
32-
You must select one of the following workflows:
33+
You must select one of the following options:
3334

3435
### Option 1 (recommended): Azure Key Vault–based certificate
3536

@@ -47,7 +48,7 @@ When creating the certificate in Azure Key Vault, ensure:
4748

4849
Once the certificate is successfully created, click on the certificate from the list and review the properties.
4950

50-
* In the Certificate identifier field, note the URI of the certificate “https://<vault_name>.azure.net”
51+
* In the Certificate identifier field, note the URI of the vault “https://<vault_name>.azure.net”
5152
* Note the name of the certificate
5253

5354
### Required Azure Key Vault permissions
@@ -57,15 +58,15 @@ To avoid bucket creation failures, ensure that the Azure NetApp Files service ha
5758
At a minimum, the following permissions must be granted:
5859

5960
* 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)
61+
* Secrets: Get, List, Set, Delete
6162

6263
> [!NOTE]
6364
> If these permissions are missing, bucket creation fails when Azure NetApp Files attempts to retrieve the certificate.
6465
6566

6667
### Option 2: Direct certificate upload
6768

68-
Use this option if you plan to generate the certificate locally and upload it manually during bucket creation.
69+
Use this option if you plan to generate the certificate and upload it manually during bucket creation.
6970

7071
When creating the certificate, ensure:
7172

@@ -75,7 +76,7 @@ When creating the certificate, ensure:
7576

7677
## Generate the certificate
7778

78-
Use the provided script to generate a self‑signed PEM certificate locally. The script creates both the certificate and private key files required for upload. Set the computer name `CN=` to the IP address or fully qualified domain name (FQDN) of your object REST API-enabled endpoint. This script creates a folder that includes the necessary PEM file and private keys.
79+
Use the provided script to generate a self‑signed PEM certificate. The script creates both the certificate and private key files required for upload. Set the computer name `CN=` to the IP address or fully qualified domain name (FQDN) of your object REST API-enabled endpoint. This script creates a folder that includes the necessary PEM file and private keys.
7980

8081
Create and run the following script:
8182

@@ -110,15 +111,20 @@ After the certificate is created, you will need to create a bucket.
110111
To enable object REST API, you must create a bucket on an Azure NetApp Files volume.
111112

112113
1. From your NetApp volume, select **Buckets**.
113-
1. Select **+Create**.
114-
1. Provide the following information for the bucket:
114+
1. Select **+Create or update bucket**.
115+
1. In Create or update bucket, provide the following information for the bucket:
116+
117+
**Bucket configuration**
118+
115119
* **Name**
116120

117121
Specify the name for your bucket. Refer to [Naming rules and restrictions for Azure resources](../azure-resource-manager/management/resource-name-rules.md#microsoftnetapp) for naming conventions.
118122
* **Path**
119123

120124
The subdirectory path for object REST API. For full volume access, leave this field blank or use `/` for the root directory.
121125

126+
**Protocol access**
127+
122128
* **NFS volume**
123129

124130
* **User ID (UID)**
@@ -135,9 +141,9 @@ To enable object REST API, you must create a bucket on an Azure NetApp Files vol
135141

136142
The ID used to read the bucket.
137143

138-
* **Permissions**
144+
* **Permissions**
139145

140-
Select Read or Read-Write.
146+
Select Read-only or Read and write.
141147

142148
:::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":::
143149

@@ -157,17 +163,21 @@ To enable object REST API, you must create a bucket on an Azure NetApp Files vol
157163

158164
* **Vault URI**
159165

160-
Select the **Vault URL** and **Certificate name** option to use a certificate stored in Azure Key Vault.
166+
Select the name from the drop-down list.
161167

162168
* **Secret name**
163169

164-
Enter the name of the certificate
170+
Enter the name of the certificate.
165171

166172
* **Upload certificate**
167173

168174
Select the **certificate** option to upload a certificate file directly.
169175

170-
If you haven't provided a certificate, upload the PEM file in the **Certificate source**.
176+
If you haven't provided a certificate, upload the PEM file.
177+
178+
* **Certificate source**.
179+
180+
Upload the appropriate certificate. Only PEM files are supported.
171181
172182
**Credentials storage**
173183

@@ -179,13 +189,11 @@ To enable object REST API, you must create a bucket on an Azure NetApp Files vol
179189

180190
* **Secret name**
181191

182-
Enter the name of the certificate. The secret name is user-defined and can be any value.
192+
Enter the name of the secret. The secret name is user-defined and can be any value, that meets the naming guidelines.
183193

184194
* **Access key**
185195

186-
Select access key to indicate this bucket will use keys.
187-
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.
196+
When selecting this option, 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.
189197

190198
1. Select **Save** to validate the configuration.
191199

@@ -203,7 +211,7 @@ The credential generation behavior depends on the credential storage option you
203211

204212
1. Enter the desired access key lifespan in days and then select **Generate credentials**.
205213

206-
**Azure Key Vault–based**
214+
**Azure Key Vault–based credentials**
207215

208216
* The credentials are generated and stored securely in Azure Key Vault.
209217
* The credentials and are not displayed in the Azure portal.
@@ -218,17 +226,20 @@ The credential generation behavior depends on the credential storage option you
218226
1. Select **Objects** then select **Secrets**.
219227
1. Confirm that <secret_name> has been created.
220228

221-
**Direct certificate upload**
229+
**Access key-based credentials**
222230

223231
When using direct certificate upload:
224232

225233
* The access key and secret access key are displayed once in the Azure portal.
226234
* You should copy and store both the values securely.
227235
* The credentials cannot be retrieved again after the initial display.
228236

237+
> [!IMPORTANT]
238+
> The access key and secret access key are only displayed once. You should copy and store the keys securely. If they are lost, you must generate new credentials.
239+
229240
**Regenerating credentials**
230241

231-
After the credentials are set, you can generate new credentials by selecting the three dots (``) on the bucket and choosing **Generate credentials**.
242+
After the credentials are set, you can generate new credentials by selecting the three dots (``) on the bucket and selecting **Generate credentials**.
232243

233244
> [!IMPORTANT]
234245
> Generating new credentials immediately invalidates existing credentials.
@@ -242,7 +253,7 @@ You can modify a bucket's access management settings.
242253
* Permissions
243254

244255
1. From your NetApp volume, select **Buckets**.
245-
1. Select **+Create**.
256+
1. Select **+Create or update bucket**.
246257
1. Enter the name of the bucket you want to modify.
247258
1. Change the access management settings as required.
248259
1. Click **Save** to modify the existing bucket.
@@ -253,12 +264,12 @@ You can modify a bucket's access management settings.
253264

254265
## Delete a bucket
255266

256-
Deleting a bucket permanently removes it and all associated configuration. You can't recover the bucket after deleting it.
267+
Deleting a bucket permanently removes it and all associated configurations. You can't recover the bucket after deleting it.
257268

258269
1. In your NetApp account, navigate to **Buckets**.
259-
1. Select the checkbox next to the bucket you want to delete.
270+
1. Select the the three dots (``) next to the bucket you want to delete.
260271
1. Select **Delete**.
261-
1. In the modal, select **Delete** to confirm you want to delete the bucket.
272+
1. In the Delete bucket window, select **Delete** to confirm you want to delete the bucket.
262273

263274
## Next steps
264275

0 commit comments

Comments
 (0)