Share via

PolicySetDefinitionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

PolicyClient's

<xref:policy_set_definitions> attribute.

Inheritance
builtins.object
PolicySetDefinitionsOperations

Constructor

PolicySetDefinitionsOperations(*args, **kwargs)

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 a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
list_built_in

Retrieves built-in policy set definitions.

This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.
list_by_management_group

Retrieves all policy set definitions in management group.

This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

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(policy_set_definition_name: str, parameters: _models.PolicySetDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicySetDefinition

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to create. Required.
parameters
Required
PolicySetDefinition or IO[bytes]

The policy set definition properties. Is either a PolicySetDefinition type or a IO[bytes] type. Required.

Returns

Type Description
PolicySetDefinition

PolicySetDefinition or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.

create_or_update_at_management_group(policy_set_definition_name: str, management_group_id: str, parameters: _models.PolicySetDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicySetDefinition

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to create. Required.
management_group_id
Required
str

The ID of the management group. Required.
parameters
Required
PolicySetDefinition or IO[bytes]

The policy set definition properties. Is either a PolicySetDefinition type or a IO[bytes] type. Required.

Returns

Type Description
PolicySetDefinition

PolicySetDefinition or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a policy set definition.

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

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

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to delete. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.

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

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to delete. Required.
management_group_id
Required
str

The ID of the management group. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves a policy set definition.

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

get(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to get. Required.

Returns

Type Description
PolicySetDefinition

PolicySetDefinition or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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_at_management_group(policy_set_definition_name: str, management_group_id: str, **kwargs: Any) -> PolicySetDefinition

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to get. Required.
management_group_id
Required
str

The ID of the management group. Required.

Returns

Type Description
PolicySetDefinition

PolicySetDefinition or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_built_in

Retrieves a built in policy set definition.

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

get_built_in(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition

Parameters

Name Description
policy_set_definition_name
Required
str

The name of the policy set definition to get. Required.

Returns

Type Description
PolicySetDefinition

PolicySetDefinition or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Retrieves the policy set definitions for a subscription.

This operation retrieves a list of all the policy set definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicySetDefinition]

Parameters

Name Description
filter
Required
str

The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. Default value is None.
top
Required
int

Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns

Type Description
ItemPaged[PolicySetDefinition]

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

Exceptions

Type Description
HttpResponseError

list_built_in

Retrieves built-in policy set definitions.

This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.

list_built_in(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicySetDefinition]

Parameters

Name Description
filter
Required
str

The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. Default value is None.
top
Required
int

Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns

Type Description
ItemPaged[PolicySetDefinition]

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

Exceptions

Type Description
HttpResponseError

list_by_management_group

Retrieves all policy set definitions in management group.

This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

list_by_management_group(management_group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicySetDefinition]

Parameters

Name Description
management_group_id
Required
str

The ID of the management group. Required.
filter
Required
str

The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. Default value is None.
top
Required
int

Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns

Type Description
ItemPaged[PolicySetDefinition]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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