PoliciesOperations Class
PoliciesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
Constructor
PoliciesOperations(client, config, serializer, deserializer)
Parameters
Name | Description |
---|---|
client
Required
|
Client for service requests. |
config
Required
|
Configuration of service client. |
serializer
Required
|
An object model serializer. |
deserializer
Required
|
An object model deserializer. |
Variables
Name | Description |
---|---|
models
|
Alias to model classes used in this operation group. |
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.
create_or_update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, policy: '_models.Policy', **kwargs: Any) -> _models.Policy
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. |
lab_name
Required
|
The name of the lab. |
policy_set_name
Required
|
The name of the policy set. |
name
Required
|
The name of the policy. |
policy
Required
|
A Policy. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Policy, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete
Delete policy.
delete(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. |
lab_name
Required
|
The name of the lab. |
policy_set_name
Required
|
The name of the policy set. |
name
Required
|
The name of the policy. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
None, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Get policy.
get(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, expand: str | None = None, **kwargs: Any) -> _models.Policy
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. |
lab_name
Required
|
The name of the lab. |
policy_set_name
Required
|
The name of the policy set. |
name
Required
|
The name of the policy. |
expand
Required
|
Specify the $expand query. Example: 'properties($select=description)'. Default value: None
|
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Policy, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> Iterable['_models.PolicyList']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. |
lab_name
Required
|
The name of the lab. |
policy_set_name
Required
|
The name of the policy set. |
expand
Required
|
Specify the $expand query. Example: 'properties($select=description)'. Default value: None
|
filter
Required
|
The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value: None
|
top
Required
|
The maximum number of resources to return from the operation. Example: '$top=10'. Default value: None
|
orderby
Required
|
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value: None
|
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either PolicyList or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update
Allows modifying tags of policies. All other properties will be ignored.
update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, policy: '_models.PolicyFragment', **kwargs: Any) -> _models.Policy
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. |
lab_name
Required
|
The name of the lab. |
policy_set_name
Required
|
The name of the policy set. |
name
Required
|
The name of the policy. |
policy
Required
|
A Policy. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Policy, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>
Azure SDK for Python