Utveckla för Azure NetApp Files med REST-API

Artikel
11/20/2021
3 minuter för att läsa

I REST API för Azure NetApp Files-tjänsten definieras HTTP-åtgärder mot resurser som NetApp-kontot, kapacitetspoolen, volymerna och ögonblicksbilderna. Den här artikeln hjälper dig att komma igång med att använda Azure NetApp Files REST API.

Azure NetApp Files REST API specifikation

Specifikationen REST API för Azure NetApp Files publiceras via GitHub:

https://github.com/Azure/azure-rest-api-specs/tree/master/specification/netapp/resource-manager

Överväganden

När API-gränsen har överskridits är HTTP-svarskoden 429. Exempel:

"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\"}

Den här svarskoden kan komma från begränsning eller ett tillfälligt villkor. Se Azure Resource Manager HTTP 429-svarskod för mer information.

Åtkomst till Azure NetApp Files REST API

Installera Azure CLI om du inte redan har gjort det.
Skapa ett huvudnamn för tjänsten i Azure Active Directory (Azure AD):
1. Kontrollera att du har tillräcklig behörighet.
2. Ange följande kommando i Azure CLI:
```
az ad sp create-for-rbac --name $YOURSPNAMEGOESHERE --role Contributor
```
  Kommandoutdata liknar följande exempel:
```
{ 
    "appId": "appIDgoeshere", 
    "displayName": "APPNAME", 
    "name": "http://APPNAME", 
    "password": "supersecretpassword", 
    "tenant": "tenantIDgoeshere" 
} 
```
  Behåll kommandoutdata. Du behöver värdena appId password , och tenant .
Begär en OAuth-åtkomsttoken:

Exemplen i den här artikeln använder cURL. Du kan också använda olika API-verktyg som Postman, Insomniaoch Paw.

Ersätt variablerna i följande exempel med kommandoutdata från steg 2 ovan.
```
curl -X POST -d 'grant_type=client_credentials&client_id=[APP_ID]&client_secret=[PASSWORD]&resource=https%3A%2F%2Fmanagement.azure.com%2F' https://login.microsoftonline.com/[TENANT_ID]/oauth2/token
```
Utdata ger en åtkomsttoken som liknar följande exempel:

eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5iQ3dXMTF3M1hrQi14VWFYd0tSU0xqTUhHUSIsImtpZCI6Im5iQ3dXMTF3M1hrQi14VWFYd0tSU0xqTUhHUSJ9

Token som visas är giltig i 3 600 sekunder. Efter det måste du begära en ny token. Spara token i en textredigerare. Du behöver den för nästa steg.

Skicka ett testsamtal och inkludera token för att verifiera din åtkomst till REST API:

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

Exempel som använder API:et

I den här artikeln används följande URL för baslinjen för begäranden. Den här URL:en pekar på roten Azure NetApp Files namnområdet.

https://management.azure.com/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.NetApp/netAppAccounts?api-version=2019-11-01

Du bör ersätta SUBIDGOESHERE värdena och i följande exempel med dina egna RESOURCEGROUPGOESHERE värden.

Exempel på GET-begäran

Du använder en GET-begäran för att fråga Azure NetApp Files i en prenumeration, som i följande exempel:

#get NetApp accounts 
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

#get capacity pools for NetApp account 
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

#get volumes in NetApp account & capacity pool 
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

#get snapshots for a volume 
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

Exempel på PUT-begäran

Du använder en PUT-begäran för att skapa nya Azure NetApp Files objekt, som i följande exempel. Brödtexten i PUT-begäran kan innehålla JSON-formaterade data för ändringarna. Det måste ingå i curl-kommandot som text eller referenser som en fil. Om du vill referera till brödtexten som en fil sparar du json-exemplet i en fil och lägger -d @<filename> till i curl-kommandot.

#create a NetApp account  
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

#create a capacity pool  
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

#create a volume  
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

 #create a volume snapshot  
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

JSON-exempel

I följande exempel visas hur du skapar ett NetApp-konto:

{ 
    "name": "MYNETAPPACCOUNT", 
    "type": "Microsoft.NetApp/netAppAccounts", 
    "location": "westus2", 
    "properties": { 
        "name": "MYNETAPPACCOUNT" 
    }
}

I följande exempel visas hur du skapar en kapacitetspool:

{
    "name": "MYNETAPPACCOUNT/POOLNAME",
    "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
    "location": "westus2",
    "properties": {
        "name": "POOLNAME",
        "size": "4398046511104",
        "serviceLevel": "Premium"
    }
}

I följande exempel visas hur du skapar en ny volym. (Standardprotokollet för volymen är NFSV3.)

{
    "name": "MYNEWVOLUME",
    "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
    "location": "westus2",
    "properties": {
        "serviceLevel": "Premium",
        "usageThreshold": "322122547200",
        "creationToken": "MY-FILEPATH",
        "snapshotId": "",
        "subnetId": "/subscriptions/SUBIDGOESHERE/resourceGroups/RESOURCEGROUPGOESHERE/providers/Microsoft.Network/virtualNetworks/VNETGOESHERE/subnets/MYDELEGATEDSUBNET.sn"
         }
}

I följande exempel visas hur du skapar en ögonblicksbild av en volym:

{
    "name": "apitest2/apiPool01/apiVol01/snap02",
    "type": "Microsoft.NetApp/netAppAccounts/capacityPools/Volumes/Snapshots",
    "location": "westus2",
    "properties": {
         "name": "snap02",
        "fileSystemId": "0168704a-bbec-da81-2c29-503825fe7420"
    }
}

Anteckning

Du måste ange för fileSystemId att skapa en ögonblicksbild. Du kan hämta värdet fileSystemId med en GET-begäran till en volym.

Nästa steg

Se Azure NetApp Files REST API referens