Delen via

Policy Definitions - Create Or Update

Service:
Policy
API-versie:
2023-04-01

Hiermee maakt of werkt u een beleidsdefinitie in een abonnement bij.
Met deze bewerking maakt of werkt u een beleidsdefinitie in het opgegeven abonnement bij met de opgegeven naam.

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

URI-parameters

Name In Vereist Type Description
policyDefinitionName
 path True

string

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

De naam van de beleidsdefinitie die moet worden gemaakt.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

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 geopend object en zijn meestal een verzameling sleutel-waardeparen.
properties.mode

string

De beleidsdefinitiemodus. Enkele voorbeelden zijn Alle, Geïndexeerd, 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

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Create or update a policy definition
Create or update a policy definition with advanced parameters

Create or update a policy definition

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
        }
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
201 
{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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"
  }
}

Create or update a policy definition with advanced parameters

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/EventHubDiagnosticLogs?api-version=2023-04-01

{
  "properties": {
    "mode": "Indexed",
    "displayName": "Event Hubs should have diagnostic logging enabled",
    "description": "Audit enabling of logs and retain them up to a year. This enables recreation of activity trails for investigation purposes when a security incident occurs or your network is compromised",
    "metadata": {
      "category": "Event Hub"
    },
    "policyRule": {
      "if": {
        "field": "type",
        "equals": "Microsoft.EventHub/namespaces"
      },
      "then": {
        "effect": "AuditIfNotExists",
        "details": {
          "type": "Microsoft.Insights/diagnosticSettings",
          "existenceCondition": {
            "allOf": [
              {
                "field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.enabled",
                "equals": "true"
              },
              {
                "field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.days",
                "equals": "[parameters('requiredRetentionDays')]"
              }
            ]
          }
        }
      }
    },
    "parameters": {
      "requiredRetentionDays": {
        "type": "Integer",
        "defaultValue": 365,
        "allowedValues": [
          0,
          30,
          90,
          180,
          365
        ],
        "metadata": {
          "displayName": "Required retention (days)",
          "description": "The required diagnostic logs retention in days"
        }
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
201 
{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "ResourceNaming",
  "properties": {
    "mode": "Indexed",
    "displayName": "Event Hubs should have diagnostic logging enabled",
    "description": "Audit enabling of logs and retain them up to a year. This enables recreation of activity trails for investigation purposes when a security incident occurs or your network is compromised",
    "metadata": {
      "category": "Event Hub"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyRule": {
      "if": {
        "field": "type",
        "equals": "Microsoft.EventHub/namespaces"
      },
      "then": {
        "effect": "AuditIfNotExists",
        "details": {
          "type": "Microsoft.Insights/diagnosticSettings",
          "existenceCondition": {
            "allOf": [
              {
                "field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.enabled",
                "equals": "true"
              },
              {
                "field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.days",
                "equals": "[parameters('requiredRetentionDays')]"
              }
            ]
          }
        }
      }
    },
    "parameters": {
      "requiredRetentionDays": {
        "type": "Integer",
        "defaultValue": 365,
        "allowedValues": [
          0,
          30,
          90,
          180,
          365
        ],
        "metadata": {
          "displayName": "Required retention (days)",
          "description": "The required diagnostic logs retention in days"
        }
      }
    }
  }
}

Definities

Name Description
CloudError

Een foutbericht 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 aan het beleid kan worden verstrekt.
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 de laatste wijziging van de resource.

CloudError

Object

Een foutbericht van een beleidsbewerking.

Name Type Description
error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactie-indeling.)

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorResponse

Object

Foutreactie

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorResponse[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

Metadata

Object

Algemene metagegevens voor de parameter.

Name Type Description
assignPermissions

boolean

Ingesteld op waar als u azure Portal roltoewijzingen wilt laten maken voor de resource-id of resourcebereikwaarde van deze parameter tijdens het toewijzen van het beleid. Deze eigenschap is handig als u machtigingen wilt toewijzen buiten het toewijzingsbereik.
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

Object

De definitie van een parameter die aan het beleid kan worden verstrekt.

Name Type Description
allowedValues

object[]

De toegestane waarden voor de parameter.
defaultValue

object

De standaardwaarde voor de parameter als er geen waarde wordt opgegeven.
metadata

Metadata

Algemene metagegevens voor de parameter.
schema

object

Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelfgedefinieerde JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de Json.NET Schema 2019-09-implementatie. U vindt meer informatie over het gebruik van schema's op https://json-schema.org/ en het testen van conceptschema's op https://www.jsonschemavalidator.net/.
type

parameterType

Het gegevenstype van de parameter.

parameterType

Opsomming

Het gegevenstype van de parameter.

Waarde Description
String
Array
Object
Boolean
Integer
Float
DateTime

PolicyDefinition

Object

De beleidsdefinitie.

Name Type Default value Description
id

string

De id van de beleidsdefinitie.
name

string

De naam van de beleidsdefinitie.
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 geopend object en zijn meestal een verzameling sleutel-waardeparen.
properties.mode

string

Indexed

De beleidsdefinitiemodus. Enkele voorbeelden zijn Alle, Geïndexeerd, 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.
systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.
type

string

Het type resource (Microsoft.Authorization/policyDefinitions).

policyType

Opsomming

Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

Waarde Description
NotSpecified
BuiltIn
Custom
Static

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.