Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Bicep-Ressourcendefinition
Der ressourcentyp "policySetDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policySetDefinitions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2025-03-01' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(...)
parameters: {
{customized property}: {
allowedValues: [
any(...)
]
defaultValue: any(...)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(...)
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
definitionVersion: 'string'
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any(...)
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich) |
| Eigenschaften | Die Eigenschaften der Richtliniensatzdefinition. | PolicySetDefinitionProperties- |
| scope | Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. | Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden. |
ParameterDefinitions
| Name | Beschreibung | Wert |
|---|
ParameterDefinitionsValue
| Name | Beschreibung | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| Standardwert | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | jegliche |
| Metadaten | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata- |
| Schema | Stellt die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas bereit. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der Json.NET Schema 2019-09-Implementierung. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testentwurfsschemas unter https://www.jsonschemavalidator.net/. | jegliche |
| Art | Der Datentyp des Parameters. | 'Array' 'Boolean' 'DateTime' "Float" "Ganze Zahl" 'Object' 'String' |
ParameterDefinitionsValueMetadata
| Name | Beschreibung | Wert |
|---|---|---|
| assignPermissions | Legen Sie diesen Wert auf "true" fest, damit das Azure-Portal Während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellt. Diese Eigenschaft ist nützlich, falls Sie Berechtigungen außerhalb des Zuordnungsbereichs zuweisen möchten. | Bool |
| Beschreibung | Die Beschreibung des Parameters. | Schnur |
| Anzeigename | Der Anzeigename für den Parameter. | Schnur |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste mit Werten bereit, aus der der Benutzer auswählen kann. | Schnur |
ParameterValues
| Name | Beschreibung | Wert |
|---|
ParameterValuesValue
| Name | Beschreibung | Wert |
|---|---|---|
| Wert | Der Wert des Parameters. | jegliche |
PolicyDefinitionGroup
| Name | Beschreibung | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält. | Schnur |
| Kategorie | Die Kategorie der Gruppe. | Schnur |
| Beschreibung | Die Beschreibung der Gruppe. | Schnur |
| Anzeigename | Der Anzeigename der Gruppe. | Schnur |
| Name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | Beschreibung | Wert |
|---|---|---|
| definitionVersion | Die Version der zu verwendenden Richtliniendefinition. | Schnur |
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| Parameter | Die Parameterwerte für die Regel, auf die verwiesen wird. Die Schlüssel sind die Parameternamen. | ParameterValues- |
| policyDefinitionId | Die ID der Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. | Schnur |
PolicySetDefinitionProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
| Anzeigename | Der Anzeigename der Richtliniensatzdefinition. | Schnur |
| Metadaten | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. | jegliche |
| Parameter | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsreferenzen verwendet werden können. | ParameterDefinitions- |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup-[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweisen. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
| Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |
| Versionen | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
ARM-Vorlagenressourcendefinition
Der ressourcentyp "policySetDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policySetDefinitions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2025-03-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string"
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"definitionVersion": "string",
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2025-03-01' |
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich) |
| Eigenschaften | Die Eigenschaften der Richtliniensatzdefinition. | PolicySetDefinitionProperties- |
| Art | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions" |
ParameterDefinitions
| Name | Beschreibung | Wert |
|---|
ParameterDefinitionsValue
| Name | Beschreibung | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| Standardwert | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | jegliche |
| Metadaten | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata- |
| Schema | Stellt die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas bereit. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der Json.NET Schema 2019-09-Implementierung. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testentwurfsschemas unter https://www.jsonschemavalidator.net/. | jegliche |
| Art | Der Datentyp des Parameters. | 'Array' 'Boolean' 'DateTime' "Float" "Ganze Zahl" 'Object' 'String' |
ParameterDefinitionsValueMetadata
| Name | Beschreibung | Wert |
|---|---|---|
| assignPermissions | Legen Sie diesen Wert auf "true" fest, damit das Azure-Portal Während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellt. Diese Eigenschaft ist nützlich, falls Sie Berechtigungen außerhalb des Zuordnungsbereichs zuweisen möchten. | Bool |
| Beschreibung | Die Beschreibung des Parameters. | Schnur |
| Anzeigename | Der Anzeigename für den Parameter. | Schnur |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste mit Werten bereit, aus der der Benutzer auswählen kann. | Schnur |
ParameterValues
| Name | Beschreibung | Wert |
|---|
ParameterValuesValue
| Name | Beschreibung | Wert |
|---|---|---|
| Wert | Der Wert des Parameters. | jegliche |
PolicyDefinitionGroup
| Name | Beschreibung | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält. | Schnur |
| Kategorie | Die Kategorie der Gruppe. | Schnur |
| Beschreibung | Die Beschreibung der Gruppe. | Schnur |
| Anzeigename | Der Anzeigename der Gruppe. | Schnur |
| Name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | Beschreibung | Wert |
|---|---|---|
| definitionVersion | Die Version der zu verwendenden Richtliniendefinition. | Schnur |
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| Parameter | Die Parameterwerte für die Regel, auf die verwiesen wird. Die Schlüssel sind die Parameternamen. | ParameterValues- |
| policyDefinitionId | Die ID der Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. | Schnur |
PolicySetDefinitionProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
| Anzeigename | Der Anzeigename der Richtliniensatzdefinition. | Schnur |
| Metadaten | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. | jegliche |
| Parameter | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsreferenzen verwendet werden können. | ParameterDefinitions- |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup-[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweisen. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
| Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |
| Versionen | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
Verwendungsbeispiele
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der ressourcentyp "policySetDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policySetDefinitions-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2025-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
displayName = "string"
metadata = ?
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
schema = ?
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
definitionVersion = "string"
groupNames = [
"string"
]
parameters = {
{customized property} = {
value = ?
}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
}
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich) |
| parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
| Eigenschaften | Die Eigenschaften der Richtliniensatzdefinition. | PolicySetDefinitionProperties- |
| Art | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions@2025-03-01" |
ParameterDefinitions
| Name | Beschreibung | Wert |
|---|
ParameterDefinitionsValue
| Name | Beschreibung | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| Standardwert | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | jegliche |
| Metadaten | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata- |
| Schema | Stellt die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas bereit. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der Json.NET Schema 2019-09-Implementierung. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testentwurfsschemas unter https://www.jsonschemavalidator.net/. | jegliche |
| Art | Der Datentyp des Parameters. | 'Array' 'Boolean' 'DateTime' "Float" "Ganze Zahl" 'Object' 'String' |
ParameterDefinitionsValueMetadata
| Name | Beschreibung | Wert |
|---|---|---|
| assignPermissions | Legen Sie diesen Wert auf "true" fest, damit das Azure-Portal Während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellt. Diese Eigenschaft ist nützlich, falls Sie Berechtigungen außerhalb des Zuordnungsbereichs zuweisen möchten. | Bool |
| Beschreibung | Die Beschreibung des Parameters. | Schnur |
| Anzeigename | Der Anzeigename für den Parameter. | Schnur |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste mit Werten bereit, aus der der Benutzer auswählen kann. | Schnur |
ParameterValues
| Name | Beschreibung | Wert |
|---|
ParameterValuesValue
| Name | Beschreibung | Wert |
|---|---|---|
| Wert | Der Wert des Parameters. | jegliche |
PolicyDefinitionGroup
| Name | Beschreibung | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält. | Schnur |
| Kategorie | Die Kategorie der Gruppe. | Schnur |
| Beschreibung | Die Beschreibung der Gruppe. | Schnur |
| Anzeigename | Der Anzeigename der Gruppe. | Schnur |
| Name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | Beschreibung | Wert |
|---|---|---|
| definitionVersion | Die Version der zu verwendenden Richtliniendefinition. | Schnur |
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| Parameter | Die Parameterwerte für die Regel, auf die verwiesen wird. Die Schlüssel sind die Parameternamen. | ParameterValues- |
| policyDefinitionId | Die ID der Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. | Schnur |
PolicySetDefinitionProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
| Anzeigename | Der Anzeigename der Richtliniensatzdefinition. | Schnur |
| Metadaten | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. | jegliche |
| Parameter | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsreferenzen verwendet werden können. | ParameterDefinitions- |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup-[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweisen. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
| Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |
| Versionen | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
Verwendungsbeispiele
Terraform-Beispiele
Ein grundlegendes Beispiel für die Bereitstellung einer Richtliniensatzdefinition.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westus"
}
data "azapi_client_config" "current" {}
resource "azapi_resource" "policyDefinition" {
type = "Microsoft.Authorization/policyDefinitions@2021-06-01"
parent_id = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
name = var.resource_name
body = {
properties = {
description = ""
displayName = "my-policy-definition"
mode = "All"
parameters = {
allowedLocations = {
metadata = {
description = "The list of allowed locations for resources."
displayName = "Allowed locations"
strongType = "location"
}
type = "Array"
}
}
policyRule = {
if = {
not = {
field = "location"
in = "[parameters('allowedLocations')]"
}
}
then = {
effect = "audit"
}
}
policyType = "Custom"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "policySetDefinition" {
type = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}"
name = "acctestpolset-${var.resource_name}"
body = {
properties = {
description = ""
displayName = "acctestpolset-${var.resource_name}"
parameters = {
allowedLocations = {
metadata = {
description = "The list of allowed locations for resources."
displayName = "Allowed locations"
strongType = "location"
}
type = "Array"
}
}
policyDefinitions = [{
groupNames = []
parameters = {
listOfAllowedLocations = {
value = "[parameters('allowedLocations')]"
}
}
policyDefinitionId = azapi_resource.policyDefinition.id
policyDefinitionReferenceId = ""
}]
policyType = "Custom"
}
}
}