Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. storage
  5. getObjectReplicationPolicy
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.storage.getObjectReplicationPolicy

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the object replication policy of the storage account by policy ID. Azure REST API version: 2022-09-01.

Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01.

Using getObjectReplicationPolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getObjectReplicationPolicy(args: GetObjectReplicationPolicyArgs, opts?: InvokeOptions): Promise<GetObjectReplicationPolicyResult>
function getObjectReplicationPolicyOutput(args: GetObjectReplicationPolicyOutputArgs, opts?: InvokeOptions): Output<GetObjectReplicationPolicyResult>
Copy
def get_object_replication_policy(account_name: Optional[str] = None,
                                  object_replication_policy_id: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetObjectReplicationPolicyResult
def get_object_replication_policy_output(account_name: Optional[pulumi.Input[str]] = None,
                                  object_replication_policy_id: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetObjectReplicationPolicyResult]
Copy
func LookupObjectReplicationPolicy(ctx *Context, args *LookupObjectReplicationPolicyArgs, opts ...InvokeOption) (*LookupObjectReplicationPolicyResult, error)
func LookupObjectReplicationPolicyOutput(ctx *Context, args *LookupObjectReplicationPolicyOutputArgs, opts ...InvokeOption) LookupObjectReplicationPolicyResultOutput
Copy

> Note: This function is named LookupObjectReplicationPolicy in the Go SDK.

public static class GetObjectReplicationPolicy 
{
    public static Task<GetObjectReplicationPolicyResult> InvokeAsync(GetObjectReplicationPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectReplicationPolicyResult> Invoke(GetObjectReplicationPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetObjectReplicationPolicyResult> getObjectReplicationPolicy(GetObjectReplicationPolicyArgs args, InvokeOptions options)
public static Output<GetObjectReplicationPolicyResult> getObjectReplicationPolicy(GetObjectReplicationPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storage:getObjectReplicationPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
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.
ObjectReplicationPolicyId
This property is required.
Changes to this property will trigger replacement.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
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.
ObjectReplicationPolicyId
This property is required.
Changes to this property will trigger replacement.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
objectReplicationPolicyId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
objectReplicationPolicyId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
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.
object_replication_policy_id
This property is required.
Changes to this property will trigger replacement.
str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
objectReplicationPolicyId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getObjectReplicationPolicy Result

The following output properties are available:

DestinationAccount string
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
EnabledTime string
Indicates when the policy is enabled on the source account.
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
PolicyId string
A unique id for object replication policy.
SourceAccount string
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Rules List<Pulumi.AzureNative.Storage.Outputs.ObjectReplicationPolicyRuleResponse>
The storage account object replication rules.
DestinationAccount string
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
EnabledTime string
Indicates when the policy is enabled on the source account.
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
PolicyId string
A unique id for object replication policy.
SourceAccount string
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Rules []ObjectReplicationPolicyRuleResponse
The storage account object replication rules.
destinationAccount String
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
enabledTime String
Indicates when the policy is enabled on the source account.
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
policyId String
A unique id for object replication policy.
sourceAccount String
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
rules List<ObjectReplicationPolicyRuleResponse>
The storage account object replication rules.
destinationAccount string
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
enabledTime string
Indicates when the policy is enabled on the source account.
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
policyId string
A unique id for object replication policy.
sourceAccount string
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
rules ObjectReplicationPolicyRuleResponse[]
The storage account object replication rules.
destination_account str
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
enabled_time str
Indicates when the policy is enabled on the source account.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
policy_id str
A unique id for object replication policy.
source_account str
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
rules Sequence[ObjectReplicationPolicyRuleResponse]
The storage account object replication rules.
destinationAccount String
Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.
enabledTime String
Indicates when the policy is enabled on the source account.
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
policyId String
A unique id for object replication policy.
sourceAccount String
Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
rules List<Property Map>
The storage account object replication rules.

Supporting Types

ObjectReplicationPolicyFilterResponse

MinCreationTime string
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
PrefixMatch List<string>
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.
MinCreationTime string
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
PrefixMatch []string
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.
minCreationTime String
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
prefixMatch List<String>
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.
minCreationTime string
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
prefixMatch string[]
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.
min_creation_time str
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
prefix_match Sequence[str]
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.
minCreationTime String
Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z
prefixMatch List<String>
Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.

ObjectReplicationPolicyRuleResponse

DestinationContainer This property is required. string
Required. Destination container name.
SourceContainer This property is required. string
Required. Source container name.
Filters Pulumi.AzureNative.Storage.Inputs.ObjectReplicationPolicyFilterResponse
Optional. An object that defines the filter set.
RuleId string
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.
DestinationContainer This property is required. string
Required. Destination container name.
SourceContainer This property is required. string
Required. Source container name.
Filters ObjectReplicationPolicyFilterResponse
Optional. An object that defines the filter set.
RuleId string
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.
destinationContainer This property is required. String
Required. Destination container name.
sourceContainer This property is required. String
Required. Source container name.
filters ObjectReplicationPolicyFilterResponse
Optional. An object that defines the filter set.
ruleId String
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.
destinationContainer This property is required. string
Required. Destination container name.
sourceContainer This property is required. string
Required. Source container name.
filters ObjectReplicationPolicyFilterResponse
Optional. An object that defines the filter set.
ruleId string
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.
destination_container This property is required. str
Required. Destination container name.
source_container This property is required. str
Required. Source container name.
filters ObjectReplicationPolicyFilterResponse
Optional. An object that defines the filter set.
rule_id str
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.
destinationContainer This property is required. String
Required. Destination container name.
sourceContainer This property is required. String
Required. Source container name.
filters Property Map
Optional. An object that defines the filter set.
ruleId String
Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native