Microsoft.Authorization policyAssignments 2020-09-01
Bicep-Ressourcendefinition
Der Ressourcentyp policyAssignments 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 policyAssignments kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
- Abonnements – Siehe Befehle zur Abonnementbereitstellung
- Verwaltungsgruppen : Siehe Bereitstellungsbefehle für Verwaltungsgruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policyAssignments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Authorization/policyAssignments@2020-09-01' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
identity: {
type: 'string'
}
properties: {
description: 'string'
displayName: 'string'
enforcementMode: 'string'
metadata: any()
nonComplianceMessages: [
{
message: 'string'
policyDefinitionReferenceId: 'string'
}
]
notScopes: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
}
}
Eigenschaftswerte
policyAssignments
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenbegrenzung: Anzeigename 1-128 1-64 Ressourcenname 1-24 Ressourcenname im Verwaltungsgruppenbereich Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| location | Der Speicherort der Richtlinienzuweisung. Nur erforderlich, wenn verwaltete Identität verwendet wird. | Zeichenfolge |
| 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. |
| Identität | Die verwaltete Identität, die der Richtlinienzuweisung zugeordnet ist. | Identität |
| properties | Eigenschaften für die Richtlinienzuweisung. | PolicyAssignmentProperties |
Identity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp. Dies ist das einzige erforderliche Feld, wenn einer Ressource eine systemseitig zugewiesene Identität hinzugefügt wird. | "Keine" "SystemAssigned" |
PolicyAssignmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Diese Meldung ist Teil der Antwort im Falle eines Richtlinienverstoßes. | Zeichenfolge |
| displayName | Der Anzeigename der Richtlinienzuweisung. | Zeichenfolge |
| enforcementMode | Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce. | 'Standardwert' "DoNotEnforce" |
| metadata | Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. | Für Bicep können Sie die funktion any() verwenden. |
| nonComplianceMessages | Die Meldungen, die beschreiben, warum eine Ressource nicht mit der Richtlinie konform ist. | NonComplianceMessage[] |
| notScopes | Die ausgeschlossenen Bereiche der Richtlinie. | string[] |
| parameters | Die Parameterwerte für die zugewiesene Richtlinienregel. Die Schlüssel sind die Parameternamen. | ParameterValues |
| policyDefinitionId | Die ID der zugewiesenen Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge |
NonComplianceMessage
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| message | Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Konformitätsergebnissen der Ressource gezeigt. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Die Verweis-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht vorgesehen ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben wird, gilt die Meldung für alle Richtlinien, die durch diese Richtlinienzuweisung zugewiesen werden. | 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. |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp 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 einer Richtlinien def und Zuweisen zu mehreren Mgmt-Gruppen |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist. |
| Zuweisen einer integrierten Richtlinie zu einer vorhandenen Ressourcengruppe |
Diese Vorlage weist einer vorhandenen Ressourcengruppe eine integrierte Richtlinie zu. |
| Create 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 policyAssignments 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 policyAssignments kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
- Abonnements – Siehe Befehle zur Abonnementbereitstellung
- Verwaltungsgruppen : Siehe Bereitstellungsbefehle für Verwaltungsgruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policyAssignments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Authorization/policyAssignments",
"apiVersion": "2020-09-01",
"name": "string",
"location": "string",
"scope": "string",
"identity": {
"type": "string"
},
"properties": {
"description": "string",
"displayName": "string",
"enforcementMode": "string",
"metadata": {},
"nonComplianceMessages": [
{
"message": "string",
"policyDefinitionReferenceId": "string"
}
],
"notScopes": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string"
}
}
Eigenschaftswerte
policyAssignments
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Authorization/policyAssignments" |
| apiVersion | Die Version der Ressourcen-API | '2020-09-01' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenbegrenzung: Anzeigename 1-128 1-64 Ressourcenname 1-24 Ressourcenname im Verwaltungsgruppenbereich Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| location | Der Speicherort der Richtlinienzuweisung. Nur erforderlich, wenn verwaltete Identität verwendet wird. | Zeichenfolge |
| scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. | Zielressource Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll. |
| Identität | Die verwaltete Identität, die der Richtlinienzuweisung zugeordnet ist. | Identität |
| properties | Eigenschaften für die Richtlinienzuweisung. | PolicyAssignmentProperties |
Identity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp. Dies ist das einzige erforderliche Feld, wenn einer Ressource eine systemseitig zugewiesene Identität hinzugefügt wird. | "Keine" "SystemAssigned" |
PolicyAssignmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Diese Meldung ist Teil der Antwort im Falle eines Richtlinienverstoßes. | Zeichenfolge |
| displayName | Der Anzeigename der Richtlinienzuweisung. | Zeichenfolge |
| enforcementMode | Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce. | 'Standardwert' "DoNotEnforce" |
| metadata | Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. | |
| nonComplianceMessages | Die Meldungen, die beschreiben, warum eine Ressource nicht mit der Richtlinie konform ist. | NonComplianceMessage[] |
| notScopes | Die ausgeschlossenen Bereiche der Richtlinie. | string[] |
| parameters | Die Parameterwerte für die zugewiesene Richtlinienregel. Die Schlüssel sind die Parameternamen. | ParameterValues |
| policyDefinitionId | Die ID der zugewiesenen Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge |
NonComplianceMessage
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| message | Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Konformitätsergebnissen der Ressource gezeigt. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Die Verweis-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht vorgesehen ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben wird, gilt die Meldung für alle Richtlinien, die durch diese Richtlinienzuweisung zugewiesen werden. | Zeichenfolge |
ParameterValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ParameterValuesValue |
ParameterValuesValue
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| value | Der Wert des Parameters. |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp 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 einer Richtlinien def und Zuweisen zu mehreren Mgmt-Gruppen |
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist. |
| Zuweisen einer integrierten Richtlinie zu einer vorhandenen Ressourcengruppe |
Diese Vorlage weist einer vorhandenen Ressourcengruppe eine integrierte Richtlinie zu. |
| Create 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-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp policyAssignments 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 policyAssignments kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
- Abonnements
- Verwaltungsgruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Authorization/policyAssignments-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyAssignments@2020-09-01"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
description = "string"
displayName = "string"
enforcementMode = "string"
nonComplianceMessages = [
{
message = "string"
policyDefinitionReferenceId = "string"
}
]
notScopes = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
}
})
}
Eigenschaftswerte
policyAssignments
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Authorization/policyAssignments@2020-09-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenbegrenzung: Anzeigename 1-128 1-64 Ressourcenname 1-24 Ressourcenname im Verwaltungsgruppenbereich Gültige Zeichen: Der Anzeigename kann beliebige Zeichen enthalten. Der Ressourcenname kann nicht verwenden: <>*%&:\?.+/ oder Steuerzeichen. Darf nicht mit einem Punkt oder Leerzeichen enden. |
| location | Der Speicherort der Richtlinienzuweisung. Nur erforderlich, wenn verwaltete Identität verwendet wird. | Zeichenfolge |
| parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
| Identität | Die verwaltete Identität, die der Richtlinienzuweisung zugeordnet ist. | Identität |
| properties | Eigenschaften für die Richtlinienzuweisung. | PolicyAssignmentProperties |
Identity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer systemseitig zugewiesenen Identität zu einer Ressource. | "SystemAssigned" |
PolicyAssignmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Diese Nachricht ist Teil der Antwort im Falle eines Richtlinienverstoßes. | Zeichenfolge |
| displayName | Der Anzeigename der Richtlinienzuweisung. | Zeichenfolge |
| enforcementMode | Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce. | "Standard" "DoNotEnforce" |
| metadata | Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren. | |
| nonComplianceMessages | Die Meldungen, die beschreiben, warum eine Ressource nicht mit der Richtlinie konform ist. | NonComplianceMessage[] |
| notScopes | Die ausgeschlossenen Bereiche der Richtlinie. | string[] |
| parameters | Die Parameterwerte für die zugewiesene Richtlinienregel. Die Schlüssel sind die Parameternamen. | ParameterValues |
| policyDefinitionId | Die ID der zugewiesenen Richtliniendefinition oder Richtliniensatzdefinition. | Zeichenfolge |
NonComplianceMessage
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| message | Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt. | Zeichenfolge (erforderlich) |
| policyDefinitionReferenceId | Die Referenz-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht bestimmt ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben ist, gilt die Nachricht für alle Richtlinien, die von dieser Richtlinienzuweisung zugewiesen werden. | 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