PolicySetDefinitionsOperations Class

PolicySetDefinitionsOperations async 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.

Inheritance
builtins.object
PolicySetDefinitionsOperations

Constructor

PolicySetDefinitionsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

create_or_update

Creates or updates a policy set definition.

This operation creates or updates a policy set definition in the given subscription with the given name.

create_or_update_at_management_group

Creates or updates a policy set definition.

This operation creates or updates a policy set definition in the given management group with the given name.

delete

Deletes a policy set definition.

This operation deletes the policy set definition in the given subscription with the given name.

delete_at_management_group

Deletes a policy set definition.

This operation deletes the policy set definition in the given management group with the given name.

get

Retrieves a policy set definition.

This operation retrieves the policy set definition in the given subscription with the given name.

get_at_management_group

Retrieves a policy set definition.

This operation retrieves the policy set definition in the given management group with the given name.

get_built_in

Retrieves a built in policy set definition.

This operation retrieves the built-in policy set definition with the given name.

list

Retrieves the policy set definitions for a subscription.

This operation retrieves a list of all the policy set definitions in the given subscription.

list_built_in

Retrieves built-in policy set definitions.

This operation retrieves a list of all the built-in policy set definitions.

list_by_management_group

Retrieves all policy set definitions in management group.

This operation retrieves a list of all the a policy set definition in the given management group.

create_or_update

Creates or updates a policy set definition.

This operation creates or updates a policy set definition in the given subscription with the given name.

async create_or_update(policy_set_definition_name: str, parameters: azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition, **kwargs: Any) -> azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to create.

parameters
PolicySetDefinition
Required

The policy set definition properties.

cls
callable

A custom type or function that will be passed the direct response

Returns

PolicySetDefinition, or the result of cls(response)

Return type

Exceptions

create_or_update_at_management_group

Creates or updates a policy set definition.

This operation creates or updates a policy set definition in the given management group with the given name.

async create_or_update_at_management_group(policy_set_definition_name: str, management_group_id: str, parameters: azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition, **kwargs: Any) -> azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to create.

management_group_id
str
Required

The ID of the management group.

parameters
PolicySetDefinition
Required

The policy set definition properties.

cls
callable

A custom type or function that will be passed the direct response

Returns

PolicySetDefinition, or the result of cls(response)

Return type

Exceptions

delete

Deletes a policy set definition.

This operation deletes the policy set definition in the given subscription with the given name.

async delete(policy_set_definition_name: str, **kwargs: Any) -> None

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

delete_at_management_group

Deletes a policy set definition.

This operation deletes the policy set definition in the given management group with the given name.

async delete_at_management_group(policy_set_definition_name: str, management_group_id: str, **kwargs: Any) -> None

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to delete.

management_group_id
str
Required

The ID of the management group.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Retrieves a policy set definition.

This operation retrieves the policy set definition in the given subscription with the given name.

async get(policy_set_definition_name: str, **kwargs: Any) -> azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

PolicySetDefinition, or the result of cls(response)

Return type

Exceptions

get_at_management_group

Retrieves a policy set definition.

This operation retrieves the policy set definition in the given management group with the given name.

async get_at_management_group(policy_set_definition_name: str, management_group_id: str, **kwargs: Any) -> azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to get.

management_group_id
str
Required

The ID of the management group.

cls
callable

A custom type or function that will be passed the direct response

Returns

PolicySetDefinition, or the result of cls(response)

Return type

Exceptions

get_built_in

Retrieves a built in policy set definition.

This operation retrieves the built-in policy set definition with the given name.

async get_built_in(policy_set_definition_name: str, **kwargs: Any) -> azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinition

Parameters

policy_set_definition_name
str
Required

The name of the policy set definition to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

PolicySetDefinition, or the result of cls(response)

Return type

Exceptions

list

Retrieves the policy set definitions for a subscription.

This operation retrieves a list of all the policy set definitions in the given subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinitionListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_built_in

Retrieves built-in policy set definitions.

This operation retrieves a list of all the built-in policy set definitions.

list_built_in(**kwargs: Any) -> AsyncIterable[azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinitionListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_by_management_group

Retrieves all policy set definitions in management group.

This operation retrieves a list of all the a policy set definition in the given management group.

list_by_management_group(management_group_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.resource.policy.v2018_03_01.models._models_py3.PolicySetDefinitionListResult]

Parameters

management_group_id
str
Required

The ID of the management group.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.resource.policy.v2018_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2018_03_01\\models\\__init__.py'>