Policy Set Definitions - Create Or Update At Management Group

Service:

Policy

API Version:

2023-04-01

Esta operação cria ou atualiza uma definição de conjunto de políticas no grupo de gestão especificado com o nome especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
managementGroupId	path	True	string	O ID do grupo de gestão.
policySetDefinitionName	path	True	string	O nome da definição do conjunto de políticas a criar. Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.policyDefinitions	True	PolicyDefinitionReference[]	Uma matriz de referências de definição de política.
properties.description		string	A descrição da definição do conjunto de políticas.
properties.displayName		string	O nome a apresentar da definição do conjunto de políticas.
properties.metadata		object	Os metadados de definição do conjunto de políticas. Os metadados são um objeto com extremidade aberta e, normalmente, são uma coleção de pares de valores chave.
properties.parameters		<string,  ParameterDefinitionsValue>	Os parâmetros de definição do conjunto de políticas que podem ser utilizados em referências de definições de política.
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	Os metadados que descrevem grupos de referências de definições de políticas na definição do conjunto de políticas.
properties.policyType		policyType	O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
properties.version		string	A versão de definição do conjunto de políticas no formato #.#.#.
properties.versions		string[]	Uma lista de versões disponíveis para esta definição de conjunto de políticas.

Respostas

Name	Tipo	Description
200 OK	PolicySetDefinition	OK - Devolve informações sobre a definição do conjunto de políticas.
201 Created	PolicySetDefinition	Criado – devolve informações sobre a definição do conjunto de políticas.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create or update a policy set definition at management group level

Create or update a policy set definition with groups at management group level

Create or update a policy set definition at management group level

Sample Request

HTTP

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

{
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "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_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="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="CostManagement",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definitions.create_or_update_at_management_group(
        management_group_id="MyManagementGroup",
        policy_set_definition_name="CostManagement",
        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",
                    },
                ],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.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",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "CostManagement",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "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"
          }
        }
      }
    ]
  }
}

Create or update a policy set definition with groups at management group level

Sample Request

HTTP

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

{
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "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_with_groups_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="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="CostManagement",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definitions.create_or_update_at_management_group(
        management_group_id="MyManagementGroup",
        policy_set_definition_name="CostManagement",
        parameters={
            "properties": {
                "description": "Policies to enforce low cost storage SKUs",
                "displayName": "Cost Management",
                "metadata": {"category": "Cost Management"},
                "policyDefinitionGroups": [
                    {
                        "description": "Policies designed to control spend within a subscription.",
                        "displayName": "Cost Management Policies",
                        "name": "CostSaving",
                    },
                    {
                        "description": "Policies that help enforce resource organization standards within a subscription.",
                        "displayName": "Organizational Policies",
                        "name": "Organizational",
                    },
                ],
                "policyDefinitions": [
                    {
                        "groupNames": ["CostSaving"],
                        "parameters": {"listOfAllowedSKUs": {"value": ["Standard_GRS", "Standard_LRS"]}},
                        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
                        "policyDefinitionReferenceId": "Limit_Skus",
                    },
                    {
                        "groupNames": ["Organizational"],
                        "parameters": {"prefix": {"value": "DeptA"}, "suffix": {"value": "-LC"}},
                        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
                        "policyDefinitionReferenceId": "Resource_Naming",
                    },
                ],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroupsAtManagementGroup.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",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "CostManagement",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "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"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Definições

Name	Description
CloudError	Uma resposta de erro de uma operação de política.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
Metadata	Metadados gerais para o parâmetro.
ParameterDefinitionsValue	A definição de um parâmetro que pode ser fornecido à política.
parameterType	O tipo de dados do parâmetro.
ParameterValuesValue	O valor de um parâmetro.
PolicyDefinitionGroup	O grupo de definições de política.
PolicyDefinitionReference	A referência de definição de política.
PolicySetDefinition	A definição do conjunto de políticas.
policyType	O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
systemData	Metadados relativos à criação e última modificação do recurso.

CloudError

Uma resposta de erro de uma operação de política.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

Metadata

Metadados gerais para o parâmetro.

Name	Tipo	Description
assignPermissions	boolean	Defina como verdadeiro para ter portal do Azure criar atribuições de funções no ID de recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de políticas. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito da atribuição.
description	string	A descrição do parâmetro.
displayName	string	O nome a apresentar do parâmetro.
strongType	string	Utilizado ao atribuir a definição de política através do portal. Fornece uma lista de valores com suporte de contexto para o utilizador escolher.

ParameterDefinitionsValue

A definição de um parâmetro que pode ser fornecido à política.

Name	Tipo	Description
allowedValues	object[]	Os valores permitidos para o parâmetro.
defaultValue	object	O valor predefinido para o parâmetro se não for fornecido nenhum valor.
metadata	Metadata	Metadados gerais para o parâmetro.
schema	object	Fornece a validação de entradas de parâmetros durante a atribuição com um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo de objeto e segue a implementação Json.NET Schema 2019-09. Pode saber mais sobre como utilizar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/.
type	parameterType	O tipo de dados do parâmetro.

parameterType

O tipo de dados do parâmetro.

Name	Tipo	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

O valor de um parâmetro.

Name	Tipo	Description
value	object	O valor do parâmetro.

PolicyDefinitionGroup

O grupo de definições de política.

Name	Tipo	Description
additionalMetadataId	string	Um ID de recurso de um recurso que contém metadados adicionais sobre o grupo.
category	string	A categoria do grupo.
description	string	A descrição do grupo.
displayName	string	O nome a apresentar do grupo.
name	string	O nome do grupo.

PolicyDefinitionReference

A referência de definição de política.

Name	Tipo	Description
groupNames	string[]	O nome dos grupos a que esta referência de definição de política pertence.
parameters	<string,  ParameterValuesValue>	Os valores dos parâmetros da regra de política referenciada. As chaves são os nomes dos parâmetros.
policyDefinitionId	string	O ID da definição de política ou definição do conjunto de políticas.
policyDefinitionReferenceId	string	Um ID exclusivo (dentro da definição do conjunto de políticas) para esta referência de definição de política.

PolicySetDefinition

A definição do conjunto de políticas.

Name	Tipo	Description
id	string	O ID da definição do conjunto de políticas.
name	string	O nome da definição do conjunto de políticas.
properties.description	string	A descrição da definição do conjunto de políticas.
properties.displayName	string	O nome a apresentar da definição do conjunto de políticas.
properties.metadata	object	Os metadados de definição do conjunto de políticas. Os metadados são um objeto com extremidade aberta e, normalmente, são uma coleção de pares de valores chave.
properties.parameters	<string,  ParameterDefinitionsValue>	Os parâmetros de definição do conjunto de políticas que podem ser utilizados em referências de definições de política.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	Os metadados que descrevem grupos de referências de definições de políticas na definição do conjunto de políticas.
properties.policyDefinitions	PolicyDefinitionReference[]	Uma matriz de referências de definição de política.
properties.policyType	policyType	O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
properties.version	string	A versão de definição do conjunto de políticas no formato #.#.#.
properties.versions	string[]	Uma lista de versões disponíveis para esta definição de conjunto de políticas.
systemData	systemData	Os metadados do sistema relacionados com este recurso.
type	string	O tipo de recurso (Microsoft.Authorization/policySetDefinitions).

policyType

O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.

Name	Tipo	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.