Policy Set Definitions - Create Or Update
Den här åtgärden skapar eller uppdaterar en principuppsättningsdefinition i den angivna prenumerationen med det angivna namnet.
PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}?api-version=2023-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
policy
|
path | True |
string pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ |
Namnet på den principuppsättningsdefinition som ska skapas. |
subscription
|
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 |
En matris med principdefinitionsreferenser. |
|
properties.description |
string |
Definitionsbeskrivningen för principuppsättningen. |
|
properties.displayName |
string |
Visningsnamnet för principuppsättningsdefinitionen. |
|
properties.metadata |
object |
Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar. |
|
properties.parameters |
<string,
Parameter |
Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser. |
|
properties.policyDefinitionGroups |
Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen. |
||
properties.policyType |
Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. |
||
properties.version |
string |
Principuppsättningens definitionsversion i #.#.#-format. |
|
properties.versions |
string[] |
En lista över tillgängliga versioner för den här principuppsättningsdefinitionen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK – Returnerar information om principuppsättningsdefinitionen. |
|
201 Created |
Skapad – Returnerar information om principuppsättningsdefinitionen. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
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 |
Create or update a policy set definition with groups |
Create or update a policy set definition
Exempelbegäran
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"
}
}
}
]
}
}
Exempelsvar
{
"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",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"definitionVersion": "1.*.*",
"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
Exempelbegäran
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",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Limit_Skus",
"groupNames": [
"CostSaving"
],
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Resource_Naming",
"groupNames": [
"Organizational"
],
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
Exempelsvar
{
"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",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Limit_Skus",
"groupNames": [
"CostSaving"
],
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"definitionVersion": "1.*.*",
"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",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Limit_Skus",
"groupNames": [
"CostSaving"
],
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Resource_Naming",
"groupNames": [
"Organizational"
],
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
Definitioner
Name | Description |
---|---|
Cloud |
Ett felsvar från en principåtgärd. |
created |
Den typ av identitet som skapade resursen. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felsvar |
Metadata |
Allmänna metadata för parametern. |
Parameter |
Definitionen av en parameter som kan anges för principen. |
parameter |
Parameterns datatyp. |
Parameter |
Värdet för en parameter. |
Policy |
Principdefinitionsgruppen. |
Policy |
Referensen för principdefinitionen. |
Policy |
Principuppsättningsdefinitionen. |
policy |
Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
CloudError
Ett felsvar från en principåtgärd.
Name | Typ | Description |
---|---|---|
error |
Felsvar |
createdByType
Den typ av identitet som skapade resursen.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Ytterligare informationstyp. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
Metadata
Allmänna metadata för parametern.
Name | Typ | Description |
---|---|---|
assignPermissions |
boolean |
Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. 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. |
ParameterDefinitionsValue
Definitionen av en parameter som kan anges för principen.
Name | Typ | Description |
---|---|---|
allowedValues |
object[] |
De tillåtna värdena för parametern. |
defaultValue |
object |
Standardvärdet för parametern om inget värde anges. |
metadata |
Allmänna metadata för parametern. |
|
schema |
object |
Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för parametrar av objekttyp och följer implementeringen Json.NET Schema 2019-09. 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 |
Parameterns datatyp. |
parameterType
Parameterns datatyp.
Värde | Description |
---|---|
Array | |
Boolean | |
DateTime | |
Float | |
Integer | |
Object | |
String |
ParameterValuesValue
Värdet för en parameter.
Name | Typ | Description |
---|---|---|
value |
object |
Värdet för parametern. |
PolicyDefinitionGroup
Principdefinitionsgruppen.
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
Referensen för principdefinitionen.
Name | Typ | Description |
---|---|---|
definitionVersion |
string |
Den version av principdefinitionen som ska användas. |
effectiveDefinitionVersion |
string |
Den effektiva versionen av principdefinitionen som används. Detta finns bara om det begärs via frågeparametern $expand. |
groupNames |
string[] |
Namnet på de grupper som den här principdefinitionsreferensen tillhör. |
latestDefinitionVersion |
string |
Den senaste versionen av den tillgängliga principdefinitionen. Detta finns bara om det begärs via frågeparametern $expand. |
parameters |
<string,
Parameter |
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. |
PolicySetDefinition
Principuppsättningsdefinitionen.
Name | Typ | Description |
---|---|---|
id |
string |
ID:t för principuppsättningsdefinitionen. |
name |
string |
Namnet på principuppsättningsdefinitionen. |
properties.description |
string |
Definitionsbeskrivningen för principuppsättningen. |
properties.displayName |
string |
Visningsnamnet för principuppsättningsdefinitionen. |
properties.metadata |
object |
Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar. |
properties.parameters |
<string,
Parameter |
Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser. |
properties.policyDefinitionGroups |
Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen. |
|
properties.policyDefinitions |
En matris med principdefinitionsreferenser. |
|
properties.policyType |
Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. |
|
properties.version |
string |
Principuppsättningens definitionsversion i #.#.#-format. |
properties.versions |
string[] |
En lista över tillgängliga versioner för den här principuppsättningsdefinitionen. |
systemData |
Systemmetadata för den här resursen. |
|
type |
string |
Resurstypen (Microsoft.Authorization/policySetDefinitions). |
policyType
Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
Värde | Description |
---|---|
BuiltIn | |
Custom | |
NotSpecified | |
Static |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string (date-time) |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |