Skip to content

Commit 1d834b3

Browse files
Updating TME feedback
1 parent a9e8c74 commit 1d834b3

2 files changed

Lines changed: 94 additions & 33 deletions

File tree

-100 KB
Loading

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

Lines changed: 94 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: anfdocs
1111

1212
# Configure object REST API in Azure NetApp Files (preview)
1313

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

1616
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.
1717

@@ -26,7 +26,7 @@ Azure NetApp Files supports two mutually exclusive certificate workflows for obj
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.
2727
1. **Direct certificate upload**: PEM certificates are generated locally and uploaded manually during bucket creation.
2828

29-
>IMPORTANT
29+
> [!IMPORTANT]
3030
> 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.
3131
3232
You must select one of the following workflows:
@@ -35,6 +35,8 @@ You must select one of the following workflows:
3535

3636
Use this option if you want Azure NetApp Files to read the certificate directly from Azure Key Vault during bucket creation.
3737

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+
3840
When creating the certificate in Azure Key Vault, ensure:
3941

4042
* **Content Type**: PKCS#12
@@ -43,17 +45,22 @@ When creating the certificate in Azure Key Vault, ensure:
4345

4446
:::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":::
4547

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+
4653
### Required Azure Key Vault permissions
4754

4855
To avoid bucket creation failures, ensure that the Azure NetApp Files service has permission to read the certificate from Azure Key Vault.
4956

5057
At a minimum, the following permissions must be granted:
5158

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)
5461

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.
5764
5865

5966
### Option 2: Direct certificate upload
@@ -100,7 +107,7 @@ After the certificate is created, you will need to create a bucket.
100107

101108
## Create a bucket
102109

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.
104111

105112
1. From your NetApp volume, select **Buckets**.
106113
1. Select **+Create**.
@@ -132,30 +139,100 @@ To enable object REST API, you must create a bucket.
132139

133140
Select Read or Read-Write.
134141

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+
135150
* **Fully qualified domain name**
136151

137152
Enter the endpoint FQDN used by clients to access the buckets.
138153

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**
140155

141-
* **Certificate source**
156+
* **Azure Key Vault**
142157

143-
* **Azure Key Vault**
158+
* **Vault URI**
144159

145160
Select the **Vault URL** and **Certificate name** option to use a certificate stored in Azure Key Vault.
146-
147-
* **Upload certificate**
148161

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**.
150171

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.
152187

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.
156193

157194
After you create a bucket, you need to generate credentials to access the bucket.
158195

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+
159236
## Update bucket access
160237

161238
You can modify a bucket's access management settings.
@@ -164,7 +241,6 @@ You can modify a bucket's access management settings.
164241
* Group ID
165242
* Permissions
166243

167-
168244
1. From your NetApp volume, select **Buckets**.
169245
1. Select **+Create**.
170246
1. Enter the name of the bucket you want to modify.
@@ -174,21 +250,6 @@ You can modify a bucket's access management settings.
174250
> [!NOTE]
175251
> You cannot modify a bucket’s path. To update a bucket’s path, delete and re-create the bucket with the new path.
176252
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.
191-
192253

193254
## Delete a bucket
194255

0 commit comments

Comments
 (0)