Policy Set Definition Versions - Create Or Update At Management Group

Служба:

Policy

Версия API:

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 — номер исправления. Шаблон регулярного выражения: ^\d+\.\d+\.\d+$
policySetDefinitionName	path	True	string	Имя определения набора политик. Шаблон регулярного выражения: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
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	Создано— возвращает сведения о версии определения набора политик.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Образец запроса

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 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(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definition_versions.create_or_update_at_management_group(
        management_group_name="MyManagementGroup",
        policy_set_definition_name="CostManagement",
        policy_definition_version="1.2.1",
        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

Пример ответа

Код состояния:

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",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Код состояния:

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",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "definitionVersion": "1.*.*",
        "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	Ответ на ошибку Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку 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 создавал назначения ролей для идентификатора ресурса или значения области ресурса этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения.
description	string	Описание параметра.
displayName	string	Отображаемое имя параметра.
strongType	string	Используется при назначении определения политики через портал. Предоставляет контекстный список значений, которые пользователь выбирает.

ParameterDefinitionsValue

Определение параметра, который может быть предоставлен политике.

Имя	Тип	Описание
allowedValues	object[]	Допустимые значения параметра.
defaultValue	object	Значение по умолчанию для параметра, если значение не указано.
metadata	Metadata	Общие метаданные параметра.
schema	object	Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров типа объекта и следует реализации Json.NET schema 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	Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе.
category	string	Категория группы.
description	string	Описание группы.
displayName	string	Отображаемое имя группы.
name	string	Имя группы.

PolicyDefinitionReference

Справочник по определению политики.

Имя	Тип	Описание
definitionVersion	string	Версия используемого определения политики.
effectiveDefinitionVersion	string	Эффективная версия используемого определения политики. Это значение присутствует только в том случае, если он запрашивается с помощью параметра запроса $expand.
groupNames	string[]	Имя групп, к которым относится ссылка на определение политики.
latestDefinitionVersion	string	Последняя версия определения политики доступна. Это значение присутствует только в том случае, если он запрашивается с помощью параметра запроса $expand.
parameters	<string,  ParameterValuesValue>	Значения параметров для указанного правила политики. Ключи — это имена параметров.
policyDefinitionId	string	Идентификатор определения политики или определения набора политик.
policyDefinitionReferenceId	string	Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики.

PolicySetDefinitionVersion

Версия определения набора политик.

Имя	Тип	Описание
id	string	Идентификатор версии определения набора политик.
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	Тип удостоверения, который последний раз изменил ресурс.