Skip to content

[Storage] Support last access time #15406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -100,5 +100,12 @@ public void TestStorageBlobContainerSoftDelete()
{
TestController.NewInstance.RunPsTest(_logger, "Test-StorageBlobContainerSoftDelete");
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestStorageBlobLastAccessTimeTracking()
{
TestController.NewInstance.RunPsTest(_logger, "Test-StorageBlobLastAccessTimeTracking");
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -818,4 +818,72 @@ function Test-StorageBlobContainerSoftDelete
}
}

<#
.SYNOPSIS
Test StorageAccount Blob LastAccessTimeTracking
.DESCRIPTION
SmokeTest
#>
function Test-StorageBlobLastAccessTimeTracking
{
# Setup
$rgname = Get-StorageManagementTestResourceName;

try
{
# Test
$stoname = 'sto' + $rgname;
$stotype = 'Standard_GRS';
$loc = Get-ProviderLocation ResourceManagement;
$kind = 'StorageV2'

Write-Verbose "RGName: $rgname | Loc: $loc"
New-AzResourceGroup -Name $rgname -Location $loc;

$loc = Get-ProviderLocation_canary ResourceManagement;
New-AzStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype -Kind $kind
$stos = Get-AzStorageAccount -ResourceGroupName $rgname;

# Enable Blob LastAccessTimeTracking
$policy = Enable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName $rgname -StorageAccountName $stoname -PassThru
Assert-AreEqual $true $policy.Enable
$property = Get-AzStorageBlobServiceProperty -ResourceGroupName $rgname -StorageAccountName $stoname
Assert-AreEqual $true $property.LastAccessTimeTrackingPolicy.Enable

# set management policy
$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -daysAfterModificationGreaterThan 100
$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToArchive -DaysAfterLastAccessTimeGreaterThan 50 -InputObject $action
$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToCool -DaysAfterLastAccessTimeGreaterThan 30 -EnableAutoTierToHotFromCool -InputObject $action
$action = Add-AzStorageAccountManagementPolicyAction -SnapshotAction Delete -daysAfterCreationGreaterThan 100 -InputObject $action
$filter = New-AzStorageAccountManagementPolicyFilter -PrefixMatch prefix1,prefix2
$rule = New-AzStorageAccountManagementPolicyRule -Name Test -Action $action -Filter $filter
$policy = Set-AzStorageAccountManagementPolicy -ResourceGroupName $rgname -StorageAccountName $stoname -Rule $rule
Assert-AreEqual $true $policy.Rules[0].Definition.Actions.BaseBlob.EnableAutoTierToHotFromCool
Assert-AreEqual 30 $policy.Rules[0].Definition.Actions.BaseBlob.TierToCool.DaysAfterLastAccessTimeGreaterThan
Assert-AreEqual 50 $policy.Rules[0].Definition.Actions.BaseBlob.TierToArchive.DaysAfterLastAccessTimeGreaterThan
Assert-AreEqual 100 $policy.Rules[0].Definition.Actions.BaseBlob.Delete.DaysAfterModificationGreaterThan

# remove management policy
Remove-AzStorageAccountManagementPolicy -ResourceGroupName $rgname -StorageAccountName $stoname

# Disable Blob LastAccessTimeTracking
$policy = Disable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName $rgname -StorageAccountName $stoname -PassThru
# Assert-AreEqual $true (($policy.Enable -eq $false) -or ($policy -eq $null))
$property = Get-AzStorageBlobServiceProperty -ResourceGroupName $rgname -StorageAccountName $stoname
#Assert-AreEqual $true (($property.LastAccessTimeTrackingPolicy.Enable -eq $false) -or ($property.LastAccessTimeTrackingPolicy -eq $null))
# Assert-AreEqual $false $property.LastAccessTimeTrackingPolicy.Enable

Remove-AzStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
}
finally
{
# Cleanup
Clean-ResourceGroup $rgname
}
}






Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion src/Storage/Storage.Management/Az.Storage.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,9 @@ CmdletsToExport = 'Get-AzStorageAccount', 'Get-AzStorageAccountKey',
'Remove-AzStorageBlobInventoryPolicy',
'Enable-AzStorageContainerDeleteRetentionPolicy',
'Disable-AzStorageContainerDeleteRetentionPolicy',
'Restore-AzStorageContainer'
'Restore-AzStorageContainer',
'Enable-AzStorageBlobLastAccessTimeTracking',
'Disable-AzStorageBlobLastAccessTimeTracking'

# Variables to export from this module
# VariablesToExport = @()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
// ----------------------------------------------------------------------------------
//
// Copyright Microsoft Corporation
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------------

namespace Microsoft.Azure.Commands.Management.Storage
{
using Microsoft.Azure.Commands.Management.Storage.Models;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Management.Storage;
using Microsoft.Azure.Management.Storage.Models;
using System.Management.Automation;

/// <summary>
/// Modify Azure Storage service properties
/// </summary>
[Cmdlet("Disable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + StorageBlobLastAccessTimeTracking, SupportsShouldProcess = true, DefaultParameterSetName = AccountNameParameterSet), OutputType(typeof(bool))]
public class DisableAzStorageBlobLastAccessTimeTrackingCommand : StorageBlobBaseCmdlet
{

/// <summary>
/// AccountName Parameter Set
/// </summary>
private const string AccountNameParameterSet = "AccountName";

/// <summary>
/// Account object parameter set
/// </summary>
private const string AccountObjectParameterSet = "AccountObject";

[Parameter(
Position = 0,
Mandatory = true,
HelpMessage = "Resource Group Name.",
ParameterSetName = AccountNameParameterSet)]
[ResourceGroupCompleter]
[ValidateNotNullOrEmpty]
public string ResourceGroupName { get; set; }

[Parameter(
Position = 1,
Mandatory = true,
HelpMessage = "Storage Account Name.",
ParameterSetName = AccountNameParameterSet)]
[ResourceNameCompleter("Microsoft.Storage/storageAccounts", nameof(ResourceGroupName))]
[Alias(AccountNameAlias, NameAlias)]
[ValidateNotNullOrEmpty]
public string StorageAccountName { get; set; }

[Parameter(Mandatory = true,
HelpMessage = "Storage account object",
ValueFromPipeline = true,
ParameterSetName = AccountObjectParameterSet)]
[ValidateNotNullOrEmpty]
public PSStorageAccount StorageAccount { get; set; }

[Parameter(Mandatory = false, HelpMessage = "Display ServiceProperties")]
public SwitchParameter PassThru { get; set; }

public override void ExecuteCmdlet()
{
base.ExecuteCmdlet();
if (ShouldProcess("BlobLastAccessTimeTracking", "Disable"))
{
switch (ParameterSetName)
{
case AccountObjectParameterSet:
this.ResourceGroupName = StorageAccount.ResourceGroupName;
this.StorageAccountName = StorageAccount.StorageAccountName;
break;
default:
// For AccountNameParameterSet, the ResourceGroupName and StorageAccountName can get from input directly
break;
}
BlobServiceProperties serviceProperties = new BlobServiceProperties();

serviceProperties.LastAccessTimeTrackingPolicy = new LastAccessTimeTrackingPolicy();
serviceProperties.LastAccessTimeTrackingPolicy.Enable = false;

serviceProperties = this.StorageClient.BlobServices.SetServiceProperties(this.ResourceGroupName, this.StorageAccountName, serviceProperties);

if (PassThru)
{
WriteObject(true);
}

}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// ----------------------------------------------------------------------------------
//
// Copyright Microsoft Corporation
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------------

namespace Microsoft.Azure.Commands.Management.Storage
{
using Microsoft.Azure.Commands.Management.Storage.Models;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Management.Storage;
using Microsoft.Azure.Management.Storage.Models;
using System.Management.Automation;

/// <summary>
/// Modify Azure Storage service properties
/// </summary>
[Cmdlet("Enable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + StorageBlobLastAccessTimeTracking, DefaultParameterSetName = AccountNameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSRestorePolicy))]
public class EnableAzStorageBlobLastAccessTimeTrackingCommand : StorageBlobBaseCmdlet
{

/// <summary>
/// AccountName Parameter Set
/// </summary>
private const string AccountNameParameterSet = "AccountName";

/// <summary>
/// Account object parameter set
/// </summary>
private const string AccountObjectParameterSet = "AccountObject";

/// <summary>
/// BlobServiceProperties ResourceId parameter set
/// </summary>
private const string PropertiesResourceIdParameterSet = "BlobServicePropertiesResourceId";

[Parameter(
Position = 0,
Mandatory = true,
HelpMessage = "Resource Group Name.",
ParameterSetName = AccountNameParameterSet)]
[ResourceGroupCompleter]
[ValidateNotNullOrEmpty]
public string ResourceGroupName { get; set; }

[Parameter(
Position = 1,
Mandatory = true,
HelpMessage = "Storage Account Name.",
ParameterSetName = AccountNameParameterSet)]
[ResourceNameCompleter("Microsoft.Storage/storageAccounts", nameof(ResourceGroupName))]
[Alias(AccountNameAlias, NameAlias)]
[ValidateNotNullOrEmpty]
public string StorageAccountName { get; set; }

[Parameter(Mandatory = true,
HelpMessage = "Storage account object",
ValueFromPipeline = true,
ParameterSetName = AccountObjectParameterSet)]
[ValidateNotNullOrEmpty]
public PSStorageAccount StorageAccount { get; set; }

[Parameter(Mandatory = false, HelpMessage = "Display ServiceProperties")]
public SwitchParameter PassThru { get; set; }

public override void ExecuteCmdlet()
{
base.ExecuteCmdlet();
if (ShouldProcess("BlobLastAccessTimeTracking", "Enable"))
{
switch (ParameterSetName)
{
case AccountObjectParameterSet:
this.ResourceGroupName = StorageAccount.ResourceGroupName;
this.StorageAccountName = StorageAccount.StorageAccountName;
break;
default:
// For AccountNameParameterSet, the ResourceGroupName and StorageAccountName can get from input directly
break;
}
BlobServiceProperties serviceProperties = new BlobServiceProperties();

serviceProperties.LastAccessTimeTrackingPolicy = new LastAccessTimeTrackingPolicy();
serviceProperties.LastAccessTimeTrackingPolicy.Enable = true;

serviceProperties = this.StorageClient.BlobServices.SetServiceProperties(this.ResourceGroupName, this.StorageAccountName, serviceProperties);


if (PassThru)
{
//Get the full service properties from server for output
serviceProperties = this.StorageClient.BlobServices.GetServiceProperties(this.ResourceGroupName, this.StorageAccountName);

WriteObject(new PSLastAccessTimeTrackingPolicy(serviceProperties.LastAccessTimeTrackingPolicy));
}

}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ public abstract class StorageBlobBaseCmdlet : AzureRMCmdlet
protected const string StorageBlobDeleteRetentionPolicy = "StorageBlobDeleteRetentionPolicy";
protected const string StorageContainerDeleteRetentionPolicy = "StorageContainerDeleteRetentionPolicy";
protected const string StorageBlobRestorePolicy = "StorageBlobRestorePolicy";
protected const string StorageBlobLastAccessTimeTracking = "StorageBlobLastAccessTimeTracking";

public const string StorageAccountResourceType = "Microsoft.Storage/storageAccounts";

Expand Down
6 changes: 6 additions & 0 deletions src/Storage/Storage.Management/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
- Additional information about change #1
-->
## Upcoming Release
* Supported Blob Last Access Time
- `Enable-AzStorageBlobLastAccessTimeTracking`
- `Disable-AzStorageBlobLastAccessTimeTracking`
- `Add-AzStorageAccountManagementPolicyAction`
* Fixed a display issue in list datalake gen2 items
- `Get-AzDataLakeGen2ChildItem`

## Version 3.9.0
* Supported enable/disable Blob container soft delete
Expand Down
35 changes: 35 additions & 0 deletions src/Storage/Storage.Management/Models/PSBlobServiceProperties.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public class PSBlobServiceProperties
public PSDeleteRetentionPolicy ContainerDeleteRetentionPolicy { get; set; }
public PSCorsRules Cors { get; set; }
public bool? IsVersioningEnabled { get; set; }
public PSLastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy { get; set; }

public PSBlobServiceProperties()
{ }
Expand All @@ -65,6 +66,7 @@ public PSBlobServiceProperties(BlobServiceProperties policy)
this.ChangeFeed = policy.ChangeFeed is null ? null : new PSChangeFeed(policy.ChangeFeed);
this.IsVersioningEnabled = policy.IsVersioningEnabled;
this.ContainerDeleteRetentionPolicy = policy.ContainerDeleteRetentionPolicy is null ? null : new PSDeleteRetentionPolicy(policy.ContainerDeleteRetentionPolicy);
this.LastAccessTimeTrackingPolicy = policy.LastAccessTimeTrackingPolicy is null? null : new PSLastAccessTimeTrackingPolicy(policy.LastAccessTimeTrackingPolicy);
}
public BlobServiceProperties ParseBlobServiceProperties()
{
Expand All @@ -77,6 +79,7 @@ public BlobServiceProperties ParseBlobServiceProperties()
ChangeFeed = this.ChangeFeed is null ? null : this.ChangeFeed.ParseChangeFeed(),
IsVersioningEnabled = this.IsVersioningEnabled,
ContainerDeleteRetentionPolicy = this.ContainerDeleteRetentionPolicy is null ? null : this.ContainerDeleteRetentionPolicy.ParseDeleteRetentionPolicy(),
LastAccessTimeTrackingPolicy = this.LastAccessTimeTrackingPolicy is null ? null : this.LastAccessTimeTrackingPolicy.ParseLastAccessTimeTrackingPolicy()
};
}

Expand Down Expand Up @@ -296,4 +299,36 @@ private static string[] ListToArray(IList<string> stringList)
return stringArray;
}
}

/// <summary>
/// Wrapper of SDK type LastAccessTimeTrackingPolicy
/// </summary>
public class PSLastAccessTimeTrackingPolicy
{
public bool Enable { get; set; }
public string Name { get; set; }
public int? TrackingGranularityInDays { get; set; }
public string[] BlobType { get; set; }


public PSLastAccessTimeTrackingPolicy(LastAccessTimeTrackingPolicy policy)
{
this.Name = policy.Name;
this.Enable = policy.Enable;
this.TrackingGranularityInDays = policy.TrackingGranularityInDays;
this.BlobType = policy.BlobType is null ? null : new List<string>(policy.BlobType).ToArray();
}

public LastAccessTimeTrackingPolicy ParseLastAccessTimeTrackingPolicy()
{
return new LastAccessTimeTrackingPolicy()
{

Name = this.Name,
Enable = this.Enable,
TrackingGranularityInDays = this.TrackingGranularityInDays,
BlobType = this.BlobType is null ? null : new List<string>(this.BlobType)
};
}
}
}
Loading