Microsoft.Authorization policySetDefinitions
Bicep-Ressourcendefinition
Der Ressourcentyp policySetDefinitions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in Bicep.
Der ressourcentyp policySetDefinitions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Verwaltungsgruppen : Siehe Verwaltungsgruppenbereitstellungsbefehle
- Abonnements : Siehe Befehle zur Abonnementbereitstellung
Sie können auf diesen Ressourcentyp als schreibgeschützte Ressource auf der Ebene von: Mandanten verweisen.
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 Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Eigenschaftswerte
policySetDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-128 Anzeigename 1-64 Ressourcenname Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. | Zielressource Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden. |
| properties | Die Richtliniensatzdefinitionseigenschaften. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniensatzdefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniensatzdefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren. | Für Bicep können Sie die Funktion any() verwenden. |
| parameters | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsverweise verwendet werden können. | ParameterDefinitions |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweise innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweise. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Benutzerdefiniert" "NotSpecified" "Statisch" |
| version | Die Richtliniensatzdefinitionsversion im Format #.#.#. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
ParameterDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| defaultValue | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | Für Bicep können Sie die Funktion any() verwenden. |
| metadata | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata |
| schema | Ermöglicht die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der 2019-09-Implementierung des Json.NET-Schemas. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testen von Schemaentwürfen unter https://www.jsonschemavalidator.net/. |
Für Bicep können Sie die Funktion any() verwenden. |
| Typ | Der Datentyp des Parameters. | Array "Boolesch" 'DateTime' "Float" 'Ganzzahlige Zahl' 'Objekt' 'Zeichenfolge' |
ParameterDefinitionsValueMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| assignPermissions | Legen Sie auf true fest, damit Azure-Portal während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellen. Diese Eigenschaft ist hilfreich, wenn Sie Berechtigungen außerhalb des Zuweisungsbereichs zuweisen möchten. | bool |
| description | Die Beschreibung des Parameters. | Zeichenfolge |
| displayName | Der Anzeigename für den Parameter. | Zeichenfolge |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste von Werten bereit, aus der der Benutzer auswählen kann. | Zeichenfolge |
| {angepasste Eigenschaft} | Für Bicep können Sie die Funktion any() verwenden. |
PolicyDefinitionGroup
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält. | Zeichenfolge |
| category | Die Kategorie der Gruppe. | Zeichenfolge |
| description | Die Beschreibung der Gruppe. | Zeichenfolge |
| displayName | Der Anzeigename der Gruppe. | Zeichenfolge |
| name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| parameters | Die Parameterwerte für die Richtlinienregel, 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. | Zeichenfolge |
ParameterValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterValuesValue |
ParameterValuesValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| value | Der Wert des Parameters. | Für Bicep können Sie die Funktion any() verwenden. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp policySetDefinitions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in ARM-Vorlagen.
Der ressourcentyp policySetDefinitions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Verwaltungsgruppen : Siehe Verwaltungsgruppenbereitstellungsbefehle
- Abonnements : Siehe Befehle zur Abonnementbereitstellung
Sie können auf diesen Ressourcentyp als schreibgeschützte Ressource auf der Ebene von: Mandanten verweisen.
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": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Eigenschaftswerte
policySetDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Authorization/policySetDefinitions" |
| apiVersion | Die Ressourcen-API-Version | '2023-04-01' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-128 Anzeigename 1-64 Ressourcenname Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. | Zielressource Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll. |
| properties | Die Richtliniensatzdefinitionseigenschaften. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniensatzdefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniensatzdefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren. | |
| parameters | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsverweise verwendet werden können. | ParameterDefinitions |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweise innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweise. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Benutzerdefiniert" "NotSpecified" "Statisch" |
| version | Die Richtliniensatzdefinitionsversion im Format #.#.#. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
ParameterDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| defaultValue | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | |
| metadata | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata |
| schema | Ermöglicht die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der 2019-09-Implementierung des Json.NET-Schemas. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testen von Schemaentwürfen unter https://www.jsonschemavalidator.net/. |
|
| Typ | Der Datentyp des Parameters. | Array "Boolesch" 'DateTime' "Float" 'Ganzzahlige Zahl' 'Objekt' 'Zeichenfolge' |
ParameterDefinitionsValueMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| assignPermissions | Legen Sie auf true fest, damit Azure-Portal während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellen. Diese Eigenschaft ist hilfreich, wenn Sie Berechtigungen außerhalb des Zuweisungsbereichs zuweisen möchten. | bool |
| description | Die Beschreibung des Parameters. | Zeichenfolge |
| displayName | Der Anzeigename für den Parameter. | Zeichenfolge |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste von Werten bereit, aus der der Benutzer auswählen kann. | Zeichenfolge |
| {angepasste Eigenschaft} |
PolicyDefinitionGroup
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zu der Gruppe enthält. | Zeichenfolge |
| category | Die Kategorie der Gruppe. | Zeichenfolge |
| description | Die Beschreibung der Gruppe. | Zeichenfolge |
| displayName | Der Anzeigename der Gruppe. | Zeichenfolge |
| name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| parameters | Die Parameterwerte für die Richtlinienregel, 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. | Zeichenfolge |
ParameterValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterValuesValue |
ParameterValuesValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| value | Der Wert des Parameters. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp policySetDefinitions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die parent_id -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen.
Der Ressourcentyp policySetDefinitions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Verwaltungsgruppen
- Abonnements
Sie können auf diesen Ressourcentyp als schreibgeschützte Ressource auf der Ebene von: Mandanten verweisen.
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policySetDefinitions-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
groupNames = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Eigenschaftswerte
policySetDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions@2023-04-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenbegrenzung: Anzeigename 1-128 1-64 Ressourcenname Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
| properties | Die Eigenschaften der Richtliniensatzdefinition. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniensatzdefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniensatzdefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. | |
| parameters | Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsverweisen verwendet werden können. | ParameterDefinitions |
| policyDefinitionGroups | Die Metadaten, die Gruppen von Richtliniendefinitionsverweise innerhalb der Richtliniensatzdefinition beschreiben. | PolicyDefinitionGroup[] |
| policyDefinitions | Ein Array von Richtliniendefinitionsverweise. | PolicyDefinitionReference[] (erforderlich) |
| policyType | Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Custom" "NotSpecified" "Statisch" |
| version | Die Richtliniensatzdefinitionsversion im Format #.#.#. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition. | string[] |
ParameterDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedValues | Die zulässigen Werte für den Parameter. | any[] |
| defaultValue | Der Standardwert für den Parameter, wenn kein Wert angegeben wird. | |
| metadata | Allgemeine Metadaten für den Parameter. | ParameterDefinitionsValueMetadata |
| schema | Ermöglicht die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der 2019-09-Implementierung des Json.NET-Schemas. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testen von Schemaentwürfen unter https://www.jsonschemavalidator.net/. |
|
| Typ | Der Datentyp des Parameters. | "Array" "Boolesch" "DateTime" "Float" "Ganze Zahl" "Objekt" "String" |
ParameterDefinitionsValueMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| assignPermissions | Legen Sie auf true fest, damit Azure-Portal während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellen. Diese Eigenschaft ist hilfreich, wenn Sie Berechtigungen außerhalb des Zuweisungsbereichs zuweisen möchten. | bool |
| description | Die Beschreibung des Parameters. | Zeichenfolge |
| displayName | Der Anzeigename für den Parameter. | Zeichenfolge |
| strongType | Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste von Werten bereit, aus der der Benutzer auswählen kann. | Zeichenfolge |
| {angepasste Eigenschaft} |
PolicyDefinitionGroup
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| additionalMetadataId | Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält. | Zeichenfolge |
| category | Die Kategorie der Gruppe. | Zeichenfolge |
| description | Die Beschreibung der Gruppe. | Zeichenfolge |
| displayName | Der Anzeigename der Gruppe. | Zeichenfolge |
| name | Der Name der Gruppe. | Zeichenfolge (erforderlich) |
PolicyDefinitionReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| groupNames | Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. | string[] |
| parameters | Die Parameterwerte für die Richtlinienregel, 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. | Zeichenfolge |
ParameterValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterValuesValue |
ParameterValuesValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| value | Der Wert des Parameters. |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für