Blob Containers - Update

Service:

Storage Resource Provider

API Version:

2023-01-01

Atualizações propriedades de contêiner conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o contêiner especificado ainda não existir.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Regex pattern: ^[a-z0-9]+$
containerName	path	True	string	O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.defaultEncryptionScope	string	Padrão, o contêiner usará o escopo de criptografia especificado para todas as gravações.
properties.denyEncryptionScopeOverride	boolean	Bloquear a substituição do escopo de criptografia do padrão do contêiner.
properties.enableNfsV3AllSquash	boolean	Habilite o NFSv3 todos os combinação por squash no contêiner de blob.
properties.enableNfsV3RootSquash	boolean	Habilite o combinação por squash raiz NFSv3 no contêiner de blob.
properties.immutableStorageWithVersioning	ImmutableStorageWithVersioning	A propriedade de imutabilidade no nível do objeto do contêiner. A propriedade é imutável e só pode ser definida como true no momento da criação do contêiner. Os contêineres existentes devem passar por um processo de migração.
properties.metadata	object	Um par de nome-valor a ser associado ao contêiner como metadados.
properties.publicAccess	PublicAccess	Especifica se os dados no contêiner podem ser acessados publicamente e o nível de acesso.

Respostas

Nome	Tipo	Description
200 OK	BlobContainer	OK – Operação de atualização do contêiner concluída com êxito.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

UpdateContainers

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185?api-version=2023-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/2023-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/2023-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/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-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");

/**
 * 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/2023-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

Sample Response

Status code:

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
  }
}

Definições

Nome	Description
BlobContainer	Propriedades do contêiner de blob, incluindo ID, nome do recurso, tipo de recurso, Etag.
ImmutabilityPolicyProperties	As propriedades de um ImmutabilityPolicy de um contêiner de blob.
ImmutabilityPolicyState	O estado ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: Bloqueado e Desbloqueado.
ImmutabilityPolicyUpdateType	O tipo de atualização ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: put, lock e extend.
ImmutableStorageWithVersioning	Propriedades de imutabilidade no nível do objeto do contêiner.
LeaseDuration	Especifica se a concessão em um contêiner é de duração infinita ou fixa, somente quando o contêiner é concedido.
LeaseState	Estado da concessão do contêiner.
LeaseStatus	O status da concessão do contêiner.
LegalHoldProperties	A propriedade LegalHold de um contêiner de blob.
MigrationState	Essa propriedade indica a imutabilidade no nível do contêiner para o estado de migração de imutabilidade no nível do objeto.
ProtectedAppendWritesHistory	Configuração de histórico de gravações de acréscimo protegido para o contêiner de blob com retenções legais.
PublicAccess	Especifica se os dados no contêiner podem ser acessados publicamente e o nível de acesso.
TagProperty	Uma marca do LegalHold de um contêiner de blob.
UpdateHistoryProperty	Um histórico de atualizações da ImmutabilityPolicy de um contêiner de blob.

BlobContainer

Propriedades do contêiner de blob, incluindo ID, nome do recurso, tipo de recurso, Etag.

Nome	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.defaultEncryptionScope	string	Padrão, o contêiner usará o escopo de criptografia especificado para todas as gravações.
properties.deleted	boolean	Indica se o contêiner de blob foi excluído.
properties.deletedTime	string	Tempo de exclusão do contêiner de blob.
properties.denyEncryptionScopeOverride	boolean	Bloquear a substituição do escopo de criptografia do padrão do contêiner.
properties.enableNfsV3AllSquash	boolean	Habilite o NFSv3 todos os combinação por squash no contêiner de blob.
properties.enableNfsV3RootSquash	boolean	Habilite o combinação por squash raiz NFSv3 no contêiner de blob.
properties.hasImmutabilityPolicy	boolean	A propriedade pública hasImmutabilityPolicy será definida como true pelo SRP se ImmutabilityPolicy tiver sido criado para esse contêiner. A propriedade pública hasImmutabilityPolicy será definida como false pelo SRP se ImmutabilityPolicy não tiver sido criada para esse contêiner.
properties.hasLegalHold	boolean	A propriedade pública hasLegalHold será definida como true pelo SRP se houver pelo menos uma marca existente. A propriedade pública hasLegalHold será definida como false pelo SRP se todas as marcas de retenção legal existentes forem desmarcadas. Pode haver no máximo 1000 contêineres de blob com hasLegalHold=true para uma determinada conta.
properties.immutabilityPolicy	ImmutabilityPolicyProperties	A propriedade ImmutabilityPolicy do contêiner.
properties.immutableStorageWithVersioning	ImmutableStorageWithVersioning	A propriedade de imutabilidade no nível do objeto do contêiner. A propriedade é imutável e só pode ser definida como true no momento da criação do contêiner. Os contêineres existentes devem passar por um processo de migração.
properties.lastModifiedTime	string	Retorna a data e a hora em que o contêiner foi modificado pela última vez.
properties.leaseDuration	LeaseDuration	Especifica se a concessão em um contêiner é de duração infinita ou fixa, somente quando o contêiner é concedido.
properties.leaseState	LeaseState	Estado da concessão do contêiner.
properties.leaseStatus	LeaseStatus	O status da concessão do contêiner.
properties.legalHold	LegalHoldProperties	A propriedade LegalHold do contêiner.
properties.metadata	object	Um par de nome-valor a ser associado ao contêiner como metadados.
properties.publicAccess	PublicAccess	Especifica se os dados no contêiner podem ser acessados publicamente e o nível de acesso.
properties.remainingRetentionDays	integer	Dias de retenção restantes para o contêiner de blob com exclusão reversível.
properties.version	string	A versão do contêiner de blob excluído.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ImmutabilityPolicyProperties

As propriedades de um ImmutabilityPolicy de um contêiner de blob.

Nome	Tipo	Description
etag	string	Etag ImmutabilityPolicy.
properties.allowProtectedAppendWrites	boolean	Essa propriedade só pode ser alterada para políticas de retenção baseadas em tempo desbloqueadas. Quando habilitados, novos blocos podem ser gravados em um blob de acréscimo, mantendo a proteção e a conformidade da imutabilidade. Somente novos blocos podem ser adicionados e os blocos existentes não podem ser modificados ou excluídos. Essa propriedade não pode ser alterada com a API ExtendImmutabilityPolicy.
properties.allowProtectedAppendWritesAll	boolean	Essa propriedade só pode ser alterada para políticas de retenção baseadas em tempo desbloqueadas. Quando habilitados, novos blocos podem ser gravados em 'Blobs de Acréscimo e Bock' mantendo a proteção e a conformidade da imutabilidade. Somente novos blocos podem ser adicionados e os blocos existentes não podem ser modificados ou excluídos. Essa propriedade não pode ser alterada com a API ExtendImmutabilityPolicy. As propriedades 'allowProtectedAppendWrites' e 'allowProtectedAppendWritesAll' são mutuamente exclusivas.
properties.immutabilityPeriodSinceCreationInDays	integer	O período de imutabilidade para os blobs no contêiner desde a criação da política, em dias.
properties.state	ImmutabilityPolicyState	O estado ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: Bloqueado e Desbloqueado.
updateHistory	UpdateHistoryProperty[]	O histórico de atualização ImmutabilityPolicy do contêiner de blob.

ImmutabilityPolicyState

O estado ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: Bloqueado e Desbloqueado.

Nome	Tipo	Description
Locked	string
Unlocked	string

ImmutabilityPolicyUpdateType

O tipo de atualização ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: put, lock e extend.

Nome	Tipo	Description
extend	string
lock	string
put	string

ImmutableStorageWithVersioning

Propriedades de imutabilidade no nível do objeto do contêiner.

Nome	Tipo	Description
enabled	boolean	Essa é uma propriedade imutável, quando definida como true, permite a imutabilidade no nível do objeto no nível do contêiner.
migrationState	MigrationState	Essa propriedade indica a imutabilidade no nível do contêiner para o estado de migração de imutabilidade no nível do objeto.
timeStamp	string	Retorna a data e a hora em que a imutabilidade no nível do objeto foi habilitada.

LeaseDuration

Especifica se a concessão em um contêiner é de duração infinita ou fixa, somente quando o contêiner é concedido.

Nome	Tipo	Description
Fixed	string
Infinite	string

LeaseState

Estado da concessão do contêiner.

Nome	Tipo	Description
Available	string
Breaking	string
Broken	string
Expired	string
Leased	string

LeaseStatus

O status da concessão do contêiner.

Nome	Tipo	Description
Locked	string
Unlocked	string

LegalHoldProperties

A propriedade LegalHold de um contêiner de blob.

Nome	Tipo	Description
hasLegalHold	boolean	A propriedade pública hasLegalHold será definida como true pelo SRP se houver pelo menos uma marca existente. A propriedade pública hasLegalHold será definida como false pelo SRP se todas as marcas de retenção legal existentes forem desmarcadas. Pode haver no máximo 1000 contêineres de blob com hasLegalHold=true para uma determinada conta.
protectedAppendWritesHistory	ProtectedAppendWritesHistory	Histórico de gravações de blob de acréscimo protegido.
tags	TagProperty[]	A lista de marcas legalhold de um contêiner de blob.

MigrationState

Essa propriedade indica a imutabilidade no nível do contêiner para o estado de migração de imutabilidade no nível do objeto.

Nome	Tipo	Description
Completed	string
InProgress	string

ProtectedAppendWritesHistory

Configuração de histórico de gravações de acréscimo protegido para o contêiner de blob com retenções legais.

Nome	Tipo	Description
allowProtectedAppendWritesAll	boolean	Quando habilitados, novos blocos podem ser gravados em 'Append e Bock Blobs' mantendo a proteção e a conformidade de retenção legal. Somente novos blocos podem ser adicionados e os blocos existentes não podem ser modificados ou excluídos.
timestamp	string	Retorna a data e a hora em que a marca foi adicionada.

PublicAccess

Especifica se os dados no contêiner podem ser acessados publicamente e o nível de acesso.

Nome	Tipo	Description
Blob	string
Container	string
None	string

TagProperty

Uma marca do LegalHold de um contêiner de blob.

Nome	Tipo	Description
objectIdentifier	string	Retorna a ID do objeto do usuário que adicionou a marca.
tag	string	O valor da marcação.
tenantId	string	Retorna a ID do locatário que emitiu o token para o usuário que adicionou a marca.
timestamp	string	Retorna a data e a hora em que a marca foi adicionada.
upn	string	Retorna o Nome Principal do Usuário do usuário que adicionou a marca.

UpdateHistoryProperty

Um histórico de atualizações da ImmutabilityPolicy de um contêiner de blob.

Nome	Tipo	Description
allowProtectedAppendWrites	boolean	Essa propriedade só pode ser alterada para políticas de retenção baseadas em tempo desbloqueadas. Quando habilitados, novos blocos podem ser gravados em um blob de acréscimo, mantendo a proteção e a conformidade da imutabilidade. Somente novos blocos podem ser adicionados e os blocos existentes não podem ser modificados ou excluídos. Essa propriedade não pode ser alterada com a API ExtendImmutabilityPolicy.
allowProtectedAppendWritesAll	boolean	Essa propriedade só pode ser alterada para políticas de retenção baseadas em tempo desbloqueadas. Quando habilitados, novos blocos podem ser gravados em 'Blobs de Acréscimo e Bock' mantendo a proteção e a conformidade da imutabilidade. Somente novos blocos podem ser adicionados e os blocos existentes não podem ser modificados ou excluídos. Essa propriedade não pode ser alterada com a API ExtendImmutabilityPolicy. As propriedades 'allowProtectedAppendWrites' e 'allowProtectedAppendWritesAll' são mutuamente exclusivas.
immutabilityPeriodSinceCreationInDays	integer	O período de imutabilidade para os blobs no contêiner desde a criação da política, em dias.
objectIdentifier	string	Retorna a ID do objeto do usuário que atualizou imutabilidadePolicy.
tenantId	string	Retorna a ID do Locatário que emitiu o token para o usuário que atualizou a ImmutabilityPolicy.
timestamp	string	Retorna a data e a hora em que ImmutabilityPolicy foi atualizada.
update	ImmutabilityPolicyUpdateType	O tipo de atualização ImmutabilityPolicy de um contêiner de blob, os valores possíveis incluem: put, lock e extend.
upn	string	Retorna o Nome Principal do Usuário do usuário que atualizou a ImmutabilityPolicy.