Snapshot Policies - List

Riferimento

Servizio:: Azure NetApp Files

Versione API:: 2024-07-01

Elencare i criteri di snapshot

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies?api-version=2024-07-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account NetApp Criterio di espressione regolare: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	snapshotPoliciesList	OK
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SnapshotPolicies_List

Esempio di richiesta

GET https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies?api-version=2024-07-01


/**
 * Samples for SnapshotPolicies List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json
     */
    /**
     * Sample code: SnapshotPolicies_List.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void snapshotPoliciesList(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.snapshotPolicies().list("myRG", "account1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python snapshot_policies_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
    )

    response = client.snapshot_policies.list(
        resource_group_name="myRG",
        account_name="account1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/366aaa13cdd218b9adac716680e49473673410c8/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json
func ExampleSnapshotPoliciesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSnapshotPoliciesClient().NewListPager("myRG", "account1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SnapshotPoliciesList = armnetapp.SnapshotPoliciesList{
		// 	Value: []*armnetapp.SnapshotPolicy{
		// 		{
		// 			Name: to.Ptr("account1/snapshotPolicy1"),
		// 			Type: to.Ptr("Microsoft.NetApp/netAppAccounts/snapshotPolicies"),
		// 			ID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1"),
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armnetapp.SnapshotPolicyProperties{
		// 				DailySchedule: &armnetapp.DailySchedule{
		// 					Hour: to.Ptr[int32](14),
		// 					Minute: to.Ptr[int32](30),
		// 					SnapshotsToKeep: to.Ptr[int32](4),
		// 				},
		// 				Enabled: to.Ptr(true),
		// 				HourlySchedule: &armnetapp.HourlySchedule{
		// 					Minute: to.Ptr[int32](50),
		// 					SnapshotsToKeep: to.Ptr[int32](2),
		// 				},
		// 				MonthlySchedule: &armnetapp.MonthlySchedule{
		// 					DaysOfMonth: to.Ptr("10,11,12"),
		// 					Hour: to.Ptr[int32](14),
		// 					Minute: to.Ptr[int32](15),
		// 					SnapshotsToKeep: to.Ptr[int32](5),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				WeeklySchedule: &armnetapp.WeeklySchedule{
		// 					Day: to.Ptr("Wednesday"),
		// 					Hour: to.Ptr[int32](14),
		// 					Minute: to.Ptr[int32](45),
		// 					SnapshotsToKeep: to.Ptr[int32](3),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List snapshot policy
 *
 * @summary List snapshot policy
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json
 */
async function snapshotPoliciesList() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.snapshotPolicies.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json
// this example is just showing the usage of "SnapshotPolicies_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetAppAccountResource created on azure
// for more information of creating NetAppAccountResource, please refer to the document of NetAppAccountResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
string resourceGroupName = "myRG";
string accountName = "account1";
ResourceIdentifier netAppAccountResourceId = NetAppAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
NetAppAccountResource netAppAccount = client.GetNetAppAccountResource(netAppAccountResourceId);

// get the collection of this SnapshotPolicyResource
SnapshotPolicyCollection collection = netAppAccount.GetSnapshotPolicies();

// invoke the operation and iterate over the result
await foreach (SnapshotPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SnapshotPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
      "name": "account1/snapshotPolicy1",
      "location": "eastus",
      "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
      "properties": {
        "enabled": true,
        "hourlySchedule": {
          "snapshotsToKeep": 2,
          "minute": 50
        },
        "dailySchedule": {
          "snapshotsToKeep": 4,
          "hour": 14,
          "minute": 30
        },
        "weeklySchedule": {
          "snapshotsToKeep": 3,
          "day": "Wednesday",
          "hour": 14,
          "minute": 45
        },
        "monthlySchedule": {
          "snapshotsToKeep": 5,
          "daysOfMonth": "10,11,12",
          "hour": 14,
          "minute": 15
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
dailySchedule	Proprietà pianificazione giornaliera
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
hourlySchedule	Proprietà Pianificazione oraria
monthlySchedule	Proprietà pianificazione mensile
snapshotPoliciesList	Elenco dei criteri di snapshot
snapshotPolicy	Informazioni sui criteri di snapshot
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
weeklySchedule	Proprietà Pianificazione settimanale, creazione di uno snapshot ogni settimana in un giorno o giorni specifici

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

dailySchedule

Proprietà pianificazione giornaliera

Nome	Tipo	Descrizione
hour	integer	Indica l'ora nel fuso orario UTC da creare uno snapshot
minute	integer	Indica quale snapshot dei minuti deve essere creato
snapshotsToKeep	integer	Numero di snapshot giornalieri da mantenere
usedBytes	integer	Dimensioni delle risorse in byte, utilizzo corrente dello spazio di archiviazione per il volume in byte

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

hourlySchedule

Proprietà Pianificazione oraria

Nome	Tipo	Descrizione
minute	integer	Indica quale snapshot dei minuti deve essere creato
snapshotsToKeep	integer	Numero di snapshot orari da mantenere
usedBytes	integer	Dimensioni delle risorse in byte, utilizzo corrente dello spazio di archiviazione per il volume in byte

monthlySchedule

Proprietà pianificazione mensile

Nome	Tipo	Descrizione
daysOfMonth	string	Indica i giorni di creazione dello snapshot del mese. Stringa delimitata da virgole.
hour	integer	Indica l'ora nel fuso orario UTC da creare uno snapshot
minute	integer	Indica quale snapshot dei minuti deve essere creato
snapshotsToKeep	integer	Numero di snapshot mensili da mantenere
usedBytes	integer	Dimensioni delle risorse in byte, utilizzo corrente dello spazio di archiviazione per il volume in byte

snapshotPoliciesList

Elenco dei criteri di snapshot

Nome	Tipo	Descrizione
value	snapshotPolicy[]	Elenco dei criteri di snapshot

snapshotPolicy

Informazioni sui criteri di snapshot

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.dailySchedule	dailySchedule	dailySchedule Pianificare gli snapshot giornalieri
properties.enabled	boolean	La proprietà per decidere che i criteri sono abilitati o meno
properties.hourlySchedule	hourlySchedule	hourlySchedule Pianificare snapshot orari
properties.monthlySchedule	monthlySchedule	monthlySchedule Pianificare gli snapshot mensili
properties.provisioningState	string	Gestione del ciclo di vita di Azure
properties.weeklySchedule	weeklySchedule	weeklySchedule Pianificare gli snapshot settimanali
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

weeklySchedule

Proprietà Pianificazione settimanale, creazione di uno snapshot ogni settimana in un giorno o giorni specifici

Nome	Tipo	Descrizione
day	string	Indica quale snapshot dei giorni feriali deve essere creato, accetta un elenco delimitato da virgole di nomi dei giorni della settimana in inglese
hour	integer	Indica l'ora nel fuso orario UTC da creare uno snapshot
minute	integer	Indica quale snapshot dei minuti deve essere creato
snapshotsToKeep	integer	Numero di snapshot settimanali da mantenere
usedBytes	integer	Dimensioni delle risorse in byte, utilizzo corrente dello spazio di archiviazione per il volume in byte