Policy Set Definition Versions - Create Or Update

Dienst:: Policy

API-Version:: 2025-11-01

Diese Operation erstellt oder aktualisiert eine Version der Policy-Set-Definition im jeweiligen Abonnement mit dem jeweiligen Namen und der Version.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	Die Definitionsversion des Richtliniensatzes. Das Format ist x.y.z, wobei x die Hauptversionsnummer, y die Nebenversionsnummer und z die Patchnummer ist
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Der Name der Richtliniensatzdefinition.
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.policyDefinitions	True	PolicyDefinitionReference[]	Ein Array von Richtliniendefinitionsverweisen.
properties.description		string	Die Beschreibung der Richtliniensatzdefinition.
properties.displayName		string	Der Anzeigename der Richtliniensatzdefinition.
properties.metadata			Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.parameters		<string, ParameterDefinitionsValue>	Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsreferenzen verwendet werden können.
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben.
properties.policyType		PolicyType	Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
properties.version		string	Die Definitionsversion des Richtliniensatzes im #.#.#-Format.

Antworten

Name	Typ	Beschreibung
200 OK	PolicySetDefinitionVersion	Die Aktualisierungsoperation der Ressource 'PolicySetDefinitionVersion' war erfolgreich
201 Created	PolicySetDefinitionVersion	Die Erstellungsoperation der Ressource 'PolicySetDefinitionVersion' war erfolgreich
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create or update a policy set definition version

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ParameterDefinitionsValue	Die Definition eines Parameters, der der Policy bereitgestellt werden kann.
ParameterDefinitionsValueMetadata	Allgemeine Metadaten für den Parameter.
ParameterType	Der Datentyp des Parameters.
ParameterValuesValue	Der Wert eines Parameters.
PolicyDefinitionGroup	Die Gruppe für die Definition von Richtlinien.
PolicyDefinitionReference	Die Referenz zur Policendefinition.
PolicySetDefinitionVersion	Die Definitionsversion des Richtliniensatzes.
PolicyType	Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ParameterDefinitionsValue

Objekt

Die Definition eines Parameters, der der Policy bereitgestellt werden kann.

Name	Typ	Beschreibung
allowedValues	AllowedValues[]	Die zulässigen Werte für den Parameter.
defaultValue		Der Standardwert für den Parameter, wenn kein Wert angegeben wird.
metadata	ParameterDefinitionsValueMetadata	Allgemeine Metadaten für den Parameter.
schema		Stellt die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas bereit. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der Implementierung des JsonNET Schema 2019-09. Mehr über die Verwendung von Schemata kannst du bei https://json-schema.org/ lernen und Entwurfsschemata testen bei https://www.jsonschemavalidator.net/.
type	ParameterType	Der Datentyp des Parameters.

ParameterDefinitionsValueMetadata

Objekt

Allgemeine Metadaten für den Parameter.

Name	Typ	Beschreibung
assignPermissions	boolean	Setzen Sie auf true, damit das Azure Portal während der Richtlinienzuweisung Rollenzuweisungen auf der Ressourcen-ID oder dem Ressourcenumfangswert dieses Parameters erstellt. Diese Eigenschaft ist nützlich, falls Sie Berechtigungen außerhalb des Zuordnungsbereichs zuweisen möchten.
description	string	Die Beschreibung des Parameters.
displayName	string	Der Anzeigename für den Parameter.
strongType	string	Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste mit Werten bereit, aus der der Benutzer auswählen kann.

ParameterType

Enumeration

Der Datentyp des Parameters.

Wert	Beschreibung
String	Der String-Parametertyp.
Array	Der Array-Parametertyp.
Object	Der Objektparametertyp.
Boolean	Der boolesche Parametertyp.
Integer	Der ganzzahlige Parametertyp.
Float	Der Float-Parametertyp.
DateTime	Der Datum-Zeit-Parametertyp.

ParameterValuesValue

Objekt

Der Wert eines Parameters.

Name	Typ	Beschreibung
value		Der Wert des Parameters.

PolicyDefinitionGroup

Objekt

Die Gruppe für die Definition von Richtlinien.

Name	Typ	Beschreibung
additionalMetadataId	string	Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält.
category	string	Die Kategorie der Gruppe.
description	string	Die Beschreibung der Gruppe.
displayName	string	Der Anzeigename der Gruppe.
name	string	Der Name der Gruppe.

PolicyDefinitionReference

Objekt

Die Referenz zur Policendefinition.

Name	Typ	Beschreibung
definitionVersion	string	Die Version der zu verwendenden Richtliniendefinition.
effectiveDefinitionVersion	string	Die wirksame Version der verwendeten Policendefinition. Dies ist nur vorhanden, wenn es über den $expand Abfrageparameter angefordert wird.
groupNames	string[]	Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört.
latestDefinitionVersion	string	Die neueste Version der Policendefinition ist verfügbar. Dies ist nur vorhanden, wenn es über den $expand Abfrageparameter angefordert wird.
parameters	<string, ParameterValuesValue>	Die Parameterwerte für die Regel, auf die verwiesen wird. Die Schlüssel sind die Parameternamen.
policyDefinitionId	string	Die ID der Richtliniendefinition oder Richtliniensatzdefinition.
policyDefinitionReferenceId	string	Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz.