Object Replication Policies - Get

Referencia

Servicio:: Storage Resource Provider

Versión de la API:: 2024-01-01

Obtenga la directiva de replicación de objetos de la cuenta de almacenamiento por identificador de directiva.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}?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.
objectReplicationPolicyId	path	True	string minLength: 1	Para la cuenta de destino, proporcione el valor "default". Configure primero la directiva en la cuenta de destino. Para la cuenta de origen, proporcione el valor del identificador de directiva que se devuelve al descargar la directiva definida en la cuenta de destino. La directiva se descarga como un archivo JSON.
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	ObjectReplicationPolicy	Correcto: obtenga correctamente la directiva de replicación de objetos.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operació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

StorageAccountGetObjectReplicationPolicies

Solicitud de ejemplo

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


/**
 * Samples for ObjectReplicationPoliciesOperation Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/
     * StorageAccountGetObjectReplicationPolicy.json
     */
    /**
     * Sample code: StorageAccountGetObjectReplicationPolicies.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        storageAccountGetObjectReplicationPolicies(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getObjectReplicationPoliciesOperations()
            .getWithResponse("res6977", "sto2527", "{objectReplicationPolicy-Id}", 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

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_object_replication_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.object_replication_policies.get(
        resource_group_name="res6977",
        account_name="sto2527",
        object_replication_policy_id="{objectReplicationPolicy-Id}",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetObjectReplicationPolicy.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

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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetObjectReplicationPolicy.json
func ExampleObjectReplicationPoliciesClient_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.NewObjectReplicationPoliciesClient().Get(ctx, "res6977", "sto2527", "{objectReplicationPolicy-Id}", 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.ObjectReplicationPolicy = armstorage.ObjectReplicationPolicy{
	// 	Name: to.Ptr("{objectReplicationPolicy-Id}"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/objectReplicationPolicies"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/objectReplicationPolicies/{objectReplicationPolicy-Id}"),
	// 	Properties: &armstorage.ObjectReplicationPolicyProperties{
	// 		DestinationAccount: to.Ptr("destAccount1"),
	// 		EnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-08T03:01:55.716Z"); return t}()),
	// 		Metrics: &armstorage.ObjectReplicationPolicyPropertiesMetrics{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		PolicyID: to.Ptr("{objectReplicationPolicy-Id}"),
	// 		Rules: []*armstorage.ObjectReplicationPolicyRule{
	// 			{
	// 				DestinationContainer: to.Ptr("destContainer1"),
	// 				Filters: &armstorage.ObjectReplicationPolicyFilter{
	// 					PrefixMatch: []*string{
	// 						to.Ptr("blobA"),
	// 						to.Ptr("blobB")},
	// 					},
	// 					SourceContainer: to.Ptr("sourceContainer1"),
	// 				},
	// 				{
	// 					DestinationContainer: to.Ptr("destContainer1"),
	// 					Filters: &armstorage.ObjectReplicationPolicyFilter{
	// 						PrefixMatch: []*string{
	// 							to.Ptr("blobC"),
	// 							to.Ptr("blobD")},
	// 						},
	// 						SourceContainer: to.Ptr("sourceContainer1"),
	// 				}},
	// 				SourceAccount: to.Ptr("sto2527"),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the object replication policy of the storage account by policy ID.
 *
 * @summary Get the object replication policy of the storage account by policy ID.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetObjectReplicationPolicy.json
 */
async function storageAccountGetObjectReplicationPolicies() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
  const accountName = "sto2527";
  const objectReplicationPolicyId = "{objectReplicationPolicy-Id}";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.objectReplicationPoliciesOperations.get(
    resourceGroupName,
    accountName,
    objectReplicationPolicyId,
  );
  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

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/StorageAccountGetObjectReplicationPolicy.json
// this example is just showing the usage of "ObjectReplicationPolicies_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 ObjectReplicationPolicyResource created on azure
// for more information of creating ObjectReplicationPolicyResource, please refer to the document of ObjectReplicationPolicyResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res6977";
string accountName = "sto2527";
string objectReplicationPolicyId = "{objectReplicationPolicy-Id}";
ResourceIdentifier objectReplicationPolicyResourceId = ObjectReplicationPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, objectReplicationPolicyId);
ObjectReplicationPolicyResource objectReplicationPolicy = client.GetObjectReplicationPolicyResource(objectReplicationPolicyResourceId);

// invoke the operation
ObjectReplicationPolicyResource result = await objectReplicationPolicy.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
ObjectReplicationPolicyData 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/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/objectReplicationPolicies/{objectReplicationPolicy-Id}",
  "name": "{objectReplicationPolicy-Id}",
  "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies",
  "properties": {
    "policyId": "{objectReplicationPolicy-Id}",
    "enabledTime": "2019-06-08T03:01:55.7168089Z",
    "sourceAccount": "sto2527",
    "destinationAccount": "destAccount1",
    "rules": [
      {
        "sourceContainer": "sourceContainer1",
        "destinationContainer": "destContainer1",
        "filters": {
          "prefixMatch": [
            "blobA",
            "blobB"
          ]
        }
      },
      {
        "sourceContainer": "sourceContainer1",
        "destinationContainer": "destContainer1",
        "filters": {
          "prefixMatch": [
            "blobC",
            "blobD"
          ]
        }
      }
    ],
    "metrics": {
      "enabled": true
    }
  }
}

Definiciones

Nombre	Description
ErrorResponse	Respuesta de error del proveedor de recursos de almacenamiento.
ErrorResponseBody	Contrato del cuerpo de respuesta de error.
Metrics	Opcional. Opciones de características de métricas de directiva de replicación de objetos.
ObjectReplicationPolicy	Directiva de replicación entre dos cuentas de almacenamiento. Se pueden definir varias reglas en una directiva.
ObjectReplicationPolicyFilter	Los filtros limitan la replicación a un subconjunto de blobs dentro de la cuenta de almacenamiento. Un OR lógico se realiza en los valores del filtro. Si se definen varios filtros, se realiza una and lógica en todos los filtros.
ObjectReplicationPolicyRule	Regla de directiva de replicación entre dos contenedores.

ErrorResponse

Object

Respuesta de error del proveedor de recursos de almacenamiento.

Nombre	Tipo	Description
error	ErrorResponseBody	Cuerpo de respuesta de error del proveedor de recursos de Azure Storage.

ErrorResponseBody

Object

Contrato del cuerpo de respuesta de error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

Metrics

Object

Opcional. Opciones de características de métricas de directiva de replicación de objetos.

Nombre	Tipo	Description
enabled	boolean	Indica si la característica de métricas de replicación de objetos está habilitada para la directiva.

ObjectReplicationPolicy

Object

Directiva de replicación entre dos cuentas de almacenamiento. Se pueden definir varias reglas en una directiva.

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.destinationAccount	string	Obligatorio. Nombre de la cuenta de destino. Debe ser el identificador de recurso completo si allowCrossTenantReplication se establece en false.
properties.enabledTime	string (date-time)	Indica cuándo está habilitada la directiva en la cuenta de origen.
properties.metrics	Metrics	Opcional. Opciones de características de métricas de directiva de replicación de objetos.
properties.policyId	string	Identificador único para la directiva de replicación de objetos.
properties.rules	ObjectReplicationPolicyRule[]	Reglas de replicación de objetos de cuenta de almacenamiento.
properties.sourceAccount	string	Obligatorio. Nombre de la cuenta de origen. Debe ser el identificador de recurso completo si allowCrossTenantReplication se establece en false.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ObjectReplicationPolicyFilter

Object

Los filtros limitan la replicación a un subconjunto de blobs dentro de la cuenta de almacenamiento. Un OR lógico se realiza en los valores del filtro. Si se definen varios filtros, se realiza una and lógica en todos los filtros.

Nombre	Tipo	Description
minCreationTime	string	Los blobs creados después del tiempo se replicarán en el destino. Debe estar en formato datetime 'aaaa-MM-ddTHH:mm:ssZ'. Ejemplo: 2020-02-19T16:05:00Z
prefixMatch	string[]	Opcional. Filtra los resultados para replicar solo blobs cuyos nombres comienzan con el prefijo especificado.

ObjectReplicationPolicyRule

Object

Regla de directiva de replicación entre dos contenedores.

Nombre	Tipo	Description
destinationContainer	string	Obligatorio. Nombre del contenedor de destino.
filters	ObjectReplicationPolicyFilter	Opcional. Objeto que define el conjunto de filtros.
ruleId	string	El identificador de regla se genera automáticamente para cada nueva regla en la cuenta de destino. Se requiere para colocar la directiva en la cuenta de origen.
sourceContainer	string	Obligatorio. Nombre del contenedor de origen.