Microsoft.Authorization policySetDefinitions/versions 2023-04-01
Bicep-Ressourcendefinition
Der Ressourcentyp policySetDefinitions/versions 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/versions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions/versions@2023-04-01' = {
name: 'string'
parent: 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'
}
}
Eigenschaftswerte
policySetDefinitions/versions
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) |
parent | 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 vom Typ: policySetDefinitions |
properties | Die Eigenschaften der Definitionsversion des Richtliniensatzes. | PolicySetDefinitionVersionProperties |
PolicySetDefinitionVersionProperties
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 Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Benutzerdefiniert" "NotSpecified" "Statisch" |
version | Die Richtliniensatzdefinitionsversion im Format #.#.#. | Zeichenfolge |
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 diesen Wert 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 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. | Für Bicep können Sie die funktion any() verwenden. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp policySetDefinitions/versions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Verwaltungsgruppen : Siehe Bereitstellungsbefehle für Verwaltungsgruppen
- 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 im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource Microsoft.Authorization/policySetDefinitions/versions zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Authorization/policySetDefinitions/versions",
"apiVersion": "2023-04-01",
"name": "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"
}
}
Eigenschaftswerte
policySetDefinitions/versions
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions/versions" |
apiVersion | Die Version der Ressourcen-API | '2023-04-01' |
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) |
properties | Die Eigenschaften der Richtliniensatzdefinitionsversion. | PolicySetDefinitionVersionProperties |
PolicySetDefinitionVersionProperties
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 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" "NotSpecified" "Statisch" |
version | Die Definitionsversion des Richtliniensatzes im #.#.#.#-Format. | Zeichenfolge |
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 Validierung 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" "Boolean" 'DateTime' "Float" "Ganze Zahl" 'Objekt' "String" |
ParameterDefinitionsValueMetadata
Name | BESCHREIBUNG | Wert |
---|---|---|
assignPermissions | Legen Sie diesen Wert 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/versions 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/versions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions/versions@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"
}
})
}
Eigenschaftswerte
policySetDefinitions/versions
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.Authorization/policySetDefinitions/versions@2023-04-01" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) |
parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: policySetDefinitions |
properties | Die Eigenschaften der Richtliniensatzdefinitionsversion. | PolicySetDefinitionVersionProperties |
PolicySetDefinitionVersionProperties
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 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" "Custom" "NotSpecified" "Statisch" |
version | Die Definitionsversion des Richtliniensatzes im #.#.#.#-Format. | Zeichenfolge |
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 Validierung 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. |