Blob Containers - Extend Immutability Policy

Layanan:

Storage Resource Provider

Versi API:

2024-01-01

Memperluas immutabilityPeriodSinceCreationInDays dari immutabilityPolicy yang terkunci. Satu-satunya tindakan yang diizinkan pada kebijakan Terkunci adalah tindakan ini. ETag dalam If-Match diperlukan untuk operasi ini.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend?api-version=2024-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Nama akun penyimpanan dalam grup sumber daya yang ditentukan. Panjang nama akun penyimpanan harus antara 3 dan 24 karakter dan hanya menggunakan angka dan huruf kecil.
containerName	path	True	string minLength: 3 maxLength: 63	Nama kontainer blob dalam akun penyimpanan yang ditentukan. Panjang nama kontainer blob harus antara 3 dan 63 karakter dan menggunakan angka, huruf kecil dan tanda hubung (-) saja. Setiap karakter tanda hubung (-) harus segera didahului dan diikuti dengan huruf atau angka.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nama grup sumber daya dalam langganan pengguna. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match	True	string	Versi status entitas (ETag) dari kebijakan kekekalan yang akan diperbarui harus dikembalikan ke server untuk semua operasi pembaruan. Nilai ETag harus menyertakan tanda kutip ganda di depan dan berikutnya seperti yang dikembalikan oleh layanan.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.allowProtectedAppendWrites	boolean	Properti ini hanya dapat diubah untuk kebijakan penyimpanan berbasis waktu yang tidak terkunci. Saat diaktifkan, blok baru dapat ditulis ke blob penambahan sambil mempertahankan perlindungan dan kepatuhan imutabilitas. Hanya blok baru yang dapat ditambahkan dan blok yang ada tidak dapat dimodifikasi atau dihapus. Properti ini tidak dapat diubah dengan ExtendImmutabilityPolicy API.
properties.allowProtectedAppendWritesAll	boolean	Properti ini hanya dapat diubah untuk kebijakan penyimpanan berbasis waktu yang tidak terkunci. Saat diaktifkan, blok baru dapat ditulis ke 'Tambahkan dan Bock Blob' sambil mempertahankan perlindungan dan kepatuhan imutabilitas. Hanya blok baru yang dapat ditambahkan dan blok yang ada tidak dapat dimodifikasi atau dihapus. Properti ini tidak dapat diubah dengan ExtendImmutabilityPolicy API. Properti 'allowProtectedAppendWrites' dan 'allowProtectedAppendWritesAll' saling eksklusif.
properties.immutabilityPeriodSinceCreationInDays	integer	Periode imutabilitas untuk blob dalam kontainer sejak pembuatan kebijakan, dalam beberapa hari.

Respons

Nama	Jenis	Deskripsi
200 OK	ImmutabilityPolicy	OK -- Memperluas operasi ImmutabilityPolicy kontainer berhasil diselesaikan.. Header ETag: string

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ExtendImmutabilityPolicy

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default/extend?api-version=2024-01-01


{
  "properties": {
    "immutabilityPeriodSinceCreationInDays": 100
  }
}

Java

import com.azure.resourcemanager.storage.fluent.models.ImmutabilityPolicyInner;

/**
 * Samples for BlobContainers ExtendImmutabilityPolicy.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/
     * BlobContainersExtendImmutabilityPolicy.json
     */
    /**
     * Sample code: ExtendImmutabilityPolicy.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void extendImmutabilityPolicy(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobContainers().extendImmutabilityPolicyWithResponse(
            "res6238", "sto232", "container5023", "8d59f830d0c3bf9",
            new ImmutabilityPolicyInner().withImmutabilityPeriodSinceCreationInDays(100),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python blob_containers_extend_immutability_policy.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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.blob_containers.extend_immutability_policy(
        resource_group_name="res6238",
        account_name="sto232",
        container_name="container5023",
        if_match="8d59f830d0c3bf9",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersExtendImmutabilityPolicy.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/86c6306649b02e542117adb46c61e8019dbd78e9/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersExtendImmutabilityPolicy.json
func ExampleBlobContainersClient_ExtendImmutabilityPolicy() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBlobContainersClient().ExtendImmutabilityPolicy(ctx, "res6238", "sto232", "container5023", "8d59f830d0c3bf9", &armstorage.BlobContainersClientExtendImmutabilityPolicyOptions{Parameters: &armstorage.ImmutabilityPolicy{
		Properties: &armstorage.ImmutabilityPolicyProperty{
			ImmutabilityPeriodSinceCreationInDays: to.Ptr[int32](100),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.ImmutabilityPolicy = armstorage.ImmutabilityPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default"),
	// 	Etag: to.Ptr("\"8d57a8b2ff50332\""),
	// 	Properties: &armstorage.ImmutabilityPolicyProperty{
	// 		ImmutabilityPeriodSinceCreationInDays: to.Ptr[int32](100),
	// 		State: to.Ptr(armstorage.ImmutabilityPolicyStateLocked),
	// 	},
	// }
}

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 { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.
 *
 * @summary Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersExtendImmutabilityPolicy.json
 */
async function extendImmutabilityPolicy() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6238";
  const accountName = "sto232";
  const containerName = "container5023";
  const ifMatch = "8d59f830d0c3bf9";
  const parameters = {
    immutabilityPeriodSinceCreationInDays: 100,
  };
  const options = {
    parameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.blobContainers.extendImmutabilityPolicy(
    resourceGroupName,
    accountName,
    containerName,
    ifMatch,
    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.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersExtendImmutabilityPolicy.json
// this example is just showing the usage of "BlobContainers_ExtendImmutabilityPolicy" 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 ImmutabilityPolicyResource created on azure
// for more information of creating ImmutabilityPolicyResource, please refer to the document of ImmutabilityPolicyResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res6238";
string accountName = "sto232";
string containerName = "container5023";
ResourceIdentifier immutabilityPolicyResourceId = ImmutabilityPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, containerName);
ImmutabilityPolicyResource immutabilityPolicy = client.GetImmutabilityPolicyResource(immutabilityPolicyResourceId);

// invoke the operation
ETag ifMatch = new ETag("8d59f830d0c3bf9");
ImmutabilityPolicyData data = new ImmutabilityPolicyData
{
    ImmutabilityPeriodSinceCreationInDays = 100,
};
ImmutabilityPolicyResource result = await immutabilityPolicy.ExtendImmutabilityPolicyAsync(ifMatch, data: data);

// 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
ImmutabilityPolicyData 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

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies",
  "etag": "\"8d57a8b2ff50332\"",
  "properties": {
    "immutabilityPeriodSinceCreationInDays": 100,
    "state": "Locked"
  }
}

Definisi

Nama	Deskripsi
ImmutabilityPolicy	Properti ImmutabilityPolicy dari kontainer blob, termasuk Id, nama sumber daya, jenis sumber daya, Etag.
ImmutabilityPolicyState	Status ImmutabilityPolicy dari kontainer blob, nilai yang mungkin meliputi: Terkunci dan Tidak Terkunci.

ImmutabilityPolicy

Objek

Properti ImmutabilityPolicy dari kontainer blob, termasuk Id, nama sumber daya, jenis sumber daya, Etag.

Nama	Jenis	Deskripsi
etag	string	Sumber daya Etag.
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.allowProtectedAppendWrites	boolean	Properti ini hanya dapat diubah untuk kebijakan penyimpanan berbasis waktu yang tidak terkunci. Saat diaktifkan, blok baru dapat ditulis ke blob penambahan sambil mempertahankan perlindungan dan kepatuhan imutabilitas. Hanya blok baru yang dapat ditambahkan dan blok yang ada tidak dapat dimodifikasi atau dihapus. Properti ini tidak dapat diubah dengan ExtendImmutabilityPolicy API.
properties.allowProtectedAppendWritesAll	boolean	Properti ini hanya dapat diubah untuk kebijakan penyimpanan berbasis waktu yang tidak terkunci. Saat diaktifkan, blok baru dapat ditulis ke 'Tambahkan dan Bock Blob' sambil mempertahankan perlindungan dan kepatuhan imutabilitas. Hanya blok baru yang dapat ditambahkan dan blok yang ada tidak dapat dimodifikasi atau dihapus. Properti ini tidak dapat diubah dengan ExtendImmutabilityPolicy API. Properti 'allowProtectedAppendWrites' dan 'allowProtectedAppendWritesAll' saling eksklusif.
properties.immutabilityPeriodSinceCreationInDays	integer	Periode imutabilitas untuk blob dalam kontainer sejak pembuatan kebijakan, dalam beberapa hari.
properties.state	ImmutabilityPolicyState	Status ImmutabilityPolicy dari kontainer blob, nilai yang mungkin meliputi: Terkunci dan Tidak Terkunci.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ImmutabilityPolicyState

Enumeration

Status ImmutabilityPolicy dari kontainer blob, nilai yang mungkin meliputi: Terkunci dan Tidak Terkunci.

Nilai	Deskripsi
Locked
Unlocked