Share via


Policy Set Definitions - Create Or Update

Met deze bewerking wordt een beleidssetdefinitie gemaakt of bijgewerkt in het opgegeven abonnement met de opgegeven naam.

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

URI-parameters

Name In Vereist Type Description
policySetDefinitionName
path True

string

De naam van de definitie van de beleidsset die moet worden gemaakt.

Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

subscriptionId
path True

string

uuid

De id van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
properties.policyDefinitions True

PolicyDefinitionReference[]

Een matrix met verwijzingen naar beleidsdefinities.

properties.description

string

De beschrijving van de definitie van de beleidsset.

properties.displayName

string

De weergavenaam van de definitie van de beleidsset.

properties.metadata

object

De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-ended object en zijn meestal een verzameling sleutelwaardeparen.

properties.parameters

<string,  ParameterDefinitionsValue>

De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities.

properties.policyDefinitionGroups

PolicyDefinitionGroup[]

De metagegevens die groepen beleidsdefinitieverwijzingen binnen de definitie van de beleidsset beschrijven.

properties.policyType

policyType

Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

properties.version

string

De definitieversie van de beleidsset in #.#.#-indeling.

properties.versions

string[]

Een lijst met beschikbare versies voor deze beleidssetdefinitie.

Antwoorden

Name Type Description
200 OK

PolicySetDefinition

OK: retourneert informatie over de definitie van de beleidsset.

201 Created

PolicySetDefinition

Gemaakt: retourneert informatie over de definitie van de beleidsset.

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

Create or update a policy set definition
Create or update a policy set definition with groups

Create or update a policy set definition

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
    ],
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}
{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Create or update a policy set definition with groups

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
          }
        }
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
          }
        }
      }
    ]
  }
}
{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
          }
        }
      }
    ]
  }
}

Definities

Name Description
CloudError

Een foutreactie van een beleidsbewerking.

createdByType

Het type identiteit waarmee de resource is gemaakt.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorResponse

Foutreactie

Metadata

Algemene metagegevens voor de parameter.

ParameterDefinitionsValue

De definitie van een parameter die kan worden opgegeven voor het beleid.

parameterType

Het gegevenstype van de parameter.

ParameterValuesValue

De waarde van een parameter.

PolicyDefinitionGroup

De beleidsdefinitiegroep.

PolicyDefinitionReference

De naslaginformatie over de beleidsdefinitie.

PolicySetDefinition

De definitie van de beleidsset.

policyType

Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

CloudError

Een foutreactie van een beleidsbewerking.

Name Type Description
error

ErrorResponse

Foutreactie
Algemene foutreactie voor alle Azure Resource Manager API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de OData-foutreactieindeling.)

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorResponse[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

Metadata

Algemene metagegevens voor de parameter.

Name Type Description
assignPermissions

boolean

Stel in op true om tijdens beleidstoewijzingen roltoewijzingen te maken voor de resource-id of resourcebereikwaarde van deze parameter Azure Portal. Deze eigenschap is handig als u machtigingen buiten het toewijzingsbereik wilt toewijzen.

description

string

De beschrijving van de parameter.

displayName

string

De weergavenaam voor de parameter.

strongType

string

Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen.

ParameterDefinitionsValue

De definitie van een parameter die kan worden opgegeven voor het beleid.

Name Type Description
allowedValues

object[]

De toegestane waarden voor de parameter.

defaultValue

object

De standaardwaarde voor de parameter als er geen waarde is opgegeven.

metadata

Metadata

Algemene metagegevens voor de parameter.

schema

object

Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelf-gedefinieerd JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de implementatie van Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en testconceptschema's op https://www.jsonschemavalidator.net/.

type

parameterType

Het gegevenstype van de parameter.

parameterType

Het gegevenstype van de parameter.

Name Type Description
Array

string

Boolean

string

DateTime

string

Float

string

Integer

string

Object

string

String

string

ParameterValuesValue

De waarde van een parameter.

Name Type Description
value

object

De waarde van de parameter.

PolicyDefinitionGroup

De beleidsdefinitiegroep.

Name Type Description
additionalMetadataId

string

Een resource-id van een resource die aanvullende metagegevens over de groep bevat.

category

string

De categorie van de groep.

description

string

De beschrijving van de groep.

displayName

string

De weergavenaam van de groep.

name

string

De naam van de groep.

PolicyDefinitionReference

De naslaginformatie over de beleidsdefinitie.

Name Type Description
groupNames

string[]

De naam van de groepen waartoe deze beleidsdefinitiereferentie behoort.

parameters

<string,  ParameterValuesValue>

De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen.

policyDefinitionId

string

De id van de beleidsdefinitie of beleidssetdefinitie.

policyDefinitionReferenceId

string

Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities.

PolicySetDefinition

De definitie van de beleidsset.

Name Type Description
id

string

De id van de definitie van de beleidsset.

name

string

De naam van de definitie van de beleidsset.

properties.description

string

De beschrijving van de definitie van de beleidsset.

properties.displayName

string

De weergavenaam van de definitie van de beleidsset.

properties.metadata

object

De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-ended object en zijn meestal een verzameling sleutelwaardeparen.

properties.parameters

<string,  ParameterDefinitionsValue>

De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities.

properties.policyDefinitionGroups

PolicyDefinitionGroup[]

De metagegevens die groepen beleidsdefinitieverwijzingen binnen de definitie van de beleidsset beschrijven.

properties.policyDefinitions

PolicyDefinitionReference[]

Een matrix met verwijzingen naar beleidsdefinities.

properties.policyType

policyType

Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

properties.version

string

De definitieversie van de beleidsset in #.#.#-indeling.

properties.versions

string[]

Een lijst met beschikbare versies voor deze beleidssetdefinitie.

systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.

type

string

Het type resource (Microsoft.Authorization/policySetDefinitions).

policyType

Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

Name Type Description
BuiltIn

string

Custom

string

NotSpecified

string

Static

string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.