PoliciesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DevTestLabsClient's

<xref:policies> attribute.

Constructor

PoliciesOperations(*args, **kwargs)

Methods

create_or_update

Create or replace an existing policy.
delete

Delete policy.
get

Get policy.
list

List policies in a given policy set.
update

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

create_or_update

Create or replace an existing policy.

async create_or_update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, policy: _models.Policy, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Policy

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
policy_set_name
Required
str

The name of the policy set. Required.
name
Required
str

The name of the policy. Required.
policy
Required
Policy or IO[bytes]

A Policy. Is either a Policy type or a IO[bytes] type. Required.

Returns

Type Description
Policy

Policy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete policy.

async delete(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
policy_set_name
Required
str

The name of the policy set. Required.
name
Required
str

The name of the policy. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get policy.

async get(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, expand: str | None = None, **kwargs: Any) -> Policy

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
policy_set_name
Required
str

The name of the policy set. Required.
name
Required
str

The name of the policy. Required.
expand
str

Specify the $expand query. Example: 'properties($select=description)'. Default value is None.

Default value: None

Returns

Type Description
Policy

Policy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List policies in a given policy set.

list(resource_group_name: str, lab_name: str, policy_set_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> AsyncItemPaged[Policy]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
policy_set_name
Required
str

The name of the policy set. Required.
expand
str

Specify the $expand query. Example: 'properties($select=description)'. Default value is None.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[Policy]

An iterator like instance of either Policy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

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

async update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> Policy

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
policy_set_name
Required
str

The name of the policy set. Required.
name
Required
str

The name of the policy. Required.
tags
dict[str, str]

The tags of the resource. Default value is None.

Default value: None

Returns

Type Description
Policy

Policy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>