Policy Set Definitions - Create Or Update At Management Group
Ez a művelet létrehoz vagy frissít egy szabályzatkészlet-definíciót az adott felügyeleti csoportban a megadott névvel.
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}?api-version=2023-04-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
management
|
path | True |
string |
A felügyeleti csoport azonosítója. |
policy
|
path | True |
string |
A létrehozandó szabályzatkészlet-definíció neve. Regex pattern: |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
properties.policyDefinitions | True |
Szabályzatdefiníció-hivatkozások tömbje. |
|
properties.description |
string |
A szabályzatkészlet definíciójának leírása. |
|
properties.displayName |
string |
A szabályzatkészlet-definíció megjelenítendő neve. |
|
properties.metadata |
object |
A szabályzatkészlet definíciójának metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye. |
|
properties.parameters |
<string,
Parameter |
A szabályzatdefiníció-hivatkozásokban használható szabályzatkészlet-definíciós paraméterek. |
|
properties.policyDefinitionGroups |
A szabályzatdefiníció-hivatkozások csoportjait leíró metaadatok a szabályzatkészlet definíciójában. |
||
properties.policyType |
A szabályzatkészlet-definíció típusa. A lehetséges értékek: NotSpecified, BuiltIn, Custom és Static. |
||
properties.version |
string |
A szabályzatkészlet definíciójának verziója #.#.# formátumban. |
|
properties.versions |
string[] |
A szabályzatkészlet-definíció elérhető verzióinak listája. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK – A szabályzatkészlet definíciójára vonatkozó információkat adja vissza. |
|
201 Created |
Létrehozva – A szabályzatkészlet definíciójára vonatkozó információkat adja vissza. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Create or update a policy set definition at management group level |
Create or update a policy set definition with groups at management group level |
Create or update a policy set definition at management group level
Sample Request
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/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"
},
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
Sample Response
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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"
],
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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"
},
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
Create or update a policy set definition with groups at management group level
Sample Request
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/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": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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"
}
}
}
]
}
}
Definíciók
Name | Description |
---|---|
Cloud |
Egy szabályzatművelet hibaválasza. |
created |
Az erőforrást létrehozó identitás típusa. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
Metadata |
A paraméter általános metaadatai. |
Parameter |
A szabályzathoz megadható paraméter definíciója. |
parameter |
A paraméter adattípusa. |
Parameter |
Egy paraméter értéke. |
Policy |
A szabályzatdefiníciós csoport. |
Policy |
A szabályzatdefiníció referenciája. |
Policy |
A szabályzatkészlet definíciója. |
policy |
A szabályzatkészlet-definíció típusa. A lehetséges értékek: NotSpecified, BuiltIn, Custom és Static. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
CloudError
Egy szabályzatművelet hibaválasza.
Name | Típus | Description |
---|---|---|
error |
Hibaválasz |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
Metadata
A paraméter általános metaadatai.
Name | Típus | Description |
---|---|---|
assignPermissions |
boolean |
Állítsa true (igaz) értékre, hogy Azure Portal hozzon létre szerepkör-hozzárendeléseket a paraméter erőforrás-azonosítóján vagy erőforrás-hatókörének értékén a szabályzat-hozzárendelés során. Ez a tulajdonság akkor hasznos, ha a hozzárendelés hatókörén kívül szeretne engedélyeket hozzárendelni. |
description |
string |
A paraméter leírása. |
displayName |
string |
A paraméter megjelenítendő neve. |
strongType |
string |
A szabályzatdefiníció portálon keresztüli hozzárendeléséhez használatos. A felhasználó által kiválasztandó értékek környezetfüggő listáját tartalmazza. |
ParameterDefinitionsValue
A szabályzathoz megadható paraméter definíciója.
Name | Típus | Description |
---|---|---|
allowedValues |
object[] |
A paraméter megengedett értékei. |
defaultValue |
object |
A paraméter alapértelmezett értéke, ha nincs megadva érték. |
metadata |
A paraméter általános metaadatai. |
|
schema |
object |
A paraméterbemenetek ellenőrzését biztosítja a hozzárendelés során egy ön definiált JSON-séma használatával. Ez a tulajdonság csak objektumtípus-paraméterek esetén támogatott, és a Json.NET Schema 2019-09 implementációt követi. A sémák használatáról és a vázlatsémák https://json-schema.org/ teszteléséről itt tudhat meg többet: https://www.jsonschemavalidator.net/. |
type |
A paraméter adattípusa. |
parameterType
A paraméter adattípusa.
Name | Típus | Description |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
ParameterValuesValue
Egy paraméter értéke.
Name | Típus | Description |
---|---|---|
value |
object |
A paraméter értéke. |
PolicyDefinitionGroup
A szabályzatdefiníciós csoport.
Name | Típus | Description |
---|---|---|
additionalMetadataId |
string |
Egy erőforrás erőforrás-azonosítója, amely további metaadatokat tartalmaz a csoportról. |
category |
string |
A csoport kategóriája. |
description |
string |
A csoport leírása. |
displayName |
string |
A csoport megjelenítendő neve. |
name |
string |
A csoport neve. |
PolicyDefinitionReference
A szabályzatdefiníció referenciája.
Name | Típus | Description |
---|---|---|
groupNames |
string[] |
Azon csoportok neve, amelyekhez ez a szabályzatdefiníció-hivatkozás tartozik. |
parameters |
<string,
Parameter |
A hivatkozott szabályzatszabály paraméterértékei. A kulcsok a paraméternevek. |
policyDefinitionId |
string |
A szabályzatdefiníció vagy a szabályzatkészlet-definíció azonosítója. |
policyDefinitionReferenceId |
string |
A szabályzatdefiníció-referencia egyedi azonosítója (a szabályzatkészlet definíciójában). |
PolicySetDefinition
A szabályzatkészlet definíciója.
Name | Típus | Description |
---|---|---|
id |
string |
A szabályzatkészlet-definíció azonosítója. |
name |
string |
A szabályzatkészlet-definíció neve. |
properties.description |
string |
A szabályzatkészlet definíciójának leírása. |
properties.displayName |
string |
A szabályzatkészlet-definíció megjelenítendő neve. |
properties.metadata |
object |
A szabályzatkészlet definíciójának metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye. |
properties.parameters |
<string,
Parameter |
A szabályzatdefiníció-hivatkozásokban használható szabályzatkészlet-definíciós paraméterek. |
properties.policyDefinitionGroups |
A szabályzatdefiníció-hivatkozások csoportjait leíró metaadatok a szabályzatkészlet definíciójában. |
|
properties.policyDefinitions |
Szabályzatdefiníció-hivatkozások tömbje. |
|
properties.policyType |
A szabályzatkészlet-definíció típusa. A lehetséges értékek: NotSpecified, BuiltIn, Custom és Static. |
|
properties.version |
string |
A szabályzatkészlet definíciójának verziója #.#.# formátumban. |
properties.versions |
string[] |
A szabályzatkészlet-definíció elérhető verzióinak listája. |
systemData |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
|
type |
string |
Az erőforrás típusa (Microsoft.Authorization/policySetDefinitions). |
policyType
A szabályzatkészlet-definíció típusa. A lehetséges értékek: NotSpecified, BuiltIn, Custom és Static.
Name | Típus | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az erőforrást utoljára módosító identitás. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |