Microsoft.Authorization policySetDefinitions/versions 2024-05-01
Bicep-Ressourcendefinition
Der ressourcentyp "policySetDefinitions/versions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Mandanten- – Siehe Mandantenbereitstellungsbefehle* Verwaltungsgruppen – Siehe Verwaltungsgruppenbereitstellungsbefehle* Abonnementbereitstellung – Siehe Bereitstellungsbefehle für Abonnements
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.Authorization/policySetDefinitions/versions" zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions/versions@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
parameters: {
{customized property}: {
allowedValues: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
definitionVersion: 'string'
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
}
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions/versions
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^\d+\.\d+\.\d+$ (erforderlich) |
Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: policySetDefinitions- |
Eigenschaften | Die Eigenschaften der Richtliniensatzdefinitionsversion. | PolicySetDefinitionVersionProperties- |
ParameterDefinitions
Name | Beschreibung | Wert |
---|
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. | 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 |
displayName | 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 |
displayName | 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 |
PolicySetDefinitionVersionProperties
Name | Beschreibung | Wert |
---|---|---|
Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
displayName | 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 Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |
ARM-Vorlagenressourcendefinition
Der ressourcentyp "policySetDefinitions/versions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Mandanten- – Siehe Mandantenbereitstellungsbefehle* Verwaltungsgruppen – Siehe Verwaltungsgruppenbereitstellungsbefehle* Abonnementbereitstellung – Siehe Bereitstellungsbefehle für Abonnements
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policySetDefinitions/versionsressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Authorization/policySetDefinitions/versions",
"apiVersion": "2024-05-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"
}
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions/versions
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die API-Version | '2024-05-01' |
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^\d+\.\d+\.\d+$ (erforderlich) |
Eigenschaften | Die Eigenschaften der Richtliniensatzdefinitionsversion. | PolicySetDefinitionVersionProperties- |
Art | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions/versions" |
ParameterDefinitions
Name | Beschreibung | Wert |
---|
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. | 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 |
displayName | 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 |
displayName | 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 |
PolicySetDefinitionVersionProperties
Name | Beschreibung | Wert |
---|---|---|
Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
displayName | 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 Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der ressourcentyp "policySetDefinitions/versions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Mandanten-* -Verwaltungsgruppen* Abonnement-
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.Authorization/policySetDefinitions/versions" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions/versions@2024-05-01"
name = "string"
body = jsonencode({
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"
}
})
}
Eigenschaftswerte
Microsoft.Authorization/policySetDefinitions/versions
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^\d+\.\d+\.\d+$ (erforderlich) |
parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: policySetDefinitions- |
Eigenschaften | Die Eigenschaften der Richtliniensatzdefinitionsversion. | PolicySetDefinitionVersionProperties- |
Art | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions/versions@2024-05-01" |
ParameterDefinitions
Name | Beschreibung | Wert |
---|
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. | 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 |
displayName | 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 |
displayName | 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 |
PolicySetDefinitionVersionProperties
Name | Beschreibung | Wert |
---|---|---|
Beschreibung | Die Beschreibung der Richtliniensatzdefinition. | Schnur |
displayName | 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 Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | 'BuiltIn' 'Benutzerdefiniert' "Nicht angegeben" "Statisch" |
Version | Die Definitionsversion des Richtliniensatzes im #.#.#-Format. | Schnur |