你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
PolicyDefinitions interface
表示 PolicyDefinitions 的接口。
方法
| create |
此操作在给定订阅中创建或更新具有给定名称的策略定义。 |
| create |
此操作在给定管理组中创建或更新具有给定名称的策略定义。 |
| delete(string, Policy |
此操作会删除具有给定名称的给定订阅中的策略定义。 |
| delete |
此操作删除具有给定名称的给定管理组中的策略定义。 |
| get(string, Policy |
此操作检索具有给定名称的给定订阅中的策略定义。 |
| get |
此操作检索具有给定名称的给定管理组中的策略定义。 |
| get |
此操作检索具有给定名称的内置策略定义。 |
| list(Policy |
此操作检索给定订阅中与可选给定$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匹配的所有内置策略定义的列表。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有内置策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包含其类别与 {value} 匹配的所有内置策略定义。 |
| 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} 匹配的所有策略定义。 |
方法详细信息
createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)
此操作在给定订阅中创建或更新具有给定名称的策略定义。
function createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateOptionalParams): Promise<PolicyDefinition>参数
- policyDefinitionName
-
string
要创建的策略定义的名称。
- parameters
- PolicyDefinition
策略定义属性。
选项参数。
返回
Promise<PolicyDefinition>
createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)
此操作在给定管理组中创建或更新具有给定名称的策略定义。
function createOrUpdateAtManagementGroup(policyDefinitionName: string, managementGroupId: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicyDefinition>参数
- policyDefinitionName
-
string
要创建的策略定义的名称。
- managementGroupId
-
string
管理组的 ID。
- parameters
- PolicyDefinition
策略定义属性。
返回
Promise<PolicyDefinition>
delete(string, PolicyDefinitionsDeleteOptionalParams)
此操作会删除具有给定名称的给定订阅中的策略定义。
function delete(policyDefinitionName: string, options?: PolicyDefinitionsDeleteOptionalParams): Promise<void>参数
- policyDefinitionName
-
string
要删除的策略定义的名称。
选项参数。
返回
Promise<void>
deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)
此操作删除具有给定名称的给定管理组中的策略定义。
function deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>参数
- policyDefinitionName
-
string
要删除的策略定义的名称。
- managementGroupId
-
string
管理组的 ID。
选项参数。
返回
Promise<void>
get(string, PolicyDefinitionsGetOptionalParams)
此操作检索具有给定名称的给定订阅中的策略定义。
function get(policyDefinitionName: string, options?: PolicyDefinitionsGetOptionalParams): Promise<PolicyDefinition>参数
- policyDefinitionName
-
string
要获取的策略定义的名称。
选项参数。
返回
Promise<PolicyDefinition>
getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)
此操作检索具有给定名称的给定管理组中的策略定义。
function getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicyDefinition>参数
- policyDefinitionName
-
string
要获取的策略定义的名称。
- managementGroupId
-
string
管理组的 ID。
选项参数。
返回
Promise<PolicyDefinition>
getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)
此操作检索具有给定名称的内置策略定义。
function getBuiltIn(policyDefinitionName: string, options?: PolicyDefinitionsGetBuiltInOptionalParams): Promise<PolicyDefinition>参数
- policyDefinitionName
-
string
要获取的内置策略定义的名称。
选项参数。
返回
Promise<PolicyDefinition>
list(PolicyDefinitionsListOptionalParams)
此操作检索给定订阅中与可选给定$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} 匹配的所有策略定义。
function list(options?: PolicyDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>参数
选项参数。
返回
listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)
此操作检索与可选给定$filter匹配的所有内置策略定义的列表。 如果提供了 $filter='policyType -eq {value}'，则返回的列表仅包含其类型与 {value} 匹配的所有内置策略定义。 可能的 policyType 值为 NotSpecified、BuiltIn、Custom 和 Static。 如果提供了 $filter='category -eq {value}'，则返回的列表仅包含其类别与 {value} 匹配的所有内置策略定义。
function listBuiltIn(options?: PolicyDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>参数
选项参数。
返回
listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)
此操作检索给定管理组中与可选给定$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} 匹配的所有策略定义。
function listByManagementGroup(managementGroupId: string, options?: PolicyDefinitionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>参数
- managementGroupId
-
string
管理组的 ID。
选项参数。