Policy interface

Package:

@azure/arm-recoveryservicesdatareplication

Interface representing a Policy.

Methods

beginCreate(string, string, string, PolicyCreateOptionalParams)	Creates the policy.
beginCreateAndWait(string, string, string, PolicyCreateOptionalParams)	Creates the policy.
beginDelete(string, string, string, PolicyDeleteOptionalParams)	Removes the policy.
beginDeleteAndWait(string, string, string, PolicyDeleteOptionalParams)	Removes the policy.
get(string, string, string, PolicyGetOptionalParams)	Gets the details of the policy.
list(string, string, PolicyListOptionalParams)	Gets the list of policies in the given vault.

Method Details

beginCreate(string, string, string, PolicyCreateOptionalParams)

Creates the policy.

function beginCreate(resourceGroupName: string, vaultName: string, policyName: string, options?: PolicyCreateOptionalParams): Promise<SimplePollerLike<OperationState<PolicyModel>, PolicyModel>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

policyName

string

The policy name.

options

PolicyCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PolicyModel>, PolicyModel>>

beginCreateAndWait(string, string, string, PolicyCreateOptionalParams)

Creates the policy.

function beginCreateAndWait(resourceGroupName: string, vaultName: string, policyName: string, options?: PolicyCreateOptionalParams): Promise<PolicyModel>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

policyName

string

The policy name.

options

PolicyCreateOptionalParams

The options parameters.

Returns

Promise<PolicyModel>

beginDelete(string, string, string, PolicyDeleteOptionalParams)

Removes the policy.

function beginDelete(resourceGroupName: string, vaultName: string, policyName: string, options?: PolicyDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PolicyDeleteHeaders>, PolicyDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

policyName

string

The policy name.

options

PolicyDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PolicyDeleteHeaders>, PolicyDeleteHeaders>>

beginDeleteAndWait(string, string, string, PolicyDeleteOptionalParams)

Removes the policy.

function beginDeleteAndWait(resourceGroupName: string, vaultName: string, policyName: string, options?: PolicyDeleteOptionalParams): Promise<PolicyDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

policyName

string

The policy name.

options

PolicyDeleteOptionalParams

The options parameters.

Returns

Promise<PolicyDeleteHeaders>

get(string, string, string, PolicyGetOptionalParams)

Gets the details of the policy.

function get(resourceGroupName: string, vaultName: string, policyName: string, options?: PolicyGetOptionalParams): Promise<PolicyModel>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

policyName

string

The policy name.

options

PolicyGetOptionalParams

The options parameters.

Returns

Promise<PolicyModel>

list(string, string, PolicyListOptionalParams)

Gets the list of policies in the given vault.

function list(resourceGroupName: string, vaultName: string, options?: PolicyListOptionalParams): PagedAsyncIterableIterator<PolicyModel, PolicyModel[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

PolicyListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyModel, PolicyModel[], PageSettings>