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 |
---|---|---|---|---|
policy
|
path | True |
string |
De naam van de definitie van de beleidsset die moet worden gemaakt. Regex pattern: |
subscription
|
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 |
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,
Parameter |
De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities. |
|
properties.policyDefinitionGroups |
De metagegevens die groepen beleidsdefinitieverwijzingen binnen de definitie van de beleidsset beschrijven. |
||
properties.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 |
OK: retourneert informatie over de definitie van de beleidsset. |
|
201 Created |
Gemaakt: retourneert informatie over de definitie van de beleidsset. |
|
Other Status Codes |
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 |
---|---|
Cloud |
Een foutreactie van een beleidsbewerking. |
created |
Het type identiteit waarmee de resource is gemaakt. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
Foutreactie |
Metadata |
Algemene metagegevens voor de parameter. |
Parameter |
De definitie van een parameter die kan worden opgegeven voor het beleid. |
parameter |
Het gegevenstype van de parameter. |
Parameter |
De waarde van een parameter. |
Policy |
De beleidsdefinitiegroep. |
Policy |
De naslaginformatie over de beleidsdefinitie. |
Policy |
De definitie van de beleidsset. |
policy |
Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static. |
system |
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. |
CloudError
Een foutreactie van een beleidsbewerking.
Name | Type | Description |
---|---|---|
error |
Foutreactie |
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 |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
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 |
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 |
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,
Parameter |
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,
Parameter |
De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities. |
properties.policyDefinitionGroups |
De metagegevens die groepen beleidsdefinitieverwijzingen binnen de definitie van de beleidsset beschrijven. |
|
properties.policyDefinitions |
Een matrix met verwijzingen naar beleidsdefinities. |
|
properties.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 |
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 |
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 |
Het type identiteit dat de resource het laatst heeft gewijzigd. |