通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PolicyDefinitionsOperations 类

  • 参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

PolicyClient的

<xref:policy_definitions> 属性。

继承
builtins.object
PolicyDefinitionsOperations

构造函数

PolicyDefinitionsOperations(*args, **kwargs)

方法

create_or_update

在订阅中创建或更新策略定义。

此操作在给定订阅中创建或更新具有给定名称的策略定义。
create_or_update_at_management_group

在管理组中创建或更新策略定义。

此操作在给定管理组中创建或更新具有给定名称的策略定义。
delete

删除订阅中的策略定义。

此操作会删除具有给定名称的给定订阅中的策略定义。
delete_at_management_group

删除管理组中的策略定义。

此操作删除具有给定名称的给定管理组中的策略定义。
get

检索订阅中的策略定义。

此操作检索具有给定名称的给定订阅中的策略定义。
get_at_management_group

检索管理组中的策略定义。

此操作检索具有给定名称的给定管理组中的策略定义。
get_built_in

检索内置策略定义。

此操作检索具有给定名称的内置策略定义。
list

检索订阅中的策略定义。

此操作检索给定订阅中与可选给定$filter匹配的所有策略定义的列表。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则未筛选列表包括与订阅关联的所有策略定义，包括直接应用或来自包含给定订阅的管理组的策略定义。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定订阅中的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。
list_built_in

检索内置策略定义。

此操作检索与可选给定$filter匹配的所有内置策略定义的列表。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有内置策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包含其类别与 {value} 匹配的所有内置策略定义。
list_by_management_group

检索管理组中的策略定义。

此操作检索给定管理组中与可选给定$filter匹配的所有策略定义的列表。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则未筛选列表包括与管理组关联的所有策略定义，包括直接应用或来自包含给定管理组的管理组的策略定义。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定管理组中的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。

create_or_update

在订阅中创建或更新策略定义。

此操作在给定订阅中创建或更新具有给定名称的策略定义。

create_or_update(policy_definition_name: str, parameters: _models.PolicyDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyDefinition

参数

policy_definition_name
str
必需

要创建的策略定义的名称。 必需。

parameters
PolicyDefinition 或 IO
必需

策略定义属性。 是 PolicyDefinition 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyDefinition 或 cls 的结果 (响应)

返回类型

PolicyDefinition

例外

HttpResponseError

create_or_update_at_management_group

在管理组中创建或更新策略定义。

此操作在给定管理组中创建或更新具有给定名称的策略定义。

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

参数

policy_definition_name
str
必需

要创建的策略定义的名称。 必需。

management_group_id
str
必需

管理组的 ID。 必需。

parameters
PolicyDefinition 或 IO
必需

策略定义属性。 是 PolicyDefinition 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyDefinition 或 cls 的结果 (响应)

返回类型

PolicyDefinition

例外

HttpResponseError

delete

删除订阅中的策略定义。

此操作会删除具有给定名称的给定订阅中的策略定义。

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

参数

policy_definition_name
str
必需

要删除的策略定义的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

delete_at_management_group

删除管理组中的策略定义。

此操作删除具有给定名称的给定管理组中的策略定义。

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

参数

policy_definition_name
str
必需

要删除的策略定义的名称。 必需。

management_group_id
str
必需

管理组的 ID。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

get

检索订阅中的策略定义。

此操作检索具有给定名称的给定订阅中的策略定义。

get(policy_definition_name: str, **kwargs: Any) -> PolicyDefinition

参数

policy_definition_name
str
必需

要获取的策略定义的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyDefinition 或 cls 的结果 (响应)

返回类型

PolicyDefinition

例外

HttpResponseError

get_at_management_group

检索管理组中的策略定义。

此操作检索具有给定名称的给定管理组中的策略定义。

get_at_management_group(policy_definition_name: str, management_group_id: str, **kwargs: Any) -> PolicyDefinition

参数

policy_definition_name
str
必需

要获取的策略定义的名称。 必需。

management_group_id
str
必需

管理组的 ID。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyDefinition 或 cls 的结果 (响应)

返回类型

PolicyDefinition

例外

HttpResponseError

get_built_in

检索内置策略定义。

此操作检索具有给定名称的内置策略定义。

get_built_in(policy_definition_name: str, **kwargs: Any) -> PolicyDefinition

参数

policy_definition_name
str
必需

要获取的内置策略定义的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyDefinition 或 cls 的结果 (响应)

返回类型

PolicyDefinition

例外

HttpResponseError

list

检索订阅中的策略定义。

此操作检索给定订阅中与可选给定$filter匹配的所有策略定义的列表。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则未筛选列表包括与订阅关联的所有策略定义，包括直接应用或来自包含给定订阅的管理组的策略定义。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定订阅中的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。

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

参数

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则不执行筛选。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定范围内的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。 默认值为 None。

top
int
必需

要返回的最大记录数。 如果未提供$top筛选器，它将返回 500 条记录。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，如 PolicyDefinition 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[PolicyDefinition]

例外

HttpResponseError

list_built_in

检索内置策略定义。

此操作检索与可选给定$filter匹配的所有内置策略定义的列表。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有内置策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包含其类别与 {value} 匹配的所有内置策略定义。

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

参数

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则不执行筛选。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定范围内的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。 默认值为 None。

top
int
必需

要返回的最大记录数。 如果未提供$top筛选器，它将返回 500 条记录。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，如 PolicyDefinition 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[PolicyDefinition]

例外

HttpResponseError

list_by_management_group

检索管理组中的策略定义。

此操作检索给定管理组中与可选给定$filter匹配的所有策略定义的列表。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则未筛选列表包括与管理组关联的所有策略定义，包括直接应用或来自包含给定管理组的管理组的策略定义。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定管理组中的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。

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

参数

management_group_id
str
必需

管理组的 ID。 必需。

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atExactScope () ”、“policyType -eq {value}”或“category eq'{value}”。 如果未提供$filter，则不执行筛选。 如果提供了 $filter=atExactScope () ，则返回的列表仅包含给定范围内的所有策略定义。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包括其类别与 {value} 匹配的所有策略定义。 默认值为 None。

top
int
必需

要返回的最大记录数。 如果未提供$top筛选器，它将返回 500 条记录。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，如 PolicyDefinition 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[PolicyDefinition]

例外

HttpResponseError

属性

models 

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