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

Policy Set Definition Versions - Create Or Update At Management Group

Service:

Policy

API Version:

2023-04-01

此操作使用给定名称和版本创建或更新给定管理组中的策略集定义版本。

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2023-04-01

URI 参数

名称	在	必需	类型	说明
managementGroupName	path	True	string	管理组的名称。 此名称不区分大小写。
policyDefinitionVersion	path	True	string	策略集定义版本。 格式为 x.y.z，其中 x 是主版本号，y 是次要版本号，z 是修补程序号 Regex pattern: ^\d+\.\d+\.\d+$
policySetDefinitionName	path	True	string	策略集定义的名称。 Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
properties.policyDefinitions	True	PolicyDefinitionReference[]	策略定义引用的数组。
properties.description		string	策略集定义说明。
properties.displayName		string	策略集定义的显示名称。
properties.metadata		object	策略集定义元数据。 元数据是一个开放式对象，通常是键值对的集合。
properties.parameters		<string,  ParameterDefinitionsValue>	可在策略定义引用中使用的策略集定义参数。
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	描述策略集定义中的策略定义引用组的元数据。
properties.policyType		policyType	策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。
properties.version		string	策略以 #.#.# 格式设置定义版本。

响应

名称	类型	说明
200 OK	PolicySetDefinitionVersion	确定 - 已成功更新策略集定义版本。
201 Created	PolicySetDefinitionVersion	Created - 返回有关策略集定义版本的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update a policy set definition version at management group level

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2023-04-01

{
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python create_or_update_policy_set_definition_version_at_management_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="1.2.1",
        policy_set_definition_name="CostManagement",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definition_versions.create_or_update_at_management_group(
        management_group_name="MyManagementGroup",
        parameters={
            "properties": {
                "description": "Policies to enforce low cost storage SKUs",
                "displayName": "Cost Management",
                "metadata": {"category": "Cost Management"},
                "policyDefinitions": [
                    {
                        "parameters": {"listOfAllowedSKUs": {"value": ["Standard_GRS", "Standard_LRS"]}},
                        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
                        "policyDefinitionReferenceId": "Limit_Skus",
                    },
                    {
                        "parameters": {"prefix": {"value": "DeptA"}, "suffix": {"value": "-LC"}},
                        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
                        "policyDefinitionReferenceId": "Resource_Naming",
                    },
                ],
                "version": "1.2.1",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersionAtManagementGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "name": "1.2.1",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Status code:

200

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "CostManagement",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

定义

名称	说明
CloudError	来自策略操作的错误响应。
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
Metadata	参数的常规元数据。
ParameterDefinitionsValue	可提供给策略的参数的定义。
parameterType	参数的数据类型。
ParameterValuesValue	参数的值。
PolicyDefinitionGroup	策略定义组。
PolicyDefinitionReference	策略定义引用。
PolicySetDefinitionVersion	策略集定义版本。
policyType	策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。
systemData	与资源的创建和上次修改相关的元数据。

CloudError

来自策略操作的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应 对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

Metadata

参数的常规元数据。

名称	类型	说明
assignPermissions	boolean	设置为 true，使Azure 门户策略分配期间对此参数的资源 ID 或资源范围值创建角色分配。 如果希望在分配范围之外分配权限，此属性会很有用。
description	string	参数的说明。
displayName	string	参数的显示名称。
strongType	string	通过门户分配策略定义时使用。 提供上下文感知值列表，供用户从中进行选择。

ParameterDefinitionsValue

可提供给策略的参数的定义。

名称	类型	说明
allowedValues	object[]	参数的允许值。
defaultValue	object	如果未提供任何值，则为参数的默认值。
metadata	Metadata	参数的常规元数据。
schema	object	使用自定义的 JSON 架构在赋值期间提供参数输入的验证。 此属性仅支持对象类型的参数，并遵循 Json.NET 架构 2019-09 实现。 可以了解更多关于在 https://json-schema.org/ 使用架构和在 https://www.jsonschemavalidator.net/ 测试草稿架构的信息。
type	parameterType	参数的数据类型。

parameterType

参数的数据类型。

名称	类型	说明
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

参数的值。

名称	类型	说明
value	object	参数值。

PolicyDefinitionGroup

策略定义组。

名称	类型	说明
additionalMetadataId	string	包含有关组的其他元数据的资源的资源 ID。
category	string	组的类别。
description	string	组的说明。
displayName	string	组的显示名称。
name	string	组名称。

PolicyDefinitionReference

策略定义引用。

名称	类型	说明
groupNames	string[]	此策略定义引用所属的组的名称。
parameters	<string,  ParameterValuesValue>	引用的策略规则的参数值。 键是参数名称。
policyDefinitionId	string	策略定义或策略集定义的 ID。
policyDefinitionReferenceId	string	此策略定义引用的策略集定义) 内 (唯一 ID。

PolicySetDefinitionVersion

策略集定义版本。

名称	类型	说明
id	string	策略集定义版本的 ID。
name	string	策略集定义版本的名称。
properties.description	string	策略集定义说明。
properties.displayName	string	策略集定义的显示名称。
properties.metadata	object	策略集定义元数据。 元数据是一个开放式对象，通常是键值对的集合。
properties.parameters	<string,  ParameterDefinitionsValue>	可在策略定义引用中使用的策略集定义参数。
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	描述策略集定义中的策略定义引用组的元数据。
properties.policyDefinitions	PolicyDefinitionReference[]	策略定义引用的数组。
properties.policyType	policyType	策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。
properties.version	string	策略以 #.#.# 格式设置定义版本。
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型 (Microsoft.Authorization/policySetDefinitions/versions) 。

policyType

策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。

名称	类型	说明
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。