Share via


StorageAccountResource.GetObjectReplicationPolicyAsync Method

Definition

Get the object replication policy of the storage account by policy ID.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}
  • Operation Id: ObjectReplicationPolicies_Get
  • Default Api Version: 2023-05-01
  • Resource: ObjectReplicationPolicyResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.ObjectReplicationPolicyResource>> GetObjectReplicationPolicyAsync (string objectReplicationPolicyId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetObjectReplicationPolicyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.ObjectReplicationPolicyResource>>
override this.GetObjectReplicationPolicyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.ObjectReplicationPolicyResource>>
Public Overridable Function GetObjectReplicationPolicyAsync (objectReplicationPolicyId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ObjectReplicationPolicyResource))

Parameters

objectReplicationPolicyId
String

For the destination account, provide the value 'default'. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

objectReplicationPolicyId is null.

objectReplicationPolicyId is an empty string, and was expected to be non-empty.

Applies to