Snapshot Policies - Update

リファレンス

サービス:: Azure NetApp Files

API バージョン:: 2024-03-01

スナップショットポリシーにパッチを適用する

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	NetApp アカウントの名前正規表現パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
resourceGroupName	path	True	string	リソースグループの名前。名前では大文字と小文字が区別されません。
snapshotPolicyName	path	True	string	スナップショットポリシーの名前
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
location	string	リソースの場所
properties.dailySchedule	dailySchedule	dailySchedule 毎日のスナップショットのスケジュール
properties.enabled	boolean	ポリシーが有効かどうかを決定するプロパティ
properties.hourlySchedule	hourlySchedule	hourlySchedule 時間単位のスナップショットのスケジュール
properties.monthlySchedule	monthlySchedule	monthlySchedule 毎月のスナップショットのスケジュール
properties.weeklySchedule	weeklySchedule	weeklySchedule 毎週のスナップショットのスケジュール
tags	object	リソースタグ

応答

名前	型	説明
200 OK	snapshotPolicy	わかりました
202 Accepted	snapshotPolicy	受け入れ済み -- 作成要求または更新要求が受け入れ済み。操作は非同期的に完了します
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

SnapshotPolicies_Update

要求のサンプル

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

{
  "location": "eastus",
  "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
    }
  }
}


import com.azure.resourcemanager.netapp.models.DailySchedule;
import com.azure.resourcemanager.netapp.models.HourlySchedule;
import com.azure.resourcemanager.netapp.models.MonthlySchedule;
import com.azure.resourcemanager.netapp.models.SnapshotPolicy;
import com.azure.resourcemanager.netapp.models.WeeklySchedule;

/**
 * Samples for SnapshotPolicies Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Update.json
     */
    /**
     * Sample code: SnapshotPolicies_Update.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void snapshotPoliciesUpdate(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        SnapshotPolicy resource = manager.snapshotPolicies()
            .getWithResponse("myRG", "account1", "snapshotPolicyName", com.azure.core.util.Context.NONE).getValue();
        resource.update().withHourlySchedule(new HourlySchedule().withSnapshotsToKeep(2).withMinute(50))
            .withDailySchedule(new DailySchedule().withSnapshotsToKeep(4).withHour(14).withMinute(30))
            .withWeeklySchedule(
                new WeeklySchedule().withSnapshotsToKeep(3).withDay("Wednesday").withHour(14).withMinute(45))
            .withMonthlySchedule(
                new MonthlySchedule().withSnapshotsToKeep(5).withDaysOfMonth("10,11,12").withHour(14).withMinute(15))
            .withEnabled(true).apply();
    }
}

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

from typing import Any, IO, Union

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_update.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.begin_update(
        resource_group_name="myRG",
        account_name="account1",
        snapshot_policy_name="snapshotPolicyName",
        body={
            "location": "eastus",
            "properties": {
                "dailySchedule": {"hour": 14, "minute": 30, "snapshotsToKeep": 4},
                "enabled": True,
                "hourlySchedule": {"minute": 50, "snapshotsToKeep": 2},
                "monthlySchedule": {"daysOfMonth": "10,11,12", "hour": 14, "minute": 15, "snapshotsToKeep": 5},
                "weeklySchedule": {"day": "Wednesday", "hour": 14, "minute": 45, "snapshotsToKeep": 3},
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Update.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/azcore/to"
	"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/c7b98b36e4023331545051284d8500adf98f02fe/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Update.json
func ExampleSnapshotPoliciesClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewSnapshotPoliciesClient().BeginUpdate(ctx, "myRG", "account1", "snapshotPolicyName", armnetapp.SnapshotPolicyPatch{
		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),
			},
			WeeklySchedule: &armnetapp.WeeklySchedule{
				Day:             to.Ptr("Wednesday"),
				Hour:            to.Ptr[int32](14),
				Minute:          to.Ptr[int32](45),
				SnapshotsToKeep: to.Ptr[int32](3),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SnapshotPolicy = 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 Patch a snapshot policy
 *
 * @summary Patch a snapshot policy
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Update.json
 */
async function snapshotPoliciesUpdate() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const snapshotPolicyName = "snapshotPolicyName";
  const body = {
    dailySchedule: { hour: 14, minute: 30, snapshotsToKeep: 4 },
    enabled: true,
    hourlySchedule: { minute: 50, snapshotsToKeep: 2 },
    location: "eastus",
    monthlySchedule: {
      daysOfMonth: "10,11,12",
      hour: 14,
      minute: 15,
      snapshotsToKeep: 5,
    },
    weeklySchedule: {
      day: "Wednesday",
      hour: 14,
      minute: 45,
      snapshotsToKeep: 3,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.snapshotPolicies.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    snapshotPolicyName,
    body,
  );
  console.log(result);
}

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-03-01/examples/SnapshotPolicies_Update.json
// this example is just showing the usage of "SnapshotPolicies_Update" 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://video2.skills-academy.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 SnapshotPolicyResource created on azure
// for more information of creating SnapshotPolicyResource, please refer to the document of SnapshotPolicyResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
string resourceGroupName = "myRG";
string accountName = "account1";
string snapshotPolicyName = "snapshotPolicyName";
ResourceIdentifier snapshotPolicyResourceId = SnapshotPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, snapshotPolicyName);
SnapshotPolicyResource snapshotPolicy = client.GetSnapshotPolicyResource(snapshotPolicyResourceId);

// invoke the operation
SnapshotPolicyPatch patch = new SnapshotPolicyPatch(new AzureLocation("eastus"))
{
    HourlySchedule = new SnapshotPolicyHourlySchedule()
    {
        SnapshotsToKeep = 2,
        Minute = 50,
    },
    DailySchedule = new SnapshotPolicyDailySchedule()
    {
        SnapshotsToKeep = 4,
        Hour = 14,
        Minute = 30,
    },
    WeeklySchedule = new SnapshotPolicyWeeklySchedule()
    {
        SnapshotsToKeep = 3,
        Day = "Wednesday",
        Hour = 14,
        Minute = 45,
    },
    MonthlySchedule = new SnapshotPolicyMonthlySchedule()
    {
        SnapshotsToKeep = 5,
        DaysOfMonth = "10,11,12",
        Hour = 14,
        Minute = 15,
    },
    IsEnabled = true,
};
ArmOperation<SnapshotPolicyResource> lro = await snapshotPolicy.UpdateAsync(WaitUntil.Completed, patch);
SnapshotPolicyResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
  "name": "account1/snapshotPolicy1",
  "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
  "location": "eastus",
  "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"
  }
}

状態コード:: 202

Location: https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-03-01&operationResultResponseType=Location

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1",
  "name": "account1/snapshotPolicy1",
  "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
  "location": "eastus",
  "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	リソースを作成した ID の種類。
dailySchedule	日次スケジュールのプロパティ
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
hourlySchedule	時間単位のスケジュールプロパティ
monthlySchedule	月次スケジュールのプロパティ
snapshotPolicy	スナップショットポリシー情報
snapshotPolicyPatch	作成と更新のスナップショットポリシーの詳細
systemData	リソースの作成と最後の変更に関連するメタデータ。
weeklySchedule	Weekly Schedule プロパティ、特定の日または日に毎週スナップショットを作成する

createdByType

リソースを作成した ID の種類。

名前	型	説明
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	リソースサイズ (バイト単位)、ボリュームの現在のストレージ使用量 (バイト単位)

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 Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

snapshotPolicyPatch

作成と更新のスナップショットポリシーの詳細

名前	型	説明
id	string	リソース ID
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 毎週のスナップショットのスケジュール
tags	object	リソースタグ
type	string	リソースの種類

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

weeklySchedule

Weekly Schedule プロパティ、特定の日または日に毎週スナップショットを作成する

名前	型	説明
day	string	曜日スナップショットを作成する必要があることを示します。英語の曜日名のコンマ区切りリストを受け入れます。
hour	integer	スナップショットを取得する UTC タイムゾーンの時間を示します
minute	integer	作成する分単位のスナップショットを示します
snapshotsToKeep	integer	保持する週単位のスナップショット数
usedBytes	integer	リソースサイズ (バイト単位)、ボリュームの現在のストレージ使用量 (バイト単位)