Get-AzStorageBlob

Module:

Az.Storage Module

Lists blobs in a container.

Get-AzStorageBlob
 [[-Blob] <String>]
 [-Container] <String>
 [-IncludeDeleted]
 [-IncludeTag]
 [-MaxCount <Int32>]
 [-ContinuationToken <BlobContinuationToken>]
 [-TagCondition <String>]
 [-Context <IStorageContext>]
 [-ServerTimeoutPerRequest <Int32>]
 [-ClientTimeoutPerRequest <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [-ConcurrentTaskCount <Int32>]
 [<CommonParameters>]

Get-AzStorageBlob
 [-Blob] <String>
 [-Container] <String>
 -SnapshotTime <DateTimeOffset>
 [-IncludeDeleted]
 [-IncludeTag]
 [-MaxCount <Int32>]
 [-ContinuationToken <BlobContinuationToken>]
 [-TagCondition <String>]
 [-Context <IStorageContext>]
 [-ServerTimeoutPerRequest <Int32>]
 [-ClientTimeoutPerRequest <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [-ConcurrentTaskCount <Int32>]
 [<CommonParameters>]

Get-AzStorageBlob
 [-Blob] <String>
 [-Container] <String>
 -VersionId <String>
 [-IncludeDeleted]
 [-IncludeTag]
 [-MaxCount <Int32>]
 [-ContinuationToken <BlobContinuationToken>]
 [-TagCondition <String>]
 [-Context <IStorageContext>]
 [-ServerTimeoutPerRequest <Int32>]
 [-ClientTimeoutPerRequest <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [-ConcurrentTaskCount <Int32>]
 [<CommonParameters>]

Get-AzStorageBlob
 [-Container] <String>
 [-Prefix <String>]
 [-IncludeDeleted]
 [-IncludeVersion]
 [-IncludeTag]
 [-MaxCount <Int32>]
 [-ContinuationToken <BlobContinuationToken>]
 [-Context <IStorageContext>]
 [-ServerTimeoutPerRequest <Int32>]
 [-ClientTimeoutPerRequest <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [-ConcurrentTaskCount <Int32>]
 [<CommonParameters>]

The Get-AzStorageBlob cmdlet lists blobs in the specified container in an Azure storage account.

Get-AzStorageBlob -Container "ContainerName" -Blob blob*

This command uses a blob name and wildcard to get a blob.

Get-AzStorageContainer -Name container* | Get-AzStorageBlob -IncludeDeleted

Container Uri: https://storageaccountname.blob.core.windows.net/container1

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted
---- -------- ------ ----------- ------------ ---------- ------------ ---------
test1 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:19Z 2017-11-08 08:19:32Z True
test1 BlockBlob 403116 application/octet-stream 2017-11-08 09:00:29Z True
test2 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:00Z False

This command uses the pipeline to get all blobs (include blobs in Deleted status) in a container.

Get-AzStorageBlob -Container "ContainerName" -Prefix "blob"

This command uses a name prefix to get blobs.

$MaxReturn = 10000
$ContainerName = "abc"
$Total = 0
$Token = $Null
do
 {
 $Blobs = Get-AzStorageBlob -Container $ContainerName -MaxCount $MaxReturn -ContinuationToken $Token
 $Total += $Blobs.Count
 if($Blobs.Length -le 0) { Break;}
 $Token = $Blobs[$blobs.Count -1].ContinuationToken;
 }
 While ($null -ne $Token)
Echo "Total $Total blobs in container $ContainerName"

This example uses the MaxCount and ContinuationToken parameters to list Azure Storage blobs in multiple batches. The first four commands assign values to variables to use in the example. The fifth command specifies a Do-While statement that uses the Get-AzStorageBlob cmdlet to get blobs. The statement includes the continuation token stored in the $Token variable. $Token changes value as the loop runs. For more information, type Get-Help About_Do. The final command uses the Echo command to display the total.

Get-AzStorageBlob -Container "containername" -IncludeVersion

AccountName: storageaccountname, ContainerName: containername

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId
---- -------- ------ ----------- ------------ ---------- ------------ --------- ---------
blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot False 2020-07-06T06:56:06.2432658Z
blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot 2020-07-06T06:56:06.8588431Z False
blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot False 2020-07-06T06:56:06.8598431Z *
blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:16Z Hot False 2020-07-03T16:19:16.2883167Z
blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:35Z Hot False 2020-07-03T16:19:35.2381110Z *

This command gets all blobs in a container include blob version.

Get-AzStorageBlob -Container "containername" -Blob blob2 -VersionId "2020-07-03T16:19:16.2883167Z"

AccountName: storageaccountname, ContainerName: containername

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId
---- -------- ------ ----------- ------------ ---------- ------------ --------- ---------
blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:16Z Hot False 2020-07-03T16:19:16.2883167Z

This command gets a single blobs version with VersionId.

Get-AzStorageBlob -Container "containername" -Blob blob1 -SnapshotTime "2020-07-06T06:56:06.8588431Z"

AccountName: storageaccountname, ContainerName: containername

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId
---- -------- ------ ----------- ------------ ---------- ------------ --------- ---------
blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot 2020-07-06T06:56:06.8588431Z False

This command gets a single blobs snapshot with SnapshotTime.

$blobs = Get-AzStorageBlob -Container "containername" -IncludeTag

$blobs

 AccountName: storageaccountname, ContainerName: containername

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId
---- -------- ------ ----------- ------------ ---------- ------------ --------- ---------
testblob BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:02Z Hot False 2020-07-23T09:35:02.8527357Z *
testblob2 BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:04Z Hot False 2020-07-23T09:35:04.0856187Z *


$blobs[0].Tags
Name Value
---- -----
tag1 value1
tag2 value2

This command lists blobs from a container with blob tags, and show the tags of the first blob.

Get-AzStorageBlob -Container "containername" -Blob testblob -TagCondition """tag1""='value1'"

AccountName: storageaccountname, ContainerName: containername

Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId
---- -------- ------ ----------- ------------ ---------- ------------ --------- ---------
testblob BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:02Z Hot False 2020-07-23T09:35:02.8527357Z *

This command gets a single blob with blob tag condition. The cmdlet will only success when the blob contains a tag with name "tag1" and value "value1", else the cmdlet will fail with error code 412.

$blobProperties = (Get-AzStorageBlob -Container "ContainerName" -Blob "blob" -Context $ctx).BlobProperties
$blobProperties.ImmutabilityPolicy

ExpiresOn PolicyMode
--------- ----------
9/17/2024 2:49:32 AM +00:00 Unlocked

This example command gets the immutability property of a single blob. You can get a detailed list of blob properties from the BlobProperties property, including but not limited to: LastModified, ContentLength, ContentHash, BlobType, LeaseState, AccessTier, ETag, ImmutabilityPolicy, etc... To list multiple blobs (execute the cmdlet without blob name), use ListBlobProperties.Properties instead of BlobProperties for better performance.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.