你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Snapshot Policies - List

参考

Service:: Azure NetApp Files

API Version:: 2023-07-01

列出快照策略

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	NetApp 帐户的名称 Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	snapshotPoliciesList	确定
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

SnapshotPolicies_List

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

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

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-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

Sample Response

Status code:: 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"
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识类型。
dailySchedule	每日计划属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
hourlySchedule	每小时计划属性
monthlySchedule	每月计划属性
snapshotPoliciesList	快照策略列表
snapshotPolicy	快照策略信息
systemData	与资源的创建和上次修改相关的元数据。
weeklySchedule	每周计划属性，每周在特定日期或特定日期快照

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

dailySchedule

每日计划属性

名称	类型	说明
hour	integer	指示快照应采用 UTC 时区中的哪个小时
minute	integer	指示应采用哪一分钟快照
snapshotsToKeep	integer	要保留的每日快照计数
usedBytes	integer	资源大小（以字节为单位），卷的当前存储使用情况（以字节为单位）

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

hourlySchedule

每小时计划属性

名称	类型	说明
minute	integer	指示应采用哪一分钟快照
snapshotsToKeep	integer	要保留的每小时快照计数
usedBytes	integer	资源大小（以字节为单位），卷的当前存储使用情况（以字节为单位）

monthlySchedule

每月计划属性

名称	类型	说明
daysOfMonth	string	指示应快照一个月中的哪几天。逗号分隔的字符串。
hour	integer	指示快照应采用 UTC 时区中的哪个小时
minute	integer	指示应采用哪一分钟快照
snapshotsToKeep	integer	要保留的每月快照计数
usedBytes	integer	资源大小（以字节为单位），卷的当前存储使用情况（以字节为单位）

snapshotPoliciesList

快照策略列表

名称	类型	说明
value	snapshotPolicy[]	快照策略列表

snapshotPolicy

快照策略信息

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源的完全限定的资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.dailySchedule	dailySchedule	dailySchedule 每日快照的计划
properties.enabled	boolean	用于决定策略的属性已启用
properties.hourlySchedule	hourlySchedule	hourlySchedule 计划每小时快照
properties.monthlySchedule	monthlySchedule	monthlySchedule 每月快照的计划
properties.provisioningState	string	Azure 生命周期管理
properties.weeklySchedule	weeklySchedule	weeklySchedule 计划每周快照
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

weeklySchedule

每周计划属性，每周在特定日期或特定日期快照

名称	类型	说明
day	string	指示应采用哪些工作日快照，接受英文星期几名称的逗号分隔列表
hour	integer	指示快照应采用 UTC 时区中的哪个小时
minute	integer	指示应采用哪一分钟快照
snapshotsToKeep	integer	要保留的每周快照计数
usedBytes	integer	资源大小（以字节为单位），卷的当前存储使用情况（以字节为单位）