Microsoft.Authorization policyDefinitions
Bicep-Ressourcendefinition
Der Ressourcentyp policyDefinitions ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.
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 policyDefinitions 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 Microsoft.Authorization/policyDefinitions-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Eigenschaftswerte
policyDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| 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. |
| scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. | Zielressource Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden. |
| properties | Die Eigenschaften der Richtliniendefinition. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniendefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniendefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. | Für Bicep können Sie die funktion any() verwenden. |
| Modus | Der Richtliniendefinitionsmodus. Einige Beispiele sind All, Indexed, Microsoft.KeyVault.Data. | Zeichenfolge |
| parameters | Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. | ParameterDefinitions |
| policyRule | Die Richtlinienregel. | Für Bicep können Sie die funktion any() verwenden. |
| policyType | Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Benutzerdefiniert" "NotSpecified" "Statisch" |
| version | Die Richtliniendefinitionsversion im #.#.#.#-Format. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. | 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 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/. |
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. |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Bereitstellen einer Richtliniendefinition und Zuweisen zu einer Verwaltungsgruppe |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie der Zielverwaltungsgruppe zuweist. Derzeit kann diese Vorlage nicht über das Azure-Portal bereitgestellt werden. |
| Bereitstellen eines Richtlinienverweis und Zuweisens zu mehreren mgmt-Gruppen |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist. |
| Create einen Azure Virtual Network Manager und Beispiel-VNETs |
Diese Vorlage stellt einen Azure Virtual Network Manager und beispielbasierte virtuelle Netzwerke in der benannten Ressourcengruppe bereit. Es unterstützt mehrere Konnektivitätstopologien und Netzwerkgruppenmitgliedschaftstypen. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp policyDefinitions 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 policyDefinitions 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/policyDefinitions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Eigenschaftswerte
policyDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Authorization/policyDefinitions" |
| 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 Richtliniendefinitionseigenschaften. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniendefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniendefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren. | |
| Modus | Der Richtliniendefinitionsmodus. Einige Beispiele sind All, Indexed, Microsoft.KeyVault.Data. | Zeichenfolge |
| parameters | Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. | ParameterDefinitions |
| policyRule | Die Richtlinienregel. | |
| policyType | Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Benutzerdefiniert" "NotSpecified" "Statisch" |
| version | Die Richtliniendefinitionsversion im #.#.#.#-Format. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. | 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} |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Bereitstellen einer Richtliniendefinition und Zuweisen zu einer Verwaltungsgruppe |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie der Zielverwaltungsgruppe zuweist. Derzeit kann diese Vorlage nicht über das Azure-Portal bereitgestellt werden. |
| Bereitstellen eines Richtlinienverweis und Zuweisens zu mehreren mgmt-Gruppen |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist. |
| Create einen Azure Virtual Network Manager und Beispiel-VNETs |
Diese Vorlage stellt einen Azure Virtual Network Manager und beispielbasierte virtuelle Netzwerke in der benannten Ressourcengruppe bereit. Es unterstützt mehrere Konnektivitätstopologien und Netzwerkgruppenmitgliedschaftstypen. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp policyDefinitions 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 policyDefinitions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policyDefinitions-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Eigenschaftswerte
policyDefinitions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Authorization/policyDefinitions@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 Richtliniendefinition. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Die Beschreibung der Richtliniendefinition. | Zeichenfolge |
| displayName | Der Anzeigename der Richtliniendefinition. | Zeichenfolge |
| metadata | Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. | |
| Modus | Der Richtliniendefinitionsmodus. Einige Beispiele sind All, Indexed, Microsoft.KeyVault.Data. | Zeichenfolge |
| parameters | Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. | ParameterDefinitions |
| policyRule | Die Richtlinienregel. | |
| policyType | Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. | "BuiltIn" "Custom" "NotSpecified" "Statisch" |
| version | Die Richtliniendefinitionsversion im #.#.#.#-Format. | Zeichenfolge |
| versions | Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. | 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 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} |
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