Policy Set Definition Versions - Create Or Update

Tjänst:: Policy

API-version:: 2025-11-01

Denna operation skapar eller uppdaterar en version av policyuppsättningsdefinitionen i den givna prenumerationen med förnamnet och versionen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	Definitionsversionen för principuppsättningen. Formatet är x.y.z där x är huvudversionsnumret, y är det mindre versionsnumret och z är patchnumret
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Namnet på principuppsättningsdefinitionen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.policyDefinitions	True	PolicyDefinitionReference[]	En matris med principdefinitionsreferenser.
properties.description		string	Definitionsbeskrivningen för principuppsättningen.
properties.displayName		string	Visningsnamnet för principuppsättningsdefinitionen.
properties.metadata			Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
properties.parameters		<string, ParameterDefinitionsValue>	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.
properties.policyType		PolicyType	Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
properties.version		string	Principuppsättningens definitionsversion i #.#.#-format.

Svar

Name	Typ	Description
200 OK	PolicySetDefinitionVersion	Resursens uppdateringsoperation 'PolicySetDefinitionVersion' lyckades
201 Created	PolicySetDefinitionVersion	Resursen 'PolicySetDefinitionVersion' skapade en lyckad operation
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create or update a policy set definition version

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:: 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"
  }
}

Statuskod:: 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"
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
ParameterDefinitionsValue	Definitionen av en parameter som kan ges till policyn.
ParameterDefinitionsValueMetadata	Allmänna metadata för parametern.
ParameterType	Parameterns datatyp.
ParameterValuesValue	Värdet av en parameter.
PolicyDefinitionGroup	Policydefinitionsgruppen.
PolicyDefinitionReference	Referensen för policydefinitionen.
PolicySetDefinitionVersion	Definitionsversionen för principuppsättningen.
PolicyType	Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Detaljerna om felet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ParameterDefinitionsValue

Objekt

Definitionen av en parameter som kan ges till policyn.

Name	Typ	Description
allowedValues	AllowedValues[]	De tillåtna värdena för parametern.
defaultValue		Standardvärdet för parametern om inget värde anges.
metadata	ParameterDefinitionsValueMetadata	Allmänna metadata för parametern.
schema		Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Denna egenskap stöds endast för objekttypparametrar och följer Json.NET Schema 2019-09-implementeringen. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.
type	ParameterType	Parameterns datatyp.

ParameterDefinitionsValueMetadata

Objekt

Allmänna metadata för parametern.

Name	Typ	Description
assignPermissions	boolean	Sätt till true så att Azure portal skapar rolltilldelningar på resurs-ID eller resursomfattningsvärdet för denna parameter under policytilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.
description	string	Beskrivningen av parametern.
displayName	string	Visningsnamnet för parametern.
strongType	string	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.

ParameterType

Uppräkning

Parameterns datatyp.

Värde	Description
String	Strängparametertypen.
Array	Arrayparametertypen.
Object	Objektparametertypen.
Boolean	Den booleska parametertypen.
Integer	Heltalsparametertypen.
Float	Flyttaparametertypen.
DateTime	Datum-tidsparametertypen.

ParameterValuesValue

Objekt

Värdet av en parameter.

Name	Typ	Description
value		Värdet för parametern.

PolicyDefinitionGroup

Objekt

Policydefinitionsgruppen.

Name	Typ	Description
additionalMetadataId	string	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.
category	string	Gruppens kategori.
description	string	Gruppens beskrivning.
displayName	string	Gruppens visningsnamn.
name	string	Namnet på gruppen.

PolicyDefinitionReference

Objekt

Referensen för policydefinitionen.

Name	Typ	Description
definitionVersion	string	Den version av principdefinitionen som ska användas.
effectiveDefinitionVersion	string	Den effektiva versionen av policydefinitionen som används. Detta finns endast om det begärs via $expand frågeparameter.
groupNames	string[]	Namnet på de grupper som den här principdefinitionsreferensen tillhör.
latestDefinitionVersion	string	Den senaste versionen av policydefinitionen finns tillgänglig. Detta finns endast om det begärs via $expand frågeparameter.
parameters	<string, ParameterValuesValue>	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.
policyDefinitionId	string	ID:t för principdefinitionen eller principuppsättningsdefinitionen.
policyDefinitionReferenceId	string	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.