Policy Set Definition Versions - Create Or Update

Serviço:: Policy

Versão da API:: 2025-11-01

Essa operação cria ou atualiza uma versão de definição de conjunto de políticas na assinatura dada com o nome e a versão.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2025-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	A versão de definição do conjunto de políticas. O formato é x.y.z, onde x é o número da versão principal, y é o número da versão menor e z é o número do patch
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	O nome da definição do conjunto de políticas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigató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 de exibição da definição do conjunto de políticas.
properties.metadata			Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave.
properties.parameters		<string, ParameterDefinitionsValue>	Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política.
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas.
properties.policyType		PolicyType	O tipo de definição de política. 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 #.#.#.

Respostas

Nome	Tipo	Description
200 OK	PolicySetDefinitionVersion	Operação de atualização do recurso 'PolicySetDefinitionVersion' bem-sucedida
201 Created	PolicySetDefinitionVersion	Recurso 'PolicySetDefinitionVersion' criar operação bem-sucedida
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create or update a policy set definition version

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2025-11-01

{
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "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"
      },
      {
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

Resposta de exemplo

Código de status:: 200

{
  "name": "1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "definitionVersion": "1.*.*",
        "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"
      },
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

Código de status:: 201

{
  "name": "1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "definitionVersion": "1.*.*",
        "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"
      },
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ParameterDefinitionsValue	A definição de um parâmetro que pode ser fornecido à apólice.
ParameterDefinitionsValueMetadata	Metadados gerais para o parâmetro.
ParameterType	O tipo de dados do parâmetro.
ParameterValuesValue	O valor de um parâmetro.
PolicyDefinitionGroup	O grupo de definição de políticas.
PolicyDefinitionReference	A referência da definição da política.
PolicySetDefinitionVersion	A versão de definição do conjunto de políticas.
PolicyType	O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ParameterDefinitionsValue

Objeto

A definição de um parâmetro que pode ser fornecido à apólice.

Nome	Tipo	Description
allowedValues	AllowedValues[]	Os valores permitidos para o parâmetro.
defaultValue		O valor padrão do parâmetro se nenhum valor for fornecido.
metadata	ParameterDefinitionsValueMetadata	Metadados gerais para o parâmetro.
schema		Fornece a validação de entradas de parâmetro durante a atribuição usando um esquema JSON autodefinido. Essa propriedade é suportada apenas para parâmetros de tipo de objeto e segue a implementação do Esquema Json.NET 2019-09. Você pode aprender mais sobre o uso de esquemas em https://json-schema.org/ e rascunho de teste em https://www.jsonschemavalidator.net/.
type	ParameterType	O tipo de dados do parâmetro.

ParameterDefinitionsValueMetadata

Objeto

Metadados gerais para o parâmetro.

Nome	Tipo	Description
assignPermissions	boolean	Defina como true para que o portal Azure crie atribuições de funções no ID de recurso ou valor do escopo desse parâmetro durante a atribuição de políticas. Essa propriedade é útil caso você deseje atribuir permissões fora do escopo de atribuição.
description	string	A descrição do parâmetro.
displayName	string	O nome de exibição do parâmetro.
strongType	string	Usado ao atribuir a definição de política por meio do portal. Fornece uma lista de valores com reconhecimento de contexto para o usuário escolher.

ParameterType

Enumeração

O tipo de dados do parâmetro.

Valor	Description
String	O tipo de parâmetro da string.
Array	O tipo de parâmetro do array.
Object	O tipo de parâmetro do objeto.
Boolean	O tipo de parâmetro booleano.
Integer	O tipo de parâmetro inteiro.
Float	O tipo de parâmetro flutuante.
DateTime	O tipo de parâmetro data-hora.

ParameterValuesValue

Objeto

O valor de um parâmetro.

Nome	Tipo	Description
value		O valor do parâmetro.

PolicyDefinitionGroup

Objeto

O grupo de definição de políticas.

Nome	Tipo	Description
additionalMetadataId	string	Uma 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 de exibição do grupo.
name	string	O nome do grupo.

PolicyDefinitionReference

Objeto

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

Nome	Tipo	Description
definitionVersion	string	A versão da definição de política a ser usada.
effectiveDefinitionVersion	string	A versão efetiva da definição de política em uso. Isso só está presente se solicitado via parâmetro de consulta $expand.
groupNames	string[]	O nome dos grupos aos quais essa referência de definição de política pertence.
latestDefinitionVersion	string	A versão mais recente da definição da apólice disponível. Isso só está presente se solicitado via parâmetro de consulta $expand.
parameters	<string, ParameterValuesValue>	Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros.
policyDefinitionId	string	A ID da definição de política ou definição do conjunto de políticas.
policyDefinitionReferenceId	string	Uma ID exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política.