Blob Services - List

Service:

Storage Resource Provider

API Version:

2023-05-01

List blob services of storage account. It returns a collection of one object named default.

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	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. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BlobServiceItems	OK -- List blob services 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

ListBlobServices

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices?api-version=2023-05-01

Java

/**
 * Samples for BlobServices List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/BlobServicesList.json
     */
    /**
     * Sample code: ListBlobServices.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listBlobServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobServices().list("res4410", "sto8607",
            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_services_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_services.list(
        resource_group_name="res4410",
        account_name="sto8607",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/BlobServicesList.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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/BlobServicesList.json
func ExampleBlobServicesClient_NewListPager() {
	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.NewBlobServicesClient().NewListPager("res4410", "sto8607", 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.BlobServiceItems = armstorage.BlobServiceItems{
		// 	Value: []*armstorage.BlobServiceProperties{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default"),
		// 			BlobServiceProperties: &armstorage.BlobServicePropertiesProperties{
		// 				ChangeFeed: &armstorage.ChangeFeed{
		// 					Enabled: to.Ptr(true),
		// 					RetentionInDays: to.Ptr[int32](7),
		// 				},
		// 				Cors: &armstorage.CorsRules{
		// 					CorsRules: []*armstorage.CorsRule{
		// 						{
		// 							AllowedHeaders: []*string{
		// 								to.Ptr("x-ms-meta-abc"),
		// 								to.Ptr("x-ms-meta-data*"),
		// 								to.Ptr("x-ms-meta-target*")},
		// 								AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemHEAD),
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemPOST),
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemOPTIONS),
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemMERGE),
		// 									to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
		// 									AllowedOrigins: []*string{
		// 										to.Ptr("http://www.contoso.com"),
		// 										to.Ptr("http://www.fabrikam.com")},
		// 										ExposedHeaders: []*string{
		// 											to.Ptr("x-ms-meta-*")},
		// 											MaxAgeInSeconds: to.Ptr[int32](100),
		// 										},
		// 										{
		// 											AllowedHeaders: []*string{
		// 												to.Ptr("*")},
		// 												AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
		// 													to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET)},
		// 													AllowedOrigins: []*string{
		// 														to.Ptr("*")},
		// 														ExposedHeaders: []*string{
		// 															to.Ptr("*")},
		// 															MaxAgeInSeconds: to.Ptr[int32](2),
		// 														},
		// 														{
		// 															AllowedHeaders: []*string{
		// 																to.Ptr("x-ms-meta-12345675754564*")},
		// 																AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
		// 																	to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
		// 																	to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
		// 																	AllowedOrigins: []*string{
		// 																		to.Ptr("http://www.abc23.com"),
		// 																		to.Ptr("https://www.fabrikam.com/*")},
		// 																		ExposedHeaders: []*string{
		// 																			to.Ptr("x-ms-meta-abc"),
		// 																			to.Ptr("x-ms-meta-data*"),
		// 																			to.Ptr("x -ms-meta-target*")},
		// 																			MaxAgeInSeconds: to.Ptr[int32](2000),
		// 																	}},
		// 																},
		// 																DefaultServiceVersion: to.Ptr("2017-07-29"),
		// 																DeleteRetentionPolicy: &armstorage.DeleteRetentionPolicy{
		// 																	Days: to.Ptr[int32](300),
		// 																	Enabled: to.Ptr(true),
		// 																},
		// 																IsVersioningEnabled: to.Ptr(true),
		// 															},
		// 															SKU: &armstorage.SKU{
		// 																Name: to.Ptr(armstorage.SKUNameStandardGRS),
		// 																Tier: to.Ptr(armstorage.SKUTierStandard),
		// 															},
		// 													}},
		// 												}
	}
}

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 List blob services of storage account. It returns a collection of one object named default.
 *
 * @summary List blob services of storage account. It returns a collection of one object named default.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/BlobServicesList.json
 */
async function listBlobServices() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res4410";
  const accountName = "sto8607";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.blobServices.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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default",
      "name": "default",
      "type": "Microsoft.Storage/storageAccounts/blobServices",
      "properties": {
        "cors": {
          "corsRules": [
            {
              "allowedOrigins": [
                "http://www.contoso.com",
                "http://www.fabrikam.com"
              ],
              "allowedMethods": [
                "GET",
                "HEAD",
                "POST",
                "OPTIONS",
                "MERGE",
                "PUT"
              ],
              "maxAgeInSeconds": 100,
              "exposedHeaders": [
                "x-ms-meta-*"
              ],
              "allowedHeaders": [
                "x-ms-meta-abc",
                "x-ms-meta-data*",
                "x-ms-meta-target*"
              ]
            },
            {
              "allowedOrigins": [
                "*"
              ],
              "allowedMethods": [
                "GET"
              ],
              "maxAgeInSeconds": 2,
              "exposedHeaders": [
                "*"
              ],
              "allowedHeaders": [
                "*"
              ]
            },
            {
              "allowedOrigins": [
                "http://www.abc23.com",
                "https://www.fabrikam.com/*"
              ],
              "allowedMethods": [
                "GET",
                "PUT"
              ],
              "maxAgeInSeconds": 2000,
              "exposedHeaders": [
                "x-ms-meta-abc",
                "x-ms-meta-data*",
                "x -ms-meta-target*"
              ],
              "allowedHeaders": [
                "x-ms-meta-12345675754564*"
              ]
            }
          ]
        },
        "defaultServiceVersion": "2017-07-29",
        "deleteRetentionPolicy": {
          "enabled": true,
          "days": 300
        },
        "isVersioningEnabled": true,
        "changeFeed": {
          "enabled": true,
          "retentionInDays": 7
        }
      },
      "sku": {
        "name": "Standard_GRS",
        "tier": "Standard"
      }
    }
  ]
}

Definitions

Name	Description
AllowedMethods	Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
BlobServiceItems
BlobServiceProperties	The properties of a storage account’s Blob service.
ChangeFeed	The blob service properties for change feed events.
CorsRule	Specifies a CORS rule for the Blob service.
CorsRules	Sets the CORS rules. You can include up to five CorsRule elements in the request.
DeleteRetentionPolicy	The service properties for soft delete.
LastAccessTimeTrackingPolicy	The blob service properties for Last access time based tracking policy.
name	Name of the policy. The valid value is AccessTimeTracking. This field is currently read only
RestorePolicyProperties	The blob service properties for blob restore policy
Sku	The SKU of the storage account.
SkuName	The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
SkuTier	The SKU tier. This is based on the SKU name.

AllowedMethods

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

Name	Type	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

BlobServiceItems

Name	Type	Description
value	BlobServiceProperties[]	List of blob services returned.

BlobServiceProperties

The properties of a storage account’s Blob service.

Name	Type	Description
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.automaticSnapshotPolicyEnabled	boolean	Deprecated in favor of isVersioningEnabled property.
properties.changeFeed	ChangeFeed	The blob service properties for change feed events.
properties.containerDeleteRetentionPolicy	DeleteRetentionPolicy	The blob service properties for container soft delete.
properties.cors	CorsRules	Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
properties.defaultServiceVersion	string	DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.
properties.deleteRetentionPolicy	DeleteRetentionPolicy	The blob service properties for blob soft delete.
properties.isVersioningEnabled	boolean	Versioning is enabled if set to true.
properties.lastAccessTimeTrackingPolicy	LastAccessTimeTrackingPolicy	The blob service property to configure last access time based tracking policy.
properties.restorePolicy	RestorePolicyProperties	The blob service properties for blob restore policy.
sku	Sku	Sku name and tier.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ChangeFeed

The blob service properties for change feed events.

Name	Type	Description
enabled	boolean	Indicates whether change feed event logging is enabled for the Blob service.
retentionInDays	integer	Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed.

CorsRule

Specifies a CORS rule for the Blob service.

Name	Type	Description
allowedHeaders	string[]	Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.
allowedMethods	AllowedMethods[]	Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.
allowedOrigins	string[]	Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
exposedHeaders	string[]	Required if CorsRule element is present. A list of response headers to expose to CORS clients.
maxAgeInSeconds	integer	Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

CorsRules

Sets the CORS rules. You can include up to five CorsRule elements in the request.

Name	Type	Description
corsRules	CorsRule[]	The List of CORS rules. You can include up to five CorsRule elements in the request.

DeleteRetentionPolicy

The service properties for soft delete.

Name	Type	Description
allowPermanentDelete	boolean	This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share.
days	integer	Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.
enabled	boolean	Indicates whether DeleteRetentionPolicy is enabled.

LastAccessTimeTrackingPolicy

The blob service properties for Last access time based tracking policy.

Name	Type	Description
blobType	string[]	An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only
enable	boolean	When set to true last access time based tracking is enabled.
name	name	Name of the policy. The valid value is AccessTimeTracking. This field is currently read only
trackingGranularityInDays	integer	The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1

name

Name of the policy. The valid value is AccessTimeTracking. This field is currently read only

Name	Type	Description
AccessTimeTracking	string

RestorePolicyProperties

The blob service properties for blob restore policy

Name	Type	Description
days	integer	how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days.
enabled	boolean	Blob restore is enabled if set to true.
lastEnabledTime	string	Deprecated in favor of minRestoreTime property.
minRestoreTime	string	Returns the minimum date and time that the restore can be started.

Sku

The SKU of the storage account.

Name	Type	Description
name	SkuName	The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
tier	SkuTier	The SKU tier. This is based on the SKU name.

SkuName

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

Name	Type	Description
Premium_LRS	string
Premium_ZRS	string
Standard_GRS	string
Standard_GZRS	string
Standard_LRS	string
Standard_RAGRS	string
Standard_RAGZRS	string
Standard_ZRS	string

SkuTier

The SKU tier. This is based on the SKU name.

Name	Type	Description
Premium	string
Standard	string