Snapshot Policies - List

Referencia

Szolgáltatás:: Azure NetApp Files

API-verzió:: 2023-11-01

Pillanatkép-szabályzat listázása

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A NetApp-fiók neve Reguláris kifejezési minta: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string uuid	A cél-előfizetés azonosítója. Az értéknek UUID-nak kell lennie.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	snapshotPoliciesList	OK
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

SnapshotPolicies_List

Mintakérelem

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


/**
 * Samples for SnapshotPolicies List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-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/2023-11-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/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-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/2023-11-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

Mintaválasz

Állapotkód:: 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"
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
dailySchedule	Napi ütemezés tulajdonságai
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
hourlySchedule	Óránkénti ütemezés tulajdonságai
monthlySchedule	Havi ütemezés tulajdonságai
snapshotPoliciesList	Pillanatkép-szabályzatok listája
snapshotPolicy	Pillanatkép-szabályzat adatai
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
weeklySchedule	Heti ütemezés tulajdonságai, pillanatkép készítése minden héten egy adott napon vagy napon

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

dailySchedule

Napi ütemezés tulajdonságai

Name	Típus	Description
hour	integer	Azt jelzi, hogy az UTC időzónában melyik órát kell pillanatképet készíteni
minute	integer	Azt jelzi, hogy melyik pillanatképet kell készíteni
snapshotsToKeep	integer	Napi pillanatképek száma megtartandó
usedBytes	integer	Erőforrás mérete bájtban, a kötet aktuális tárhasználata bájtban

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

hourlySchedule

Óránkénti ütemezés tulajdonságai

Name	Típus	Description
minute	integer	Azt jelzi, hogy melyik pillanatképet kell készíteni
snapshotsToKeep	integer	Óránkénti pillanatképek száma megtartandó
usedBytes	integer	Erőforrás mérete bájtban, a kötet aktuális tárhasználata bájtban

monthlySchedule

Havi ütemezés tulajdonságai

Name	Típus	Description
daysOfMonth	string	Azt jelzi, hogy a hónap mely napjait kell pillanatképet készíteni. Vesszővel tagolt sztring.
hour	integer	Azt jelzi, hogy az UTC időzónában melyik órát kell pillanatképet készíteni
minute	integer	Azt jelzi, hogy melyik pillanatképet kell készíteni
snapshotsToKeep	integer	Havi pillanatképek száma megtartandó
usedBytes	integer	Erőforrás mérete bájtban, a kötet aktuális tárhasználata bájtban

snapshotPoliciesList

Pillanatkép-szabályzatok listája

Name	Típus	Description
value	snapshotPolicy[]	Pillanatkép-szabályzatok listája

snapshotPolicy

Pillanatkép-szabályzat adatai

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.dailySchedule	dailySchedule	dailySchedule Napi pillanatképek ütemezése
properties.enabled	boolean	A szabályzatot eldöntő tulajdonság engedélyezve van vagy nincs
properties.hourlySchedule	hourlySchedule	hourlySchedule Óránkénti pillanatképek ütemezése
properties.monthlySchedule	monthlySchedule	monthlySchedule Havi pillanatképek ütemezése
properties.provisioningState	string	Azure-életciklus-felügyelet
properties.weeklySchedule	weeklySchedule	weeklySchedule Heti pillanatképek ütemezése
systemData	systemData	Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

weeklySchedule

Heti ütemezés tulajdonságai, pillanatkép készítése minden héten egy adott napon vagy napon

Name	Típus	Description
day	string	Azt jelzi, hogy mely hétköznapok pillanatképét kell készíteni, elfogadja a hétnapok neveinek vesszővel tagolt listáját angol nyelven
hour	integer	Azt jelzi, hogy az UTC időzónában melyik órát kell pillanatképet készíteni
minute	integer	Azt jelzi, hogy melyik pillanatképet kell készíteni
snapshotsToKeep	integer	Heti pillanatképek száma megtartandó
usedBytes	integer	Erőforrás mérete bájtban, a kötet aktuális tárhasználata bájtban

Megosztás a következőn keresztül:

Snapshot Policies - List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

SnapshotPolicies_List

Mintakérelem

Mintaválasz

Definíciók

createdByType

dailySchedule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

hourlySchedule

monthlySchedule

snapshotPoliciesList

snapshotPolicy

systemData

weeklySchedule

További források