Blob Containers - Update

サービス:

Storage Resource Provider

API バージョン:

2024-01-01

要求本文で指定されたコンテナーのプロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。
containerName	path	True	string minLength: 3 maxLength: 63	指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字の直前に文字または数字を付ける必要があります。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	ユーザーのサブスクリプション内のリソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.defaultEncryptionScope	string	既定では、すべての書き込みに指定された暗号化スコープを使用するコンテナーです。
properties.denyEncryptionScopeOverride	boolean	コンテナーの既定値からの暗号化スコープのオーバーライドをブロックします。
properties.enableNfsV3AllSquash	boolean	BLOB コンテナーで NFSv3 のすべてのスカッシュを有効にします。
properties.enableNfsV3RootSquash	boolean	BLOB コンテナーで NFSv3 ルート スカッシュを有効にします。
properties.immutableStorageWithVersioning	ImmutableStorageWithVersioning	コンテナーのオブジェクト レベルの不変プロパティ。 プロパティは不変であり、コンテナー作成時にのみ true に設定できます。 既存のコンテナーは、移行プロセスを受ける必要があります。
properties.metadata	object	メタデータとしてコンテナーに関連付ける名前と値のペア。
properties.publicAccess	PublicAccess	コンテナー内のデータにパブリックにアクセスできるかどうかを指定し、アクセスレベルを指定します。

応答

名前	型	説明
200 OK	BlobContainer	OK -- コンテナーの更新操作が正常に完了しました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

UpdateContainers

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185?api-version=2024-01-01

{
  "properties": {
    "publicAccess": "Container",
    "metadata": {
      "metadata": "true"
    }
  }
}

Java

import com.azure.resourcemanager.storage.fluent.models.BlobContainerInner;
import com.azure.resourcemanager.storage.models.PublicAccess;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BlobContainers Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersPatch.json
     */
    /**
     * Sample code: UpdateContainers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateContainers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobContainers()
            .updateWithResponse("res3376", "sto328", "container6185", new BlobContainerInner()
                .withPublicAccess(PublicAccess.CONTAINER).withMetadata(mapOf("metadata", "true")),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_patch.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.update(
        resource_group_name="res3376",
        account_name="sto328",
        container_name="container6185",
        blob_container={"properties": {"metadata": {"metadata": "true"}, "publicAccess": "Container"}},
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersPatch.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/BlobContainersPatch.json
func ExampleBlobContainersClient_Update() {
	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().Update(ctx, "res3376", "sto328", "container6185", armstorage.BlobContainer{
		ContainerProperties: &armstorage.ContainerProperties{
			Metadata: map[string]*string{
				"metadata": to.Ptr("true"),
			},
			PublicAccess: to.Ptr(armstorage.PublicAccessContainer),
		},
	}, nil)
	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.BlobContainer = armstorage.BlobContainer{
	// 	Name: to.Ptr("container6185"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185"),
	// 	ContainerProperties: &armstorage.ContainerProperties{
	// 		HasImmutabilityPolicy: to.Ptr(false),
	// 		HasLegalHold: to.Ptr(false),
	// 		Metadata: map[string]*string{
	// 			"metadata": to.Ptr("true"),
	// 		},
	// 		PublicAccess: to.Ptr(armstorage.PublicAccessContainer),
	// 	},
	// }
}

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 Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist.
 *
 * @summary Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersPatch.json
 */
async function updateContainers() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res3376";
  const accountName = "sto328";
  const containerName = "container6185";
  const blobContainer = {
    metadata: { metadata: "true" },
    publicAccess: "Container",
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.blobContainers.update(
    resourceGroupName,
    accountName,
    containerName,
    blobContainer,
  );
  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.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersPatch.json
// this example is just showing the usage of "BlobContainers_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 BlobContainerResource created on azure
// for more information of creating BlobContainerResource, please refer to the document of BlobContainerResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res3376";
string accountName = "sto328";
string containerName = "container6185";
ResourceIdentifier blobContainerResourceId = BlobContainerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, containerName);
BlobContainerResource blobContainer = client.GetBlobContainerResource(blobContainerResourceId);

// invoke the operation
BlobContainerData data = new BlobContainerData
{
    PublicAccess = StoragePublicAccessType.Container,
    Metadata =
    {
    ["metadata"] = "true"
    },
};
BlobContainerResource result = await blobContainer.UpdateAsync(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
BlobContainerData 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/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
  "name": "container6185",
  "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
  "properties": {
    "metadata": {
      "metadata": "true"
    },
    "publicAccess": "Container",
    "hasImmutabilityPolicy": false,
    "hasLegalHold": false
  }
}

定義

名前	説明
BlobContainer	ID、リソース名、リソースの種類、Etag など、BLOB コンテナーのプロパティ。
ImmutabilityPolicyProperties	BLOB コンテナーの ImmutabilityPolicy のプロパティ。
ImmutabilityPolicyState	BLOB コンテナーの ImmutabilityPolicy 状態。使用可能な値は、Locked と Unlocked です。
ImmutabilityPolicyUpdateType	BLOB コンテナーの ImmutabilityPolicy 更新の種類。使用可能な値は、put、lock、extend です。
ImmutableStorageWithVersioning	コンテナーのオブジェクト レベルの不変プロパティ。
LeaseDuration	コンテナーがリースされている場合にのみ、コンテナーのリース期間が無限か固定期間かを指定します。
LeaseState	コンテナーのリース状態。
LeaseStatus	コンテナーのリース状態。
LegalHoldProperties	BLOB コンテナーの LegalHold プロパティ。
MigrationState	このプロパティは、オブジェクト レベルの不変性移行状態に対するコンテナー レベルの不変性を表します。
ProtectedAppendWritesHistory	保護された追加は、訴訟ホールドを使用して BLOB コンテナーの履歴設定を書き込みます。
PublicAccess	コンテナー内のデータにパブリックにアクセスできるかどうかを指定し、アクセスレベルを指定します。
TagProperty	BLOB コンテナーの LegalHold のタグ。
UpdateHistoryProperty	BLOB コンテナーの ImmutabilityPolicy の更新履歴。

BlobContainer

Object

ID、リソース名、リソースの種類、Etag など、BLOB コンテナーのプロパティ。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.defaultEncryptionScope	string	既定では、すべての書き込みに指定された暗号化スコープを使用するコンテナーです。
properties.deleted	boolean	BLOB コンテナーが削除されたかどうかを示します。
properties.deletedTime	string (date-time)	BLOB コンテナーの削除時間。
properties.denyEncryptionScopeOverride	boolean	コンテナーの既定値からの暗号化スコープのオーバーライドをブロックします。
properties.enableNfsV3AllSquash	boolean	BLOB コンテナーで NFSv3 のすべてのスカッシュを有効にします。
properties.enableNfsV3RootSquash	boolean	BLOB コンテナーで NFSv3 ルート スカッシュを有効にします。
properties.hasImmutabilityPolicy	boolean	このコンテナーに対して ImmutabilityPolicy が作成されている場合、hasImmutabilityPolicy パブリック プロパティは SRP によって true に設定されます。 このコンテナーに対して ImmutabilityPolicy が作成されていない場合、hasImmutabilityPolicy パブリック プロパティは SRP によって false に設定されます。
properties.hasLegalHold	boolean	少なくとも 1 つの既存のタグがある場合、hasLegalHold パブリック プロパティは SRP によって true に設定されます。 既存のすべての訴訟ホールド タグがクリアされた場合、hasLegalHold パブリック プロパティは SRP によって false に設定されます。特定のアカウントに対して hasLegalHold=true を持つ BLOB コンテナーは最大 1,000 個まで存在できます。
properties.immutabilityPolicy	ImmutabilityPolicyProperties	コンテナーの ImmutabilityPolicy プロパティ。
properties.immutableStorageWithVersioning	ImmutableStorageWithVersioning	コンテナーのオブジェクト レベルの不変プロパティ。 プロパティは不変であり、コンテナー作成時にのみ true に設定できます。 既存のコンテナーは、移行プロセスを受ける必要があります。
properties.lastModifiedTime	string (date-time)	コンテナーが最後に変更された日時を返します。
properties.leaseDuration	LeaseDuration	コンテナーがリースされている場合にのみ、コンテナーのリース期間が無限か固定期間かを指定します。
properties.leaseState	LeaseState	コンテナーのリース状態。
properties.leaseStatus	LeaseStatus	コンテナーのリース状態。
properties.legalHold	LegalHoldProperties	コンテナーの LegalHold プロパティ。
properties.metadata	object	メタデータとしてコンテナーに関連付ける名前と値のペア。
properties.publicAccess	PublicAccess	コンテナー内のデータにパブリックにアクセスできるかどうかを指定し、アクセスレベルを指定します。
properties.remainingRetentionDays	integer	論理的に削除された BLOB コンテナーの残りの保持日数。
properties.version	string	削除された BLOB コンテナーのバージョン。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ImmutabilityPolicyProperties

Object

BLOB コンテナーの ImmutabilityPolicy のプロパティ。

名前	型	説明
etag	string	ImmutabilityPolicy Etag。
properties.allowProtectedAppendWrites	boolean	このプロパティは、ロック解除された時間ベースのアイテム保持ポリシーに対してのみ変更できます。 有効にすると、不変性の保護とコンプライアンスを維持しながら、新しいブロックを追加 BLOB に書き込むことができます。 新しいブロックのみを追加でき、既存のブロックは変更または削除できません。 ExtendImmutabilityPolicy API では、このプロパティを変更できません。
properties.allowProtectedAppendWritesAll	boolean	このプロパティは、ロック解除された時間ベースのアイテム保持ポリシーに対してのみ変更できます。 有効にすると、不変性の保護とコンプライアンスを維持しながら、新しいブロックを 'Append BLOB と Bock BLOB' の両方に書き込むことができます。 新しいブロックのみを追加でき、既存のブロックは変更または削除できません。 ExtendImmutabilityPolicy API では、このプロパティを変更できません。 'allowProtectedAppendWrites' プロパティと 'allowProtectedAppendWritesAll' プロパティは相互に排他的です。
properties.immutabilityPeriodSinceCreationInDays	integer	ポリシーの作成以降のコンテナー内の BLOB の不変期間 (日数)。
properties.state	ImmutabilityPolicyState	BLOB コンテナーの ImmutabilityPolicy 状態。使用可能な値は、Locked と Unlocked です。
updateHistory	UpdateHistoryProperty[]	BLOB コンテナーの ImmutabilityPolicy 更新履歴。

ImmutabilityPolicyState

列挙

BLOB コンテナーの ImmutabilityPolicy 状態。使用可能な値は、Locked と Unlocked です。

値	説明
Locked
Unlocked

ImmutabilityPolicyUpdateType

列挙

BLOB コンテナーの ImmutabilityPolicy 更新の種類。使用可能な値は、put、lock、extend です。

値	説明
put
lock
extend

ImmutableStorageWithVersioning

Object

コンテナーのオブジェクト レベルの不変プロパティ。

名前	型	説明
enabled	boolean	これは不変プロパティです。true に設定すると、コンテナー レベルでオブジェクト レベルの不変性が有効になります。
migrationState	MigrationState	このプロパティは、オブジェクト レベルの不変性移行状態に対するコンテナー レベルの不変性を表します。
timeStamp	string (date-time)	オブジェクト レベルの不変性が有効だった日付と時刻を返します。

LeaseDuration

列挙

コンテナーがリースされている場合にのみ、コンテナーのリース期間が無限か固定期間かを指定します。

値	説明
Infinite
Fixed

LeaseState

列挙

コンテナーのリース状態。

値	説明
Available
Leased
Expired
Breaking
Broken

LeaseStatus

列挙

コンテナーのリース状態。

値	説明
Locked
Unlocked

LegalHoldProperties

Object

BLOB コンテナーの LegalHold プロパティ。

名前	型	説明
hasLegalHold	boolean	少なくとも 1 つの既存のタグがある場合、hasLegalHold パブリック プロパティは SRP によって true に設定されます。 既存のすべての訴訟ホールド タグがクリアされた場合、hasLegalHold パブリック プロパティは SRP によって false に設定されます。特定のアカウントに対して hasLegalHold=true を持つ BLOB コンテナーは最大 1,000 個まで存在できます。
protectedAppendWritesHistory	ProtectedAppendWritesHistory	保護された追加 BLOB の書き込み履歴。
tags	TagProperty[]	BLOB コンテナーの LegalHold タグの一覧。

MigrationState

列挙

このプロパティは、オブジェクト レベルの不変性移行状態に対するコンテナー レベルの不変性を表します。

値	説明
InProgress
Completed

ProtectedAppendWritesHistory

Object

保護された追加は、訴訟ホールドを使用して BLOB コンテナーの履歴設定を書き込みます。

名前	型	説明
allowProtectedAppendWritesAll	boolean	有効にすると、訴訟ホールドの保護とコンプライアンスを維持しながら、新しいブロックを "追加 BLOB と Bock BLOB" の両方に書き込むことができます。 新しいブロックのみを追加でき、既存のブロックは変更または削除できません。
timestamp	string (date-time)	タグが追加された日時を返します。

PublicAccess

列挙

コンテナー内のデータにパブリックにアクセスできるかどうかを指定し、アクセスレベルを指定します。

値	説明
Container
Blob
None

TagProperty

Object

BLOB コンテナーの LegalHold のタグ。

名前	型	説明
objectIdentifier	string	タグを追加したユーザーのオブジェクト ID を返します。
tag	string	タグ値。
tenantId	string	タグを追加したユーザーのトークンを発行したテナント ID を返します。
timestamp	string (date-time)	タグが追加された日時を返します。
upn	string	タグを追加したユーザーのユーザー プリンシパル名を返します。

UpdateHistoryProperty

Object

BLOB コンテナーの ImmutabilityPolicy の更新履歴。

名前	型	説明
allowProtectedAppendWrites	boolean	このプロパティは、ロック解除された時間ベースのアイテム保持ポリシーに対してのみ変更できます。 有効にすると、不変性の保護とコンプライアンスを維持しながら、新しいブロックを追加 BLOB に書き込むことができます。 新しいブロックのみを追加でき、既存のブロックは変更または削除できません。 ExtendImmutabilityPolicy API では、このプロパティを変更できません。
allowProtectedAppendWritesAll	boolean	このプロパティは、ロック解除された時間ベースのアイテム保持ポリシーに対してのみ変更できます。 有効にすると、不変性の保護とコンプライアンスを維持しながら、新しいブロックを 'Append BLOB と Bock BLOB' の両方に書き込むことができます。 新しいブロックのみを追加でき、既存のブロックは変更または削除できません。 ExtendImmutabilityPolicy API では、このプロパティを変更できません。 'allowProtectedAppendWrites' プロパティと 'allowProtectedAppendWritesAll' プロパティは相互に排他的です。
immutabilityPeriodSinceCreationInDays	integer	ポリシーの作成以降のコンテナー内の BLOB の不変期間 (日数)。
objectIdentifier	string	ImmutabilityPolicy を更新したユーザーのオブジェクト ID を返します。
tenantId	string	ImmutabilityPolicy を更新したユーザーのトークンを発行したテナント ID を返します。
timestamp	string (date-time)	ImmutabilityPolicy が更新された日時を返します。
update	ImmutabilityPolicyUpdateType	BLOB コンテナーの ImmutabilityPolicy 更新の種類。使用可能な値は、put、lock、extend です。
upn	string	ImmutabilityPolicy を更新したユーザーのユーザー プリンシパル名を返します。