Object Replication Policies - Get

Szolgáltatás:

Storage Resource Provider

API-verzió:

2024-01-01

A tárfiók objektumreplikációs szabályzatának lekérése szabályzatazonosító alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	A tárfiók neve a megadott erőforráscsoporton belül. A tárfiókok nevének 3 és 24 karakter közötti hosszúságúnak kell lennie, és csak számokat és kisbetűket kell használnia.
objectReplicationPolicyId	path	True	string minLength: 1	A célfiók esetében adja meg az "alapértelmezett" értéket. Először konfigurálja a házirendet a célfiókon. A forrásfiókhoz adja meg a célfiókban definiált szabályzat letöltésekor visszaadott szabályzatazonosító értékét. A szabályzat JSON-fájlként lesz letöltve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	A felhasználó előfizetésében lévő erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	ObjectReplicationPolicy	OK – Az objektumreplikációs szabályzat sikeres lekérése.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

StorageAccountGetObjectReplicationPolicies

Mintakérelem

HTTP

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

Java

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

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

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

JavaScript

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

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorResponse	Hibaválasz a tárerőforrás-szolgáltatótól.
ErrorResponseBody	Hibaválasz törzsszerződése.
Metrics	Opcionális. Az objektumreplikációs szabályzat metrikáinak funkciói.
ObjectReplicationPolicy	A két tárfiók közötti replikációs szabályzat. Egy szabályzatban több szabály is definiálható.
ObjectReplicationPolicyFilter	A szűrők a tárfiókban lévő blobok egy részhalmazára korlátozzák a replikációt. A szűrő értékein logikai VAGY művelet történik. Ha több szűrő van definiálva, a rendszer logikai ÉS műveletet hajt végre az összes szűrőn.
ObjectReplicationPolicyRule	A replikációs szabályzat szabálya két tároló között.

ErrorResponse

Objektum

Hibaválasz a tárerőforrás-szolgáltatótól.

Name	Típus	Description
error	ErrorResponseBody	Az Azure Storage erőforrás-szolgáltató hibaválaszának törzse.

ErrorResponseBody

Objektum

Hibaválasz törzsszerződése.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

Metrics

Objektum

Opcionális. Az objektumreplikációs szabályzat metrikáinak funkciói.

Name	Típus	Description
enabled	boolean	Azt jelzi, hogy az objektumreplikációs metrikák funkció engedélyezve van-e a szabályzathoz.

ObjectReplicationPolicy

Objektum

A két tárfiók közötti replikációs szabályzat. Egy szabályzatban több szabály is definiálható.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.destinationAccount	string	Szükséges. Célfiók neve. Teljes erőforrás-azonosítónak kell lennie, ha az allowCrossTenantReplication értéke hamis.
properties.enabledTime	string (date-time)	Azt jelzi, hogy a szabályzat mikor van engedélyezve a forrásfiókban.
properties.metrics	Metrics	Opcionális. Az objektumreplikációs szabályzat metrikáinak funkciói.
properties.policyId	string	Az objektumreplikációs szabályzat egyedi azonosítója.
properties.rules	ObjectReplicationPolicyRule[]	A tárfiók objektumreplikációs szabályai.
properties.sourceAccount	string	Szükséges. Forrásfiók neve. Teljes erőforrás-azonosítónak kell lennie, ha az allowCrossTenantReplication értéke hamis.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ObjectReplicationPolicyFilter

Objektum

A szűrők a tárfiókban lévő blobok egy részhalmazára korlátozzák a replikációt. A szűrő értékein logikai VAGY művelet történik. Ha több szűrő van definiálva, a rendszer logikai ÉS műveletet hajt végre az összes szűrőn.

Name	Típus	Description
minCreationTime	string	Az idő után létrehozott blobok replikálódnak a célhelyre. Dátum/idő formátumban kell lennie: "yyyy-MM-ddTHH:mm:ssZ". Példa: 2020-02-19T16:05:00Z
prefixMatch	string[]	Opcionális. Szűri az eredményeket, hogy csak olyan blobokat replikáljon, amelyek neve a megadott előtaggal kezdődik.

ObjectReplicationPolicyRule

Objektum

A replikációs szabályzat szabálya két tároló között.

Name	Típus	Description
destinationContainer	string	Szükséges. Céltároló neve.
filters	ObjectReplicationPolicyFilter	Opcionális. A szűrőkészletet meghatározó objektum.
ruleId	string	A rendszer automatikusan létrehozza a szabályazonosítót a célfiók minden új szabályához. A szabályzat forrásfiókra való helyezéséhez szükséges.
sourceContainer	string	Szükséges. Forrástároló neve.