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
+84-39Lines changed: 84 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,45 +11,64 @@ 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 feature, you can connect to services including Azure AI Search, Azure AI Foundry, Azure Databricks, OneLake, and others.
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.
15
+
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.
15
17
16
18
## Register the feature
17
19
18
-
The object REST API feature in Azure NetApp Files is currently in preview. You must submit a [waitlist request](https://aka.ms/ANF-object-REST-API-signup) to use the object REST API feature. Activation takes approximately one week. An email notification is sent to confirm your enrollment in the preview.
20
+
The object REST API feature in Azure NetApp Files is currently in preview. You must submit a [waitlist request](https://aka.ms/ANF-object-REST-API-signup) to use this feature. Activation takes approximately one week, and you receive an email notification once the enrollment is complete.
19
21
20
22
## Create the self-signed certificate
21
23
22
-
Azure NetApp Files now supports two certificate workflows for Object REST API access:
24
+
Azure NetApp Files supports two mutually exclusive certificate workflows for object REST API access:
23
25
24
-
1. Azure Key Vault–based certificates, which are created and selected by reference during bucket creation
25
-
1. Direct certificate upload, where PEM certificates are generated locally and uploaded at bucket creation time.
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
+
1.**Direct certificate upload**: PEM certificates are generated locally and uploaded manually during bucket creation.
26
28
27
-
### Using Azure Key Vault as the certificate source
29
+
>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.
28
31
29
-
When creating the certificate, ensure:
32
+
You must select one of the following workflows:
30
33
31
-
* the **Content Type** is set to PKCS#12
32
-
* the **Subject** field is set to the IP address or fully qualified domain name (FQDN) of your Azure NetApp Files endpoint using the format `"CN=<IP or FQDN>"`
33
-
* the **DNS Names** entry specifies the IP address or FQDN
Use this option if you want Azure NetApp Files to read the certificate directly from Azure Key Vault during bucket creation.
37
37
38
-
#### [Portal](#tab/portal)
38
+
When creating the certificate in Azure Key Vault, ensure:
39
39
40
-
See the [Azure Key Vault documentation for adding a certificate to Key Vault](/azure//key-vault/certificates/quick-create-portal#add-a-certificate-to-key-vault).
40
+
***Content Type**: PKCS#12
41
+
***Subject**: IP address or fully qualified domain name (FQDN) of your Azure NetApp Files endpoint using the format `"CN=<IP or FQDN>"`
42
+
***DNS Names**: IP address or FQDN
41
43
42
-
When creating the certificate, ensure:
44
+
:::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":::
43
45
44
-
* the **Content Type** is set to PEM
45
-
* the **Subject** field is set to the IP address or fully qualified domain name (FQDN) of your Azure NetApp Files endpoint using the format `"CN=<IP or FQDN>"`
46
-
* the **DNS Names** entry specifies the IP address or FQDN
46
+
### Required Azure Key Vault permissions
47
47
48
-
:::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":::
48
+
To avoid bucket creation failures, ensure that the Azure NetApp Files service has permission to read the certificate from Azure Key Vault.
49
+
50
+
At a minimum, the following permissions must be granted:
51
+
52
+
* Certificates: Get, List
53
+
* Secrets: Get (PKCS#12 certificates are accessed as secrets)
54
+
55
+
>NOTE
56
+
>If these permissions are missing, bucket creation fails when Azure NetApp Files attempts to retrieve the certificate.
57
+
58
+
59
+
### Option 2: Direct certificate upload
60
+
61
+
Use this option if you plan to generate the certificate locally and upload it manually during bucket creation.
62
+
63
+
When creating the certificate, ensure:
64
+
65
+
***Content Type**: PEM
66
+
***Subject**: IP address or fully qualified domain name (FQDN) of your Azure NetApp Files endpoint using the format `"CN=<IP or FQDN>"`
67
+
***DNS Names**: IP address or FQDN
49
68
50
-
#### [Script](#tab/script)
69
+
##Generate the certificate
51
70
52
-
This script creates a certificate locally. 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.
71
+
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.
echo"Self-signed certificate created at $CERT_DIR/server-cert.pem"
79
98
```
80
-
---
99
+
After the certificate is created, you will need to create a bucket.
81
100
82
101
## Create a bucket
83
102
84
103
To enable object REST API, you must create a bucket.
85
104
86
105
1. From your NetApp volume, select **Buckets**.
87
-
1.To create a bucket, select**+Create**.
106
+
1.Select**+Create**.
88
107
1. Provide the following information for the bucket:
89
108
***Name**
90
109
@@ -93,31 +112,45 @@ To enable object REST API, you must create a bucket.
93
112
94
113
The subdirectory path for object REST API. For full volume access, leave this field blank or use `/` for the root directory.
95
114
96
-
***User ID (UID)**
115
+
***NFS volume**
97
116
98
-
The UID used to read the bucket.
117
+
***User ID (UID)**
99
118
100
-
***Group ID (GID)**
119
+
The UID used to access the bucket.
101
120
102
-
The GID used to read the bucket.
121
+
***Group ID (GID)**
122
+
123
+
The GID used to access the bucket.
124
+
125
+
***SMB volume**
126
+
127
+
***Username**
128
+
129
+
The ID used to read the bucket.
103
130
104
131
***Permissions**
105
132
106
133
Select Read or Read-Write.
107
134
108
135
***Fully qualified domain name**
109
136
110
-
Enter the fully qualified domain name.
137
+
Enter the endpoint FQDN used by clients to access the buckets.
111
138
112
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":::
113
140
141
+
***Certificate source**
114
142
115
-
1. For the **Certificate source**, you can do one of the following:
143
+
***Azure Key Vault**
116
144
117
-
1. To use a certificate stored in the Azure Key Vault, select **Azure Key Vault** and use the "PKCS#12" certificate directly from the Azure Key Vault.
118
-
119
-
1. To upload the certificate manually, select **Upload Certificate** and upload the "PEM" certificate.
145
+
Select the **Vault URL** and **Certificate name** option to use a certificate stored in Azure Key Vault.
146
+
147
+
***Upload certificate**
120
148
149
+
Select the **certificate** option to upload a certificate file directly.
150
+
151
+
***Credentials storage**
152
+
153
+
Displayed in portal or stored in Azure Key Vault.
121
154
122
155
1. Select **Create**.
123
156
@@ -127,27 +160,39 @@ After you create a bucket, you need to generate credentials to access the bucket
127
160
128
161
You can modify a bucket's access management settings.
129
162
163
+
* User ID / Username
164
+
* Group ID
165
+
* Permissions
166
+
167
+
130
168
1. From your NetApp volume, select **Buckets**.
131
169
1. Select **+Create**.
132
170
1. Enter the name of the bucket you want to modify.
133
171
1. Change the access management settings as required.
134
-
1. You can modify the User ID, Group ID, Username (for SMB or dual-protocol volumes), and Permissions.
135
172
1. Click **Save** to modify the existing bucket.
136
173
137
174
> [!NOTE]
138
175
> You cannot modify a bucket’s path. To update a bucket’s path, delete and re-create the bucket with the new path.
139
176
140
177
## Generate credentials
141
178
142
-
1. Navigate to your newly created bucket. Select **Generate keys**.
143
-
1. Enter the desired Access key lifespan in days then select **Generate keys**. After you select **Generate keys**, the portal displays the access key and secret access key.
144
-
>[!IMPORTANT]
145
-
>The access key and secret access key are only displayed once. Store the keys securely. Do not share the keys.
146
-
1. After you set the credentials, you can generate a new access key and secret access key by selecting the `...` menu then selecting **Generate access keys**. Generating new keys immediately invalidates the existing keys.
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
+
147
192
148
193
## Delete a bucket
149
194
150
-
Deleting a bucket is a permanent operation. You can't recover the bucket after deleting it.
195
+
Deleting a bucket permanently removes it and all associated configuration. You can't recover the bucket after deleting it.
151
196
152
197
1. In your NetApp account, navigate to **Buckets**.
153
198
1. Select the checkbox next to the bucket you want to delete.
Copy file name to clipboardExpand all lines: articles/azure-netapp-files/whats-new.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,14 @@ ms.author: anfdocs
17
17
18
18
Azure NetApp Files is updated regularly. This article provides a summary about the latest new features and enhancements.
19
19
20
+
## March 2026
21
+
22
+
*[Azure Key Vault–based certificate support for Azure NetApp Files object REST API](object-rest-api-access-configure.md) (preview)
23
+
Azure NetApp Files object REST API now supports Azure Key Vault–based certificates for enabling S3‑compatible access to volumes. With this enhancement, you can store self‑signed certificates securely in Azure Key Vault and have Azure NetApp Files retrieve the certificate directly during bucket creation, eliminating the need to generate and upload certificate files manually.
24
+
25
+
This capability simplifies certificate lifecycle management, strengthens security by centralizing certificate storage, and aligns object REST API access with enterprise key‑management best practices. When using Azure Key Vault–based certificates, object REST API access credentials can also be stored securely in Azure Key Vault rather than displayed in the Azure portal.
26
+
27
+
20
28
## January 2026
21
29
22
30
*[Elastic zone-redundant storage service level](elastic-zone-redundant-concept.md) (preview)
0 commit comments