Share via

Policies interface

  • Reference
Package:
@azure/arm-devtestlabs

Interface representing a Policies.

Methods

createOrUpdate(string, string, string, string, Policy, PoliciesCreateOrUpdateOptionalParams)

Create or replace an existing policy.
delete(string, string, string, string, PoliciesDeleteOptionalParams)

Delete policy.
get(string, string, string, string, PoliciesGetOptionalParams)

Get policy.
list(string, string, string, PoliciesListOptionalParams)

List policies in a given policy set.
update(string, string, string, string, PolicyFragment, PoliciesUpdateOptionalParams)

Allows modifying tags of policies. All other properties will be ignored.

Method Details

createOrUpdate(string, string, string, string, Policy, PoliciesCreateOrUpdateOptionalParams)

Create or replace an existing policy.

function createOrUpdate(resourceGroupName: string, labName: string, policySetName: string, name: string, policy: Policy, options?: PoliciesCreateOrUpdateOptionalParams): Promise<Policy>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

policySetName

string

The name of the policy set.

name

string

The name of the policy.

policy
Policy

A Policy.

options
PoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Policy>

delete(string, string, string, string, PoliciesDeleteOptionalParams)

Delete policy.

function delete(resourceGroupName: string, labName: string, policySetName: string, name: string, options?: PoliciesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

policySetName

string

The name of the policy set.

name

string

The name of the policy.

options
PoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, PoliciesGetOptionalParams)

Get policy.

function get(resourceGroupName: string, labName: string, policySetName: string, name: string, options?: PoliciesGetOptionalParams): Promise<Policy>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

policySetName

string

The name of the policy set.

name

string

The name of the policy.

options
PoliciesGetOptionalParams

The options parameters.

Returns

Promise<Policy>

list(string, string, string, PoliciesListOptionalParams)

List policies in a given policy set.

function list(resourceGroupName: string, labName: string, policySetName: string, options?: PoliciesListOptionalParams): PagedAsyncIterableIterator<Policy, Policy[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

policySetName

string

The name of the policy set.

options
PoliciesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Policy, Policy[], PageSettings>

update(string, string, string, string, PolicyFragment, PoliciesUpdateOptionalParams)

Allows modifying tags of policies. All other properties will be ignored.

function update(resourceGroupName: string, labName: string, policySetName: string, name: string, policy: PolicyFragment, options?: PoliciesUpdateOptionalParams): Promise<Policy>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

policySetName

string

The name of the policy set.

name

string

The name of the policy.

policy
PolicyFragment

A Policy.

options
PoliciesUpdateOptionalParams

The options parameters.

Returns

Promise<Policy>