Blob Containers - List

Service:

Storage Resource Provider

API Version:

2024-01-01

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers?api-version=2024-01-01&$maxpagesize={$maxpagesize}&$filter={$filter}&$include=deleted

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	Optional. When specified, only container names starting with the filter will be listed.
$include	query		ListContainersInclude	Optional, used to include the properties for soft deleted blob containers.
$maxpagesize	query		string	Optional. Specified maximum number of containers that can be included in the list.

Responses

Name	Type	Description
200 OK	ListContainerItems	OK -- List Container operation completed successfully.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListContainers

ListDeletedContainers

ListContainers

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers?api-version=2024-01-01&$include=deleted

Java

/**
 * Samples for BlobContainers List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersList.json
     */
    /**
     * Sample code: ListContainers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listContainers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobContainers().list("res9290", "sto1590", null, null,
            null, 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_list.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.list(
        resource_group_name="res9290",
        account_name="sto1590",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersList.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/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/9d3547622288137fd36f086afcdaea5408dbe48c/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersList.json
func ExampleBlobContainersClient_NewListPager_listContainers() {
	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)
	}
	pager := clientFactory.NewBlobContainersClient().NewListPager("res9290", "sto1590", &armstorage.BlobContainersClientListOptions{Maxpagesize: nil,
		Filter:  nil,
		Include: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListContainerItems = armstorage.ListContainerItems{
		// 	Value: []*armstorage.ListContainerItem{
		// 		{
		// 			Name: to.Ptr("container1644"),
		// 			Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644"),
		// 			Etag: to.Ptr("\"0x8D589847D51C7DE\""),
		// 			Properties: &armstorage.ContainerProperties{
		// 				HasImmutabilityPolicy: to.Ptr(false),
		// 				HasLegalHold: to.Ptr(false),
		// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T08:20:47.000Z"); return t}()),
		// 				LeaseState: to.Ptr(armstorage.LeaseStateAvailable),
		// 				LeaseStatus: to.Ptr(armstorage.LeaseStatusUnlocked),
		// 				PublicAccess: to.Ptr(armstorage.PublicAccessContainer),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("container4052"),
		// 			Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052"),
		// 			Etag: to.Ptr("\"0x8D589847DAB5AF9\""),
		// 			Properties: &armstorage.ContainerProperties{
		// 				HasImmutabilityPolicy: to.Ptr(false),
		// 				HasLegalHold: to.Ptr(false),
		// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T08:20:47.000Z"); return t}()),
		// 				LeaseState: to.Ptr(armstorage.LeaseStateAvailable),
		// 				LeaseStatus: to.Ptr(armstorage.LeaseStatusUnlocked),
		// 				PublicAccess: to.Ptr(armstorage.PublicAccessNone),
		// 			},
		// 	}},
		// }
	}
}

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 Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
 *
 * @summary Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobContainersList.json
 */
async function listContainers() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9290";
  const accountName = "sto1590";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.blobContainers.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/BlobContainersList.json
// this example is just showing the usage of "BlobContainers_List" 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 BlobServiceResource created on azure
// for more information of creating BlobServiceResource, please refer to the document of BlobServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9290";
string accountName = "sto1590";
ResourceIdentifier blobServiceResourceId = BlobServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BlobServiceResource blobService = client.GetBlobServiceResource(blobServiceResourceId);

// get the collection of this BlobContainerResource
BlobContainerCollection collection = blobService.GetBlobContainers();

// invoke the operation and iterate over the result
await foreach (BlobContainerResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644",
      "name": "container1644",
      "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
      "etag": "\"0x8D589847D51C7DE\"",
      "properties": {
        "publicAccess": "Container",
        "leaseStatus": "Unlocked",
        "leaseState": "Available",
        "lastModifiedTime": "2018-03-14T08:20:47Z",
        "hasImmutabilityPolicy": false,
        "hasLegalHold": false
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052",
      "name": "container4052",
      "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "publicAccess": "None",
        "leaseStatus": "Unlocked",
        "leaseState": "Available",
        "lastModifiedTime": "2018-03-14T08:20:47Z",
        "hasImmutabilityPolicy": false,
        "hasLegalHold": false
      }
    }
  ],
  "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers?api-version=2022-09-01&$maxpagesize=2&$skipToken=/sto1590/container5103"
}

ListDeletedContainers

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers?api-version=2024-01-01&$include=deleted

Java

import com.azure.resourcemanager.storage.models.ListContainersInclude;

/**
 * Samples for BlobContainers List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/DeletedBlobContainersList.
     * json
     */
    /**
     * Sample code: ListDeletedContainers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDeletedContainers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobContainers().list("res9290", "sto1590", null, null,
            ListContainersInclude.DELETED, 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 deleted_blob_containers_list.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.list(
        resource_group_name="res9290",
        account_name="sto1590",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/DeletedBlobContainersList.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/9d3547622288137fd36f086afcdaea5408dbe48c/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/DeletedBlobContainersList.json
func ExampleBlobContainersClient_NewListPager_listDeletedContainers() {
	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)
	}
	pager := clientFactory.NewBlobContainersClient().NewListPager("res9290", "sto1590", &armstorage.BlobContainersClientListOptions{Maxpagesize: nil,
		Filter:  nil,
		Include: to.Ptr(armstorage.ListContainersIncludeDeleted),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListContainerItems = armstorage.ListContainerItems{
		// 	Value: []*armstorage.ListContainerItem{
		// 		{
		// 			Name: to.Ptr("container1644"),
		// 			Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644"),
		// 			Etag: to.Ptr("\"0x8D589847D51C7DE\""),
		// 			Properties: &armstorage.ContainerProperties{
		// 				HasImmutabilityPolicy: to.Ptr(false),
		// 				HasLegalHold: to.Ptr(false),
		// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T08:20:47.000Z"); return t}()),
		// 				LeaseState: to.Ptr(armstorage.LeaseStateAvailable),
		// 				LeaseStatus: to.Ptr(armstorage.LeaseStatusUnlocked),
		// 				PublicAccess: to.Ptr(armstorage.PublicAccessContainer),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("container4052"),
		// 			Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices/containers"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052"),
		// 			Etag: to.Ptr("\"0x8D589847DAB5AF9\""),
		// 			Properties: &armstorage.ContainerProperties{
		// 				Deleted: to.Ptr(true),
		// 				DeletedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-14T08:20:47.000Z"); return t}()),
		// 				HasImmutabilityPolicy: to.Ptr(false),
		// 				HasLegalHold: to.Ptr(false),
		// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T08:20:47.000Z"); return t}()),
		// 				LeaseState: to.Ptr(armstorage.LeaseStateExpired),
		// 				LeaseStatus: to.Ptr(armstorage.LeaseStatusUnlocked),
		// 				PublicAccess: to.Ptr(armstorage.PublicAccessNone),
		// 				RemainingRetentionDays: to.Ptr[int32](30),
		// 				Version: to.Ptr("1234567890"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
 *
 * @summary Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/DeletedBlobContainersList.json
 */
async function listDeletedContainers() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9290";
  const accountName = "sto1590";
  const include = "deleted";
  const options = { include };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.blobContainers.list(resourceGroupName, accountName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/DeletedBlobContainersList.json
// this example is just showing the usage of "BlobContainers_List" 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 BlobServiceResource created on azure
// for more information of creating BlobServiceResource, please refer to the document of BlobServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9290";
string accountName = "sto1590";
ResourceIdentifier blobServiceResourceId = BlobServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BlobServiceResource blobService = client.GetBlobServiceResource(blobServiceResourceId);

// get the collection of this BlobContainerResource
BlobContainerCollection collection = blobService.GetBlobContainers();

// invoke the operation and iterate over the result
BlobContainerState? include = BlobContainerState.Deleted;
await foreach (BlobContainerResource item in collection.GetAllAsync(include: include))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644",
      "name": "container1644",
      "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
      "etag": "\"0x8D589847D51C7DE\"",
      "properties": {
        "publicAccess": "Container",
        "leaseStatus": "Unlocked",
        "leaseState": "Available",
        "lastModifiedTime": "2018-03-14T08:20:47Z",
        "hasImmutabilityPolicy": false,
        "hasLegalHold": false
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052",
      "name": "container4052",
      "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "publicAccess": "None",
        "leaseStatus": "Unlocked",
        "leaseState": "Expired",
        "lastModifiedTime": "2018-03-14T08:20:47Z",
        "hasImmutabilityPolicy": false,
        "hasLegalHold": false,
        "version": "1234567890",
        "deleted": true,
        "deletedTime": "2019-12-14T08:20:47Z",
        "remainingRetentionDays": 30
      }
    }
  ]
}

Definitions

Name	Description
ImmutabilityPolicyProperties	The properties of an ImmutabilityPolicy of a blob container.
ImmutabilityPolicyState	The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
ImmutabilityPolicyUpdateType	The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
ImmutableStorageWithVersioning	Object level immutability properties of the container.
LeaseDuration	Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
LeaseState	Lease state of the container.
LeaseStatus	The lease status of the container.
LegalHoldProperties	The LegalHold property of a blob container.
ListContainerItem	The blob container properties be listed out.
ListContainerItems	Response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers.
ListContainersInclude	Optional, used to include the properties for soft deleted blob containers.
MigrationState	This property denotes the container level immutability to object level immutability migration state.
ProtectedAppendWritesHistory	Protected append writes history setting for the blob container with Legal holds.
PublicAccess	Specifies whether data in the container may be accessed publicly and the level of access.
TagProperty	A tag of the LegalHold of a blob container.
UpdateHistoryProperty	An update history of the ImmutabilityPolicy of a blob container.

ImmutabilityPolicyProperties

Object

The properties of an ImmutabilityPolicy of a blob container.

Name	Type	Description
etag	string	ImmutabilityPolicy Etag.
properties.allowProtectedAppendWrites	boolean	This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
properties.allowProtectedAppendWritesAll	boolean	This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
properties.immutabilityPeriodSinceCreationInDays	integer	The immutability period for the blobs in the container since the policy creation, in days.
properties.state	ImmutabilityPolicyState	The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
updateHistory	UpdateHistoryProperty[]	The ImmutabilityPolicy update history of the blob container.

ImmutabilityPolicyState

Enumeration

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.

Value	Description
Locked
Unlocked

ImmutabilityPolicyUpdateType

Enumeration

The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.

Value	Description
extend
lock
put

ImmutableStorageWithVersioning

Object

Object level immutability properties of the container.

Name	Type	Description
enabled	boolean	This is an immutable property, when set to true it enables object level immutability at the container level.
migrationState	MigrationState	This property denotes the container level immutability to object level immutability migration state.
timeStamp	string (date-time)	Returns the date and time the object level immutability was enabled.

LeaseDuration

Enumeration

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.

Value	Description
Fixed
Infinite

LeaseState

Enumeration

Lease state of the container.

Value	Description
Available
Breaking
Broken
Expired
Leased

LeaseStatus

Enumeration

The lease status of the container.

Value	Description
Locked
Unlocked

LegalHoldProperties

Object

The LegalHold property of a blob container.

Name	Type	Description
hasLegalHold	boolean	The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
protectedAppendWritesHistory	ProtectedAppendWritesHistory	Protected append blob writes history.
tags	TagProperty[]	The list of LegalHold tags of a blob container.

ListContainerItem

Object

The blob container properties be listed out.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.defaultEncryptionScope	string	Default the container to use specified encryption scope for all writes.
properties.deleted	boolean	Indicates whether the blob container was deleted.
properties.deletedTime	string (date-time)	Blob container deletion time.
properties.denyEncryptionScopeOverride	boolean	Block override of encryption scope from the container default.
properties.enableNfsV3AllSquash	boolean	Enable NFSv3 all squash on blob container.
properties.enableNfsV3RootSquash	boolean	Enable NFSv3 root squash on blob container.
properties.hasImmutabilityPolicy	boolean	The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
properties.hasLegalHold	boolean	The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
properties.immutabilityPolicy	ImmutabilityPolicyProperties	The ImmutabilityPolicy property of the container.
properties.immutableStorageWithVersioning	ImmutableStorageWithVersioning	The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
properties.lastModifiedTime	string (date-time)	Returns the date and time the container was last modified.
properties.leaseDuration	LeaseDuration	Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
properties.leaseState	LeaseState	Lease state of the container.
properties.leaseStatus	LeaseStatus	The lease status of the container.
properties.legalHold	LegalHoldProperties	The LegalHold property of the container.
properties.metadata	object	A name-value pair to associate with the container as metadata.
properties.publicAccess	PublicAccess	Specifies whether data in the container may be accessed publicly and the level of access.
properties.remainingRetentionDays	integer	Remaining retention days for soft deleted blob container.
properties.version	string	The version of the deleted blob container.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ListContainerItems

Object

Response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers.

Name	Type	Description
nextLink	string	Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.
value	ListContainerItem[]	List of blobs containers returned.

ListContainersInclude

Enumeration

Optional, used to include the properties for soft deleted blob containers.

Value	Description
deleted

MigrationState

Enumeration

This property denotes the container level immutability to object level immutability migration state.

Value	Description
Completed
InProgress

ProtectedAppendWritesHistory

Object

Protected append writes history setting for the blob container with Legal holds.

Name	Type	Description
allowProtectedAppendWritesAll	boolean	When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
timestamp	string (date-time)	Returns the date and time the tag was added.

PublicAccess

Enumeration

Specifies whether data in the container may be accessed publicly and the level of access.

Value	Description
Blob
Container
None

TagProperty

Object

A tag of the LegalHold of a blob container.

Name	Type	Description
objectIdentifier	string	Returns the Object ID of the user who added the tag.
tag	string	The tag value.
tenantId	string	Returns the Tenant ID that issued the token for the user who added the tag.
timestamp	string (date-time)	Returns the date and time the tag was added.
upn	string	Returns the User Principal Name of the user who added the tag.

UpdateHistoryProperty

Object

An update history of the ImmutabilityPolicy of a blob container.

Name	Type	Description
allowProtectedAppendWrites	boolean	This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll	boolean	This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays	integer	The immutability period for the blobs in the container since the policy creation, in days.
objectIdentifier	string	Returns the Object ID of the user who updated the ImmutabilityPolicy.
tenantId	string	Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
timestamp	string (date-time)	Returns the date and time the ImmutabilityPolicy was updated.
update	ImmutabilityPolicyUpdateType	The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
upn	string	Returns the User Principal Name of the user who updated the ImmutabilityPolicy.