Management Policies - Get

Servicio:

Storage Resource Provider

Versión de la API:

2024-01-01

Obtiene la directiva de administración asociada a la cuenta de almacenamiento especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Nombre de la cuenta de almacenamiento dentro del grupo de recursos especificado. Los nombres de cuenta de almacenamiento deben tener entre 3 y 24 caracteres de longitud y usar solo números y letras minúsculas.
managementPolicyName	path	True	ManagementPolicyName	Nombre de la directiva de administración de cuentas de almacenamiento. Siempre debe ser "predeterminado".
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos dentro de la suscripción del usuario. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ManagementPolicy	Correcto: obtenga correctamente la directiva de administración.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

StorageAccountGetManagementPolicies

Solicitud de ejemplo

HTTP

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

Java

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/2024-01-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, 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 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/2024-01-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/86c6306649b02e542117adb46c61e8019dbd78e9/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-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.716Z"); 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");
require("dotenv/config");

/**
 * 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/2024-01-01/examples/StorageAccountGetManagementPolicy.json
 */
async function storageAccountGetManagementPolicies() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "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);
}

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/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

Respuesta de muestra

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"
  }
}

Definiciones

Nombre	Description
DateAfterCreation	Objeto para definir las condiciones de acción de instantánea y versión.
DateAfterModification	Objeto para definir las condiciones de acción del blob base. Las propiedades daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan y daysAfterCreationGreaterThan son mutuamente excluyentes. La propiedad daysAfterLastTierChangeGreaterThan solo es aplicable a las acciones tierToArchive que requieren que se establezca daysAfterModificationGreaterThan, tampoco se puede usar junto con daysAfterLastAccessTimeGreaterThan o daysAfterCreationGreaterThan.
ManagementPolicy	Respuesta de la operación Get Storage Account ManagementPolicies.
ManagementPolicyAction	Las acciones se aplican a los blobs filtrados cuando se cumple la condición de ejecución.
ManagementPolicyBaseBlob	Acción de directiva de administración para el blob base.
ManagementPolicyDefinition	Objeto que define la regla de ciclo de vida. Cada definición se compone de un conjunto de filtros y un conjunto de acciones.
ManagementPolicyFilter	Los filtros limitan las acciones de regla a un subconjunto de blobs dentro de la cuenta de almacenamiento. Si se definen varios filtros, se realiza una and lógica en todos los filtros.
ManagementPolicyName	Nombre de la directiva de administración de cuentas de almacenamiento. Siempre debe ser "predeterminado".
ManagementPolicyRule	Objeto que ajusta la regla de ciclo de vida. Cada regla se define de forma única por nombre.
ManagementPolicySchema	Reglas de administración de cuentas de almacenamientoDirectivas. Vea más detalles en: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.
ManagementPolicySnapShot	Acción de directiva de administración para la instantánea.
ManagementPolicyVersion	Acción de directiva de administración para la versión del blob.
RuleType	El valor válido es Ciclo de vida.
TagFilter	Filtrado basado en etiquetas de índice de blobs para objetos de blobs

DateAfterCreation

Object

Objeto para definir las condiciones de acción de instantánea y versión.

Nombre	Tipo	Description
daysAfterCreationGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días después de la creación
daysAfterLastTierChangeGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días posteriores a la hora de cambio del último nivel de blob. Esta propiedad solo es aplicable a las acciones tierToArchive y requiere que daysAfterCreationGreaterThan se establezca para las instantáneas y las acciones basadas en la versión de blob. El blob se archivará si se cumplen ambas condiciones.

DateAfterModification

Object

Objeto para definir las condiciones de acción del blob base. Las propiedades daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan y daysAfterCreationGreaterThan son mutuamente excluyentes. La propiedad daysAfterLastTierChangeGreaterThan solo es aplicable a las acciones tierToArchive que requieren que se establezca daysAfterModificationGreaterThan, tampoco se puede usar junto con daysAfterLastAccessTimeGreaterThan o daysAfterCreationGreaterThan.

Nombre	Tipo	Description
daysAfterCreationGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días después de la creación del blob.
daysAfterLastAccessTimeGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días después del último acceso al blob. Esta propiedad solo se puede usar junto con la directiva de seguimiento de hora de último acceso
daysAfterLastTierChangeGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días posteriores a la hora de cambio del último nivel de blob. Esta propiedad solo es aplicable a las acciones tierToArchive y requiere que daysAfterModificationGreaterThan se establezca para las acciones basadas en baseBlobs. El blob se archivará si se cumplen ambas condiciones.
daysAfterModificationGreaterThan	number minimum: 0 multipleOf: 1	Valor que indica la antigüedad en días después de la última modificación

ManagementPolicy

Object

Respuesta de la operación Get Storage Account ManagementPolicies.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.lastModifiedTime	string (date-time)	Devuelve la fecha y hora en que se modificó por última vez ManagementPolicies.
properties.policy	ManagementPolicySchema	Storage Account ManagementPolicy, en formato JSON. Vea más detalles en: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ManagementPolicyAction

Object

Las acciones se aplican a los blobs filtrados cuando se cumple la condición de ejecución.

Nombre	Tipo	Description
baseBlob	ManagementPolicyBaseBlob	Acción de directiva de administración para blob base
snapshot	ManagementPolicySnapShot	Acción de directiva de administración para la instantánea
version	ManagementPolicyVersion	Acción de directiva de administración para la versión

ManagementPolicyBaseBlob

Object

Acción de directiva de administración para el blob base.

Nombre	Tipo	Description
delete	DateAfterModification	Función para eliminar el blob
enableAutoTierToHotFromCool	boolean	Esta propiedad permite el almacenamiento en niveles automático de un blob de acceso esporádico a frecuente en un acceso de blob. Esta propiedad requiere tierToCool.daysAfterLastAccessTimeGreaterThan.
tierToArchive	DateAfterModification	Función para almacenar en capas los blobs para archivar el almacenamiento.
tierToCold	DateAfterModification	Función para almacenar en capas blobs en almacenamiento en frío.
tierToCool	DateAfterModification	Función para almacenar en capas blobs en el almacenamiento esporádico.
tierToHot	DateAfterModification	Función para almacenar en capas blobs en el almacenamiento en caliente. Esta acción solo se puede usar con cuentas de Almacenamiento de blobs en bloques Premium

ManagementPolicyDefinition

Object

Objeto que define la regla de ciclo de vida. Cada definición se compone de un conjunto de filtros y un conjunto de acciones.

Nombre	Tipo	Description
actions	ManagementPolicyAction	Objeto que define el conjunto de acciones.
filters	ManagementPolicyFilter	Objeto que define el conjunto de filtros.

ManagementPolicyFilter

Object

Los filtros limitan las acciones de regla a un subconjunto de blobs dentro de la cuenta de almacenamiento. Si se definen varios filtros, se realiza una and lógica en todos los filtros.

Nombre	Tipo	Description
blobIndexMatch	TagFilter[]	Una matriz de filtros basados en etiquetas de índice de blobs, puede haber como máximo 10 filtros de etiquetas.
blobTypes	string[]	Matriz de valores de enumeración predefinidos. Actualmente blockBlob admite todas las acciones por niveles y eliminación. Solo se admiten acciones de eliminación para appendBlob.
prefixMatch	string[]	Matriz de cadenas para que los prefijos coincidan.

ManagementPolicyName

Enumeración

Nombre de la directiva de administración de cuentas de almacenamiento. Siempre debe ser "predeterminado".

Valor	Description
default

ManagementPolicyRule

Object

Objeto que ajusta la regla de ciclo de vida. Cada regla se define de forma única por nombre.

Nombre	Tipo	Description
definition	ManagementPolicyDefinition	Objeto que define la regla de ciclo de vida.
enabled	boolean	La regla está habilitada si se establece en true.
name	string	Un nombre de regla puede contener cualquier combinación de caracteres alfa numéricos. El nombre de la regla distingue mayúsculas de minúsculas. Debe ser único dentro de una directiva.
type	RuleType	El valor válido es Ciclo de vida.

ManagementPolicySchema

Object

Reglas de administración de cuentas de almacenamientoDirectivas. Vea más detalles en: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

Nombre	Tipo	Description
rules	ManagementPolicyRule[]	Reglas de administración de cuentas de almacenamientoDirectivas. Vea más detalles en: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

ManagementPolicySnapShot

Object

Acción de directiva de administración para la instantánea.

Nombre	Tipo	Description
delete	DateAfterCreation	La función para eliminar la instantánea de blob
tierToArchive	DateAfterCreation	Función para almacenar en capas la instantánea de blob para archivar el almacenamiento.
tierToCold	DateAfterCreation	Función para almacenar en capas blobs en almacenamiento en frío.
tierToCool	DateAfterCreation	Función para almacenar en capas la instantánea de blob en el almacenamiento esporádico.
tierToHot	DateAfterCreation	Función para almacenar en capas blobs en el almacenamiento en caliente. Esta acción solo se puede usar con cuentas de Almacenamiento de blobs en bloques Premium

ManagementPolicyVersion

Object

Acción de directiva de administración para la versión del blob.

Nombre	Tipo	Description
delete	DateAfterCreation	La función para eliminar la versión del blob
tierToArchive	DateAfterCreation	Función para almacenar en capas la versión del blob para archivar el almacenamiento.
tierToCold	DateAfterCreation	Función para almacenar en capas blobs en almacenamiento en frío.
tierToCool	DateAfterCreation	Función para almacenar en capas la versión del blob para el almacenamiento esporádico.
tierToHot	DateAfterCreation	Función para almacenar en capas blobs en el almacenamiento en caliente. Esta acción solo se puede usar con cuentas de Almacenamiento de blobs en bloques Premium

RuleType

Enumeración

El valor válido es Ciclo de vida.

Valor	Description
Lifecycle

TagFilter

Object

Filtrado basado en etiquetas de índice de blobs para objetos de blobs

Nombre	Tipo	Description
name	string minLength: 1 maxLength: 128	Este es el nombre de la etiqueta de filtro, puede tener entre 1 y 128 caracteres.
op	string	Este es el operador de comparación que se usa para la comparación y el filtrado de objetos. Actualmente solo se admite == (operador de igualdad)
value	string minLength: 0 maxLength: 256	Este es el campo de valor de etiqueta de filtro que se usa para el filtrado basado en etiquetas, puede tener entre 0 y 256 caracteres.