ObjectReplicationPoliciesOperations interface
Interface representing a ObjectReplicationPoliciesOperations.
Methods
| create |
Create or update the object replication policy of the storage account. |
| delete(string, string, string, Object |
Deletes the object replication policy associated with the specified storage account. |
| get(string, string, string, Object |
Get the object replication policy of the storage account by policy ID. |
| list(string, string, Object |
List the object replication policies associated with the storage account. |
Method Details
createOrUpdate(string, string, string, ObjectReplicationPolicy, ObjectReplicationPoliciesCreateOrUpdateOptionalParams)
Create or update the object replication policy of the storage account.
function createOrUpdate(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, properties: ObjectReplicationPolicy, options?: ObjectReplicationPoliciesCreateOrUpdateOptionalParams): Promise<ObjectReplicationPolicy>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.
The options parameters.
Returns
Promise<ObjectReplicationPolicy>
delete(string, string, string, ObjectReplicationPoliciesDeleteOptionalParams)
Deletes the object replication policy associated with the specified storage account.
function delete(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, options?: ObjectReplicationPoliciesDeleteOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
get(string, string, string, ObjectReplicationPoliciesGetOptionalParams)
Get the object replication policy of the storage account by policy ID.
function get(resourceGroupName: string, accountName: string, objectReplicationPolicyId: string, options?: ObjectReplicationPoliciesGetOptionalParams): Promise<ObjectReplicationPolicy>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.
The options parameters.
Returns
Promise<ObjectReplicationPolicy>
list(string, string, ObjectReplicationPoliciesListOptionalParams)
List the object replication policies associated with the storage account.
function list(resourceGroupName: string, accountName: string, options?: ObjectReplicationPoliciesListOptionalParams): PagedAsyncIterableIterator<ObjectReplicationPolicy, ObjectReplicationPolicy[], PageSettings>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.
The options parameters.