Package version:

Interface ObjectReplicationPoliciesOperations

Interface representing a ObjectReplicationPoliciesOperations.

interface ObjectReplicationPoliciesOperations {
    createOrUpdate(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, properties: ObjectReplicationPolicy, options?: ObjectReplicationPoliciesCreateOrUpdateOptionalParams): Promise<ObjectReplicationPolicy>;
    delete(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, options?: ObjectReplicationPoliciesDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, options?: ObjectReplicationPoliciesGetOptionalParams): Promise<ObjectReplicationPolicy>;
    list(resourceGroupName: string, accountName: string, options?: ObjectReplicationPoliciesListOptionalParams): PagedAsyncIterableIterator<ObjectReplicationPolicy>;
}

Methods

createOrUpdate(resourceGroupName, accountName, objectReplicationPolicyId, properties, options?): Promise<ObjectReplicationPolicy>
Create or update the object replication policy of the storage account.
Parameters
- resourceGroupName: string
  The name of the resource group within the user's subscription. The name is case insensitive.
- accountName: 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: 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.
- properties: ObjectReplicationPolicy
  The object replication policy set to a storage account. A unique policy ID will be created if absent.
- Optionaloptions: ObjectReplicationPoliciesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ObjectReplicationPolicy>
- Defined in operationsInterfaces/objectReplicationPoliciesOperations.ts:71

delete(resourceGroupName, accountName, objectReplicationPolicyId, options?): Promise<void>
Deletes the object replication policy associated with the specified storage account.
Parameters
- resourceGroupName: string
  The name of the resource group within the user's subscription. The name is case insensitive.
- accountName: 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: 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.
- Optionaloptions: ObjectReplicationPoliciesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/objectReplicationPoliciesOperations.ts:91

get(resourceGroupName, accountName, objectReplicationPolicyId, options?): Promise<ObjectReplicationPolicy>
Get the object replication policy of the storage account by policy ID.
Parameters
- resourceGroupName: string
  The name of the resource group within the user's subscription. The name is case insensitive.
- accountName: 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: 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.
- Optionaloptions: ObjectReplicationPoliciesGetOptionalParams
  The options parameters.
Returns Promise<ObjectReplicationPolicy>
- Defined in operationsInterfaces/objectReplicationPoliciesOperations.ts:50

list(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<ObjectReplicationPolicy>
List the object replication policies associated with the storage account.
Parameters
- resourceGroupName: string
  The name of the resource group within the user's subscription. The name is case insensitive.
- accountName: 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.
- Optionaloptions: ObjectReplicationPoliciesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ObjectReplicationPolicy>
- Defined in operationsInterfaces/objectReplicationPoliciesOperations.ts:32