Policy Definitions - Create Or Update At Management Group
Vytvoří nebo aktualizuje definici zásad ve skupině pro správu.
Tato operace vytvoří nebo aktualizuje definici zásad v dané skupině pro správu s daným názvem.
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
management
|
path | True |
string |
ID skupiny pro správu. |
policy
|
path | True |
string |
Název definice zásady, která se má vytvořit. Regex pattern: |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
Name | Typ | Description |
---|---|---|
properties.description |
string |
Popis definice zásady |
properties.displayName |
string |
Zobrazovaný název definice zásady. |
properties.metadata |
object |
Metadata definice zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů. |
properties.mode |
string |
Režim definice zásad. Mezi příklady patří Vše, Indexováno, Microsoft.KeyVault.Data. |
properties.parameters |
<string,
Parameter |
Definice parametrů pro parametry použité v pravidle zásad. Klíče jsou názvy parametrů. |
properties.policyRule |
object |
Pravidlo zásad. |
properties.policyType |
Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické. |
|
properties.version |
string |
Verze definice zásady ve formátu #.#.# |
properties.versions |
string[] |
Seznam dostupných verzí pro tuto definici zásady |
Odpovědi
Name | Typ | Description |
---|---|---|
201 Created |
Vytvořeno – vrátí informace o definici zásady. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Create or update a policy definition at management group level
Sample Request
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2023-04-01
{
"properties": {
"mode": "All",
"displayName": "Enforce resource naming convention",
"description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
"metadata": {
"category": "Naming"
},
"policyRule": {
"if": {
"not": {
"field": "name",
"like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
}
},
"then": {
"effect": "deny"
}
},
"parameters": {
"prefix": {
"type": "String",
"metadata": {
"displayName": "Prefix",
"description": "Resource name prefix"
}
},
"suffix": {
"type": "String",
"metadata": {
"displayName": "Suffix",
"description": "Resource name suffix"
}
}
}
}
}
Sample Response
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"type": "Microsoft.Authorization/policyDefinitions",
"name": "ResourceNaming",
"properties": {
"mode": "All",
"displayName": "Naming Convention",
"description": "Force resource names to begin with 'prefix' and end with 'suffix'",
"metadata": {
"category": "Naming"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"policyRule": {
"if": {
"not": {
"field": "name",
"like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
}
},
"then": {
"effect": "deny"
}
},
"parameters": {
"prefix": {
"type": "String",
"metadata": {
"displayName": "Prefix",
"description": "Resource name prefix"
}
},
"suffix": {
"type": "String",
"metadata": {
"displayName": "Suffix",
"description": "Resource name suffix"
}
}
},
"policyType": "Custom"
}
}
Definice
Name | Description |
---|---|
Cloud |
Chybová odpověď z operace zásad. |
created |
Typ identity, která prostředek vytvořila. |
Error |
Další informace o chybě správy prostředků |
Error |
Odpověď na chybu |
Metadata |
Obecná metadata parametru |
Parameter |
Definice parametru, který je možné poskytnout zásadám. |
parameter |
Datový typ parametru. |
Policy |
Definice zásady. |
policy |
Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické. |
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
CloudError
Chybová odpověď z operace zásad.
Name | Typ | Description |
---|---|---|
error |
Odpověď na chybu |
createdByType
Typ identity, která prostředek vytvořila.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
Metadata
Obecná metadata parametru
Name | Typ | Description |
---|---|---|
assignPermissions |
boolean |
Nastavte na hodnotu true, aby Azure Portal vytvořit přiřazení rolí podle ID prostředku nebo oboru zdroje tohoto parametru během přiřazování zásad. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení. |
description |
string |
Popis parametru |
displayName |
string |
Zobrazovaný název parametru |
strongType |
string |
Používá se při přiřazování definice zásad prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat. |
ParameterDefinitionsValue
Definice parametru, který je možné poskytnout zásadám.
Name | Typ | Description |
---|---|---|
allowedValues |
object[] |
Povolené hodnoty parametru. |
defaultValue |
object |
Výchozí hodnota parametru, pokud není zadaná žádná hodnota. |
metadata |
Obecná metadata parametru |
|
schema |
object |
Poskytuje ověřování vstupů parametrů během přiřazení pomocí samodefinované schématu JSON. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací schématu Json.NET 2019-09. Další informace o používání schémat najdete v https://json-schema.org/ a testování konceptů schémat najdete v tématu https://www.jsonschemavalidator.net/. |
type |
Datový typ parametru. |
parameterType
Datový typ parametru.
Name | Typ | Description |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
PolicyDefinition
Definice zásady.
Name | Typ | Výchozí hodnota | Description |
---|---|---|---|
id |
string |
ID definice zásady. |
|
name |
string |
Název definice zásady. |
|
properties.description |
string |
Popis definice zásady |
|
properties.displayName |
string |
Zobrazovaný název definice zásady. |
|
properties.metadata |
object |
Metadata definice zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů. |
|
properties.mode |
string |
Indexed |
Režim definice zásad. Mezi příklady patří Vše, Indexováno, Microsoft.KeyVault.Data. |
properties.parameters |
<string,
Parameter |
Definice parametrů pro parametry použité v pravidle zásad. Klíče jsou názvy parametrů. |
|
properties.policyRule |
object |
Pravidlo zásad. |
|
properties.policyType |
Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické. |
||
properties.version |
string |
Verze definice zásady ve formátu #.#.# |
|
properties.versions |
string[] |
Seznam dostupných verzí pro tuto definici zásady |
|
systemData |
Systémová metadata vztahující se k tomuto prostředku. |
||
type |
string |
Typ prostředku (Microsoft.Authorization/policyDefinitions). |
policyType
Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické.
Name | Typ | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která vytvořila prostředek. |
createdByType |
Typ identity, která prostředek vytvořila. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |