Management Policies - Get

Service:

Storage Resource Provider

API Version:

2022-09-01

Gets the managementpolicy associated with the specified storage account.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/default?api-version=2022-09-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.
managementPolicyName	path	True	ManagementPolicyName	The name of the Storage Account Management Policy. It should always be 'default'
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	ManagementPolicy	OK -- Get the managementpolicy 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

StorageAccountGetManagementPolicies

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/managementPolicies/default?api-version=2022-09-01

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.storage.models.ManagementPolicyName;

/** Samples for ManagementPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/examples/StorageAccountGetManagementPolicy.json
     */
    /**
     * Sample code: StorageAccountGetManagementPolicies.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetManagementPolicies(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .storageAccounts()
            .manager()
            .serviceClient()
            .getManagementPolicies()
            .getWithResponse("res6977", "sto2527", ManagementPolicyName.DEFAULT, 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 storage_account_get_management_policy.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.management_policies.get(
        resource_group_name="res6977",
        account_name="sto2527",
        management_policy_name="default",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/examples/StorageAccountGetManagementPolicy.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/b32e1896f30e6ea155449cb49719a6286e32b961/specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/examples/StorageAccountGetManagementPolicy.json
func ExampleManagementPoliciesClient_Get() {
	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.NewManagementPoliciesClient().Get(ctx, "res6977", "sto2527", armstorage.ManagementPolicyNameDefault, 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.ManagementPolicy = armstorage.ManagementPolicy{
	// 	Name: to.Ptr("DefaultManagementPolicy"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/managementPolicies"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default"),
	// 	Properties: &armstorage.ManagementPolicyProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-08T03:01:55.7168089Z"); return t}()),
	// 		Policy: &armstorage.ManagementPolicySchema{
	// 			Rules: []*armstorage.ManagementPolicyRule{
	// 				{
	// 					Name: to.Ptr("olcmtest"),
	// 					Type: to.Ptr(armstorage.RuleTypeLifecycle),
	// 					Definition: &armstorage.ManagementPolicyDefinition{
	// 						Actions: &armstorage.ManagementPolicyAction{
	// 							BaseBlob: &armstorage.ManagementPolicyBaseBlob{
	// 								Delete: &armstorage.DateAfterModification{
	// 									DaysAfterModificationGreaterThan: to.Ptr[float32](1000),
	// 								},
	// 								TierToArchive: &armstorage.DateAfterModification{
	// 									DaysAfterModificationGreaterThan: to.Ptr[float32](90),
	// 								},
	// 								TierToCool: &armstorage.DateAfterModification{
	// 									DaysAfterModificationGreaterThan: to.Ptr[float32](30),
	// 								},
	// 							},
	// 							Snapshot: &armstorage.ManagementPolicySnapShot{
	// 								Delete: &armstorage.DateAfterCreation{
	// 									DaysAfterCreationGreaterThan: to.Ptr[float32](30),
	// 								},
	// 							},
	// 						},
	// 						Filters: &armstorage.ManagementPolicyFilter{
	// 							BlobTypes: []*string{
	// 								to.Ptr("blockBlob")},
	// 								PrefixMatch: []*string{
	// 									to.Ptr("olcmtestcontainer")},
	// 								},
	// 							},
	// 							Enabled: to.Ptr(true),
	// 					}},
	// 				},
	// 			},
	// 		}
}

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 Gets the managementpolicy associated with the specified storage account.
 *
 * @summary Gets the managementpolicy associated with the specified storage account.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/examples/StorageAccountGetManagementPolicy.json
 */
async function storageAccountGetManagementPolicies() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "res6977";
  const accountName = "sto2527";
  const managementPolicyName = "default";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.managementPolicies.get(
    resourceGroupName,
    accountName,
    managementPolicyName
  );
  console.log(result);
}

storageAccountGetManagementPolicies().catch(console.error);

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Storage;
using Azure.ResourceManager.Storage.Models;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/examples/StorageAccountGetManagementPolicy.json
// this example is just showing the usage of "ManagementPolicies_Get" 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 StorageAccountManagementPolicyResource created on azure
// for more information of creating StorageAccountManagementPolicyResource, please refer to the document of StorageAccountManagementPolicyResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res6977";
string accountName = "sto2527";
ManagementPolicyName managementPolicyName = ManagementPolicyName.Default;
ResourceIdentifier storageAccountManagementPolicyResourceId = StorageAccountManagementPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, managementPolicyName);
StorageAccountManagementPolicyResource storageAccountManagementPolicy = client.GetStorageAccountManagementPolicyResource(storageAccountManagementPolicyResourceId);

// invoke the operation
StorageAccountManagementPolicyResource result = await storageAccountManagementPolicy.GetAsync();

// the variable result 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
StorageAccountManagementPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default",
  "name": "DefaultManagementPolicy",
  "type": "Microsoft.Storage/storageAccounts/managementPolicies",
  "properties": {
    "policy": {
      "rules": [
        {
          "enabled": true,
          "name": "olcmtest",
          "type": "Lifecycle",
          "definition": {
            "filters": {
              "blobTypes": [
                "blockBlob"
              ],
              "prefixMatch": [
                "olcmtestcontainer"
              ]
            },
            "actions": {
              "baseBlob": {
                "tierToCool": {
                  "daysAfterModificationGreaterThan": 30
                },
                "tierToArchive": {
                  "daysAfterModificationGreaterThan": 90
                },
                "delete": {
                  "daysAfterModificationGreaterThan": 1000
                }
              },
              "snapshot": {
                "delete": {
                  "daysAfterCreationGreaterThan": 30
                }
              }
            }
          }
        }
      ]
    },
    "lastModifiedTime": "2018-06-08T03:01:55.7168089Z"
  }
}

Definitions

Name	Description
DateAfterCreation	Object to define snapshot and version action conditions.
DateAfterModification	Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan.
ManagementPolicy	The Get Storage Account ManagementPolicies operation response.
ManagementPolicyAction	Actions are applied to the filtered blobs when the execution condition is met.
ManagementPolicyBaseBlob	Management policy action for base blob.
ManagementPolicyDefinition	An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.
ManagementPolicyFilter	Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters.
ManagementPolicyName	The name of the Storage Account Management Policy. It should always be 'default'
ManagementPolicyRule	An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.
ManagementPolicySchema	The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
ManagementPolicySnapShot	Management policy action for snapshot.
ManagementPolicyVersion	Management policy action for blob version.
RuleType	The valid value is Lifecycle
TagFilter	Blob index tag based filtering for blob objects

DateAfterCreation

Object to define snapshot and version action conditions.

Name	Type	Description
daysAfterCreationGreaterThan	number	Value indicating the age in days after creation
daysAfterLastTierChangeGreaterThan	number	Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied.

DateAfterModification

Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan.

Name	Type	Description
daysAfterCreationGreaterThan	number	Value indicating the age in days after blob creation.
daysAfterLastAccessTimeGreaterThan	number	Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy
daysAfterLastTierChangeGreaterThan	number	Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied.
daysAfterModificationGreaterThan	number	Value indicating the age in days after last modification

ManagementPolicy

The Get Storage Account ManagementPolicies operation response.

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.lastModifiedTime	string	Returns the date and time the ManagementPolicies was last modified.
properties.policy	ManagementPolicySchema	The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagementPolicyAction

Actions are applied to the filtered blobs when the execution condition is met.

Name	Type	Description
baseBlob	ManagementPolicyBaseBlob	The management policy action for base blob
snapshot	ManagementPolicySnapShot	The management policy action for snapshot
version	ManagementPolicyVersion	The management policy action for version

ManagementPolicyBaseBlob

Management policy action for base blob.

Name	Type	Description
delete	DateAfterModification	The function to delete the blob
enableAutoTierToHotFromCool	boolean	This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan.
tierToArchive	DateAfterModification	The function to tier blobs to archive storage.
tierToCold	DateAfterModification	The function to tier blobs to cold storage.
tierToCool	DateAfterModification	The function to tier blobs to cool storage.
tierToHot	DateAfterModification	The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts

ManagementPolicyDefinition

An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.

Name	Type	Description
actions	ManagementPolicyAction	An object that defines the action set.
filters	ManagementPolicyFilter	An object that defines the filter set.

ManagementPolicyFilter

Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters.

Name	Type	Description
blobIndexMatch	TagFilter[]	An array of blob index tag based filters, there can be at most 10 tag filters
blobTypes	string[]	An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob.
prefixMatch	string[]	An array of strings for prefixes to be match.

ManagementPolicyName

The name of the Storage Account Management Policy. It should always be 'default'

Name	Type	Description
default	string

ManagementPolicyRule

An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.

Name	Type	Description
definition	ManagementPolicyDefinition	An object that defines the Lifecycle rule.
enabled	boolean	Rule is enabled if set to true.
name	string	A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
type	RuleType	The valid value is Lifecycle

ManagementPolicySchema

The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.

Name	Type	Description
rules	ManagementPolicyRule[]	The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.

ManagementPolicySnapShot

Management policy action for snapshot.

Name	Type	Description
delete	DateAfterCreation	The function to delete the blob snapshot
tierToArchive	DateAfterCreation	The function to tier blob snapshot to archive storage.
tierToCold	DateAfterCreation	The function to tier blobs to cold storage.
tierToCool	DateAfterCreation	The function to tier blob snapshot to cool storage.
tierToHot	DateAfterCreation	The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts

ManagementPolicyVersion

Management policy action for blob version.

Name	Type	Description
delete	DateAfterCreation	The function to delete the blob version
tierToArchive	DateAfterCreation	The function to tier blob version to archive storage.
tierToCold	DateAfterCreation	The function to tier blobs to cold storage.
tierToCool	DateAfterCreation	The function to tier blob version to cool storage.
tierToHot	DateAfterCreation	The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts

RuleType

The valid value is Lifecycle

Name	Type	Description
Lifecycle	string

TagFilter

Blob index tag based filtering for blob objects

Name	Type	Description
name	string	This is the filter tag name, it can have 1 - 128 characters
op	string	This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported
value	string	This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters