Policy Definitions - Create Or Update At Management Group

Referentie

Service:: Policy

API Version:: 2023-04-01

Hiermee maakt of werkt u een beleidsdefinitie bij in een beheergroep.
Met deze bewerking wordt een beleidsdefinitie gemaakt of bijgewerkt in de opgegeven beheergroep met de opgegeven naam.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
managementGroupId	path	True	string	De id van de beheergroep.
policyDefinitionName	path	True	string	De naam van de beleidsdefinitie die moet worden gemaakt. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

managementGroupId

path

True

string

De id van de beheergroep.

policyDefinitionName

path

True

string

De naam van de beleidsdefinitie die moet worden gemaakt.

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

api-version

query

True

string

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

Aanvraagbody

Name	Type	Description
properties.description	string	De beschrijving van de beleidsdefinitie.
properties.displayName	string	De weergavenaam van de beleidsdefinitie.
properties.metadata	object	De metagegevens van de beleidsdefinitie. Metagegevens zijn een open-eindobject en zijn meestal een verzameling sleutelwaardeparen.
properties.mode	string	De beleidsdefinitiemodus. Enkele voorbeelden zijn All, Indexed, Microsoft.KeyVault.Data.
properties.parameters	<string, ParameterDefinitionsValue>	De parameterdefinities voor parameters die worden gebruikt in de beleidsregel. De sleutels zijn de parameternamen.
properties.policyRule	object	De beleidsregel.
properties.policyType	policyType	Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
properties.version	string	De beleidsdefinitieversie in #.#.#-indeling.
properties.versions	string[]	Een lijst met beschikbare versies voor deze beleidsdefinitie.

Antwoorden

Name	Type	Description
201 Created	PolicyDefinition	Gemaakt: retourneert informatie over de beleidsdefinitie.
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 definition at management group level

Sample Request

HTTP

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

Status code:: 201

{
  "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"
  }
}

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 aan het beleid.
parameterType	Het gegevenstype van de parameter.
PolicyDefinition	De beleidsdefinitie.
policyType	Het type beleidsdefinitie. 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 indeling van de OData-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	ErrorAdditionalInfo[]	De fout aanvullende informatie.
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 Azure Portal roltoewijzingen te laten maken op de resource-id of resourcebereikwaarde van deze parameter tijdens de beleidstoewijzing. 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 aan 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 Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en test conceptschema'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