Skip to content

Commit 193bec8

Browse files
authored
Merge pull request #213182 from b-ahibbard/update-api-version
Update api version in develop documents
2 parents 9a4eb44 + f266ce3 commit 193bec8

6 files changed

+48
-48
lines changed

articles/azure-netapp-files/azure-netapp-files-develop-with-rest-api.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-netapp-files
1212
ms.workload: storage
1313
ms.tgt_pltfrm: na
1414
ms.topic: how-to
15-
ms.date: 06/15/2022
15+
ms.date: 09/30/2022
1616
ms.author: anfdocs
1717
---
1818
# Develop for Azure NetApp Files with REST API
@@ -27,7 +27,7 @@ The REST API specification for Azure NetApp Files is published through [GitHub](
2727

2828
## Considerations
2929

30-
* When the API limit has been exceeded, the HTTP response code is **429**. For example:
30+
* When the API limit has been exceeded, the HTTP response code is **429**. For example:
3131

3232
`"Microsoft.Azure.ResourceProvider.Common.Exceptions.ResourceProviderException: Error getting Pool. Rate limit exceeded for this endpoint - try again later ---> CloudVolumes.Service.Client.Client.ApiException: Error calling V2DescribePool: {\"code\":429,\"message\":\"Rate limit exceeded for this endpoint - try again later\"}`
3333

@@ -79,14 +79,14 @@ The REST API specification for Azure NetApp Files is published through [GitHub](
7979
4. Send a test call and include the token to validate your access to the REST API:
8080
8181
```azurecli
82-
curl -X GET -H "Authorization: Bearer [TOKEN]" -H "Content-Type: application/json" https://management.azure.com/subscriptions/[SUBSCRIPTION_ID]/providers/Microsoft.Web/sites?api-version=2019-11-01
82+
curl -X GET -H "Authorization: Bearer [TOKEN]" -H "Content-Type: application/json" https://management.azure.com/subscriptions/[SUBSCRIPTION_ID]/providers/Microsoft.Web/sites?api-version=2022-05-01
8383
```
8484
8585
## Examples using the API
8686
8787
This article uses the following URL for the baseline of requests. This URL points to the root of the Azure NetApp Files namespace.
8888
89-
`https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts?api-version=2019-11-01`
89+
`https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts?api-version=2022-05-01`
9090
9191
You should replace the `SUBIDGOESHERE` and `RESOURCEGROUPGOESHERE` values in the following examples with your own values.
9292
@@ -96,22 +96,22 @@ You use a GET request to query objects of Azure NetApp Files in a subscription,
9696
9797
```azurecli
9898
#get NetApp accounts
99-
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts?api-version=2019-11-01
99+
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts?api-version=2022-05-01
100100
```
101101

102102
```azurecli
103103
#get capacity pools for NetApp account
104-
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools?api-version=2019-11-01
104+
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools?api-version=2022-05-01
105105
```
106106

107107
```azurecli
108108
#get volumes in NetApp account & capacity pool
109-
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes?api-version=2019-11-01
109+
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes?api-version=2022-05-01
110110
```
111111

112112
```azurecli
113113
#get snapshots for a volume
114-
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/VOLUMEGOESHERE/snapshots?api-version=2019-11-01
114+
curl -X GET -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/VOLUMEGOESHERE/snapshots?api-version=2022-05-01
115115
```
116116

117117
### PUT request examples
@@ -120,22 +120,22 @@ You use a PUT request to create new objects in Azure NetApp Files, as the follow
120120

121121
```azurecli
122122
#create a NetApp account
123-
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE?api-version=2019-11-01
123+
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE?api-version=2022-05-01
124124
```
125125

126126
```azurecli
127127
#create a capacity pool
128-
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE?api-version=2019-11-01
128+
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE?api-version=2022-05-01
129129
```
130130

131131
```azurecli
132132
#create a volume
133-
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/MYNEWVOLUME?api-version=2019-11-01
133+
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/MYNEWVOLUME?api-version=2022-05-01
134134
```
135135

136136
```azurecli
137137
#create a volume snapshot
138-
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/MYNEWVOLUME/Snapshots/SNAPNAME?api-version=2019-11-01
138+
curl -d @<filename> -X PUT -H "Authorization: Bearer TOKENGOESHERE" -H "Content-Type: application/json" https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts/NETAPPACCOUNTGOESHERE/capacityPools/CAPACITYPOOLGOESHERE/volumes/MYNEWVOLUME/Snapshots/SNAPNAME?api-version=2022-05-01
139139
```
140140

141141
### JSON examples

articles/azure-netapp-files/azure-netapp-files-resize-capacity-pools-or-volumes.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-netapp-files
1212
ms.workload: storage
1313
ms.tgt_pltfrm: na
1414
ms.topic: how-to
15-
ms.date: 04/30/2021
15+
ms.date: 9/30/2022
1616
ms.author: anfdocs
1717
---
1818
# Resize a capacity pool or a volume
@@ -24,25 +24,25 @@ For information about monitoring a volume’s capacity, see [Monitor the capacit
2424

2525
You can change the capacity pool size in 1-TiB increments or decrements. However, the capacity pool size cannot be smaller than the sum of the capacity of the volumes hosted in the pool, with a minimum of 4TiB. Resizing the capacity pool changes the purchased Azure NetApp Files capacity.
2626

27-
1. From the NetApp Account view, go to **Capacity pools**, and click the capacity pool that you want to resize.
28-
2. Right-click the capacity pool name or click the "…" icon at the end of the capacity pool row to display the context menu. Click **Resize**.
27+
1. From the NetApp Account view, go to **Capacity pools**, and select the capacity pool that you want to resize.
28+
2. Right-click the capacity pool name or select the "…" icon at the end of the capacity pool row to display the context menu. Select **Resize**.
2929

3030
![Screenshot that shows pool context menu.](../media/azure-netapp-files/resize-pool-context-menu.png)
3131

32-
3. In the Resize pool window, specify the pool size. Click **OK**.
32+
3. In the Resize pool window, specify the pool size. Select **OK**.
3333

3434
![Screenshot that shows Resize pool window.](../media/azure-netapp-files/resize-pool-window.png)
3535

3636
## Resize a volume using the Azure portal
3737

3838
You can change the size of a volume as necessary. A volume's capacity consumption counts against its pool's provisioned capacity.
3939

40-
1. From the NetApp Account view, go to **Volumes**, and click the volume that you want to resize.
41-
2. Right-click the volume name or click the "…" icon at the end of the volume's row to display the context menu. Click **Resize**.
40+
1. From the NetApp Account view, go to **Volumes**, and select the volume that you want to resize.
41+
2. Right-click the volume name or select the "…" icon at the end of the volume's row to display the context menu. Select **Resize**.
4242

4343
![Screenshot that shows volume context menu.](../media/azure-netapp-files/resize-volume-context-menu.png)
4444

45-
3. In the Update volume quota window, specify the quota for the volume. Click **OK**.
45+
3. In the Update volume quota window, specify the quota for the volume. Select **OK**.
4646

4747
![Screenshot that shows Update Volume Quota window.](../media/azure-netapp-files/resize-volume-quota-window.png)
4848

@@ -59,7 +59,7 @@ You can build automation to handle the capacity pool and volume size change.
5959

6060
See [REST API for Azure NetApp Files](azure-netapp-files-develop-with-rest-api.md) and [REST API using PowerShell for Azure NetApp Files](develop-rest-api-powershell.md).
6161

62-
The REST API specification and example code for Azure NetApp Files are available through the [resource-manager GitHub directory](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/netapp/resource-manager/Microsoft.NetApp/stable).
62+
The REST API specification and example code for Azure NetApp Files are available through the [resource-manager GitHub directory](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable).
6363

6464
## Resize a cross-region replication destination volume
6565

articles/azure-netapp-files/azure-netapp-files-sdk-cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-netapp-files
1212
ms.workload: storage
1313
ms.tgt_pltfrm: na
1414
ms.topic: conceptual
15-
ms.date: 10/21/2020
15+
ms.date: 09/30/2022
1616
ms.author: anfdocs
1717
---
1818
# Azure NetApp Files SDKs, CLI tools, and ARM templates
@@ -25,11 +25,11 @@ The table below lists the supported SDKs. You can find details about the suppor
2525

2626
| Language | SDK published location in GitHub |
2727
|------------------|--------------------------------------------------------------|
28-
| .NET | [Azure/azure-sdk-for-net](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/netapp) |
29-
| Python | [Azure/azure-sdk-for-python](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/netapp) |
30-
| Go | [Azure/azure-sdk-for-go](https://github.com/Azure/azure-sdk-for-go/tree/master/services/netapp) |
31-
| Java | [Azure/azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/netapp) |
32-
| JavaScript | [Azure/azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/netapp/arm-netapp) |
28+
| .NET | [Azure/azure-sdk-for-net](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/netapp) |
29+
| Python | [Azure/azure-sdk-for-python](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/netapp) |
30+
| Go | [Azure/azure-sdk-for-go](https://github.com/Azure/azure-sdk-for-go/tree/main/services/netapp) |
31+
| Java | [Azure/azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/netapp) |
32+
| JavaScript | [Azure/azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/netapp/arm-netapp) |
3333
| Ruby | [Azure/azure-sdk-for-ruby](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_netapp) |
3434

3535
## CLI tools

articles/azure-netapp-files/develop-rest-api-powershell.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-netapp-files
1212
ms.workload: storage
1313
ms.tgt_pltfrm: na
1414
ms.topic: how-to
15-
ms.date: 06/02/2020
15+
ms.date: 09/30/2022
1616
ms.author: anfdocs
1717
---
1818
# Develop for Azure NetApp Files with REST API using PowerShell
@@ -21,9 +21,9 @@ The REST API for the Azure NetApp Files service defines HTTP operations against
2121

2222
## Azure NetApp Files REST API specification
2323

24-
The REST API specification for Azure NetApp Files is published through [GitHub](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/netapp/resource-manager):
24+
The REST API specification for Azure NetApp Files is published through [GitHub](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager):
2525

26-
`https://github.com/Azure/azure-rest-api-specs/tree/master/specification/netapp/resource-manager`
26+
`https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager`
2727

2828

2929
## Access the Azure NetApp Files REST API
@@ -80,14 +80,14 @@ The REST API specification for Azure NetApp Files is published through [GitHub](
8080
8181
```azurepowershell
8282
$SubId = (Get-AzContext).Subscription.Id
83-
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SubId/providers/Microsoft.Web/sites?api-version=2019-11-01
83+
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SubId/providers/Microsoft.Web/sites?api-version=2022-05-01
8484
```
8585
8686
## Examples using the API
8787
8888
This article uses the following URL for the baseline of requests. This URL points to the root of the Azure NetApp Files namespace.
8989
90-
`https://management.azure.com/subscriptions/$SUBID/resourceGroups/$RESOURCEGROUP/providers/Microsoft.NetApp/netAppAccounts?api-version=2019-11-01`
90+
`https://management.azure.com/subscriptions/$SUBID/resourceGroups/$RESOURCEGROUP/providers/Microsoft.NetApp/netAppAccounts?api-version=2022-05-01`
9191
9292
You should assign variable values before running the following examples with your own values.
9393
PowerShell variables are accessed by typing `$variablename`.
@@ -245,22 +245,22 @@ An error occurs if the resource does not exist. You use a GET request to query o
245245

246246
```azurepowershell
247247
#get NetApp accounts
248-
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts?api-version=2019-11-01 | ConvertTo-Json
248+
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts?api-version=2022-05-01 | ConvertTo-Json
249249
```
250250

251251
```azurepowershell
252252
#get capacity pools for NetApp account
253-
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools?api-version=2019-11-01 | ConvertTo-Json
253+
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools?api-version=2022-05-01 | ConvertTo-Json
254254
```
255255

256256
```azurepowershell
257257
#get volumes in NetApp account & capacity pool
258-
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools/$ANFCAPACITYPOOL/volumes?api-version=2019-11-01 | ConvertTo-Json
258+
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools/$ANFCAPACITYPOOL/volumes?api-version=2022-05-01 | ConvertTo-Json
259259
```
260260

261261
```azurepowershell
262262
#get snapshots for a volume
263-
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools/$ANFCAPACITYPOOL/volumes/$ANFVOLUME/snapshots?api-version=2019-11-01 | ConvertTo-Json
263+
Invoke-RestMethod -Method Get -Headers $headers -Uri https://management.azure.com/subscriptions/$SUBID/resourceGroups/$ResourceGroup/providers/Microsoft.NetApp/netAppAccounts/$ANFACCOUNT/capacityPools/$ANFCAPACITYPOOL/volumes/$ANFVOLUME/snapshots?api-version=2022-05-01 | ConvertTo-Json
264264
```
265265

266266
### Complete PowerShell scripts

articles/azure-netapp-files/monitor-volume-capacity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-netapp-files
1212
ms.workload: storage
1313
ms.tgt_pltfrm: na
1414
ms.topic: how-to
15-
ms.date: 04/04/2022
15+
ms.date: 09/30/2022
1616
ms.author: anfdocs
1717
---
1818
# Monitor the capacity of a volume
@@ -63,7 +63,7 @@ You can use the [`az netappfiles volume`](/cli/azure/netappfiles/volume) command
6363

6464
See [REST API for Azure NetApp Files](azure-netapp-files-develop-with-rest-api.md) and [REST API using PowerShell for Azure NetApp Files](develop-rest-api-powershell.md).
6565

66-
The REST API specification and example code for Azure NetApp Files are available through the [resource-manager GitHub directory](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/netapp/resource-manager/Microsoft.NetApp/stable).
66+
The REST API specification and example code for Azure NetApp Files are available through the [resource-manager GitHub directory](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable).
6767

6868
## Next steps
6969

0 commit comments

Comments
 (0)