Backups - Update

Tjänst:

Azure NetApp Files

API-version:

2025-01-01

Korrigera en säkerhetskopia under Säkerhetskopieringsvalvet

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}?api-version=2025-01-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	Namnet på NetApp-kontot
backupName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$	Namnet på säkerhetskopian
backupVaultName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	Namnet på Säkerhetskopieringsvalvet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.label	string	Etikett för säkerhetskopiering

Svar

Name	Typ	Description
200 OK	backup	OKEJ
202 Accepted	backup	Godkänd – Skapa eller uppdatera begäran accepterad; åtgärden slutförs asynkront Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BackupsUnderBackupVault_Update

Exempelbegäran

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1?api-version=2025-01-01

{}

Java

import com.azure.resourcemanager.netapp.models.Backup;

/**
 * Samples for Backups Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/BackupsUnderBackupVault_Update.
     * json
     */
    /**
     * Sample code: BackupsUnderBackupVault_Update.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void backupsUnderBackupVaultUpdate(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        Backup resource = manager.backups()
            .getWithResponse("myRG", "account1", "backupVault1", "backup1", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().apply();
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python backups_under_backup_vault_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.backups.begin_update(
        resource_group_name="myRG",
        account_name="account1",
        backup_vault_name="backupVault1",
        backup_name="backup1",
    ).result()
    print(response)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/BackupsUnderBackupVault_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

Go

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/27046dbff974e3901970aa53b29cec6d8ec1342a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/BackupsUnderBackupVault_Update.json
func ExampleBackupsClient_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.NewBackupsClient().BeginUpdate(ctx, "myRG", "account1", "backupVault1", "backup1", armnetapp.BackupPatch{}, 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.Backup = armnetapp.Backup{
	// 	Name: to.Ptr("account1/backupVault1/backup1"),
	// 	Type: to.Ptr("Microsoft.NetApp/netAppAccounts/backupVaults/backups"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1"),
	// 	Properties: &armnetapp.BackupProperties{
	// 		BackupType: to.Ptr(armnetapp.BackupTypeManual),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-15T13:23:33.000Z"); return t}()),
	// 		Label: to.Ptr("myLabel"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Size: to.Ptr[int64](10011),
	// 		SnapshotName: to.Ptr("backup1"),
	// 		VolumeResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Patch a Backup under the Backup Vault
 *
 * @summary Patch a Backup under the Backup Vault
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/BackupsUnderBackupVault_Update.json
 */
async function backupsUnderBackupVaultUpdate() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const backupVaultName = "backupVault1";
  const backupName = "backup1";
  const body = {};
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.backups.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    backupVaultName,
    backupName,
    options,
  );
  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

dotnet

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/2025-01-01/examples/BackupsUnderBackupVault_Update.json
// this example is just showing the usage of "Backups_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://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 NetAppBackupVaultBackupResource created on azure
// for more information of creating NetAppBackupVaultBackupResource, please refer to the document of NetAppBackupVaultBackupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string backupVaultName = "backupVault1";
string backupName = "backup1";
ResourceIdentifier netAppBackupVaultBackupResourceId = NetAppBackupVaultBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, backupVaultName, backupName);
NetAppBackupVaultBackupResource netAppBackupVaultBackup = client.GetNetAppBackupVaultBackupResource(netAppBackupVaultBackupResourceId);

// invoke the operation
NetAppBackupVaultBackupPatch patch = new NetAppBackupVaultBackupPatch();
ArmOperation<NetAppBackupVaultBackupResource> lro = await netAppBackupVaultBackup.UpdateAsync(WaitUntil.Completed, patch);
NetAppBackupVaultBackupResource 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
NetAppBackupData 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

Exempelsvar

Statuskod:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1",
  "name": "account1/backupVault1/backup1",
  "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups",
  "properties": {
    "creationDate": "2017-08-15T13:23:33Z",
    "provisioningState": "Succeeded",
    "size": 10011,
    "label": "myLabel",
    "backupType": "Manual",
    "snapshotName": "backup1",
    "volumeResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1"
  }
}

Statuskod:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2025-01-01&operationResultResponseType=Location
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2025-01-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1",
  "name": "account1/backupVault1/backup1",
  "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups",
  "properties": {
    "creationDate": "2017-08-15T13:23:33Z",
    "provisioningState": "Succeeded",
    "size": 10011,
    "label": "myLabel",
    "backupType": "Manual",
    "snapshotName": "backup1",
    "volumeResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1"
  }
}

Definitioner

Name	Description
backup	Säkerhetskopiera under ett säkerhetskopieringsvalv
backupPatch	Säkerhetskopieringskorrigering
backupType	backupType
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.

backup

Objekt

Säkerhetskopiera under ett säkerhetskopieringsvalv

Name	Typ	Standardvärde	Description
id	string (arm-id)		Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Namnet på resursen
properties.backupId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		backupId UUID v4 som används för att identifiera säkerhetskopieringen
properties.backupPolicyResourceId	string (arm-id)		ResourceId som används för att identifiera säkerhetskopieringsprincipen
properties.backupType	backupType		backupType Typ av manuell eller schemalagd säkerhetskopiering
properties.completionDate	string (date-time)		completionDate Slutförandedatumet för säkerhetskopieringen
properties.creationDate	string (date-time)		skapelsedatum Datumet då säkerhetskopieringen skapades
properties.failureReason	string		Orsak till fel
properties.isLargeVolume	boolean		Anger om säkerhetskopieringen gäller för en stor volym.
properties.label	string		Etikett för säkerhetskopiering
properties.provisioningState	string		Livscykelhantering i Azure
properties.size	integer (int64)		Storleken på säkerhetskopiering i byte
properties.snapshotCreationDate	string (date-time)		snapshotCreationDate Datumet då ögonblicksbilden skapades för säkerhetskopieringen
properties.snapshotName	string		Namnet på ögonblicksbilden
properties.useExistingSnapshot	boolean	False	Manuell säkerhetskopiering av en redan befintlig ögonblicksbild. Detta är alltid falskt för schemalagda säkerhetskopieringar och sant/falskt för manuella säkerhetskopieringar
properties.volumeResourceId	string (arm-id)		ResourceId som används för att identifiera volymen
systemData	systemData		Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

backupPatch

Objekt

Säkerhetskopieringskorrigering

Name	Typ	Description
properties.label	string	Etikett för säkerhetskopiering

backupType

Uppräkning

backupType

Värde	Description
Manual	Manuell säkerhetskopiering
Scheduled	Schemalagd säkerhetskopiering

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.