Freigeben über


Microsoft.Authorization policyDefinitions

Bicep-Ressourcendefinition

Der policyDefinitions-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 Bicep hinzu.

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2025-03-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    externalEvaluationEnforcementSettings: {
      endpointSettings: {
        details: any(...)
        kind: 'string'
      }
      missingTokenAction: 'string'
      resultLifespan: 'string'
      roleDefinitionIds: [
        'string'
      ]
    }
    metadata: any(...)
    mode: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any(...)
        ]
        defaultValue: any(...)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(...)
        type: 'string'
      }
    }
    policyRule: any(...)
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Eigenschaftswerte

ExternalEvaluationEndpointSettings

Name Beschreibung Wert
Details Die Details des Endpunkts. jegliche
Art Die Art des Endpunkts. Schnur

ExternalEvaluationEnforcementSettings

Name Beschreibung Wert
endpointSettings Die Einstellungen eines externen Endpunkts, der Auswertungsergebnisse bereitstellt. ExternalEvaluationEndpointSettings
missingTokenAction Was zu tun ist, wenn eine Erzwingungsrichtlinie ausgewertet wird, die eine externe Auswertung erfordert und das Token fehlt. Mögliche Werte sind "Audit" und "Verweigern". Schnur
resultLifespan Die Lebensdauer des Endpunktaufrufergebnisses, nach dem er nicht mehr gültig ist. Es wird erwartet, dass der Wert dem ISO 8601-Dauerformat entspricht. Schnur

Zwänge:
Pattern = ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$
roleDefinitionIds Ein Array der Rollendefinitions-IDs, die die MSI-Datei der Zuordnung benötigt, um den Endpunkt aufzurufen. string[]

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-

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

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
displayName Der Anzeigename der Richtliniendefinition. Schnur
externalEvaluationEnforcementSettings Die Details der Quelle externer Auswertungsergebnisse, die von der Richtlinie während der Erzwingungsbewertung benötigt werden. ExternalEvaluationEnforcementSettings
Metadaten Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. jegliche
Modus Der Richtliniendefinitionsmodus. Einige Beispiele sind "All", "Indexed", "Microsoft.KeyVault.Data". Schnur
Parameter Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. ParameterDefinitions-
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"
"Statisch"
Version Die Richtliniendefinitionsversion im #.#.#.#-Format. Schnur
Versionen Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. string[]

Verwendungsbeispiele

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
Erstellen eines Azure Virtual Network Manager und Beispiel-VNETs- Diese Vorlage stellt einen Azure Virtual Network Manager bereit und stellt virtuelle Netzwerke in der benannten Ressourcengruppe bereit. Sie unterstützt mehrere Verbindungstopologien und Netzwerkgruppenmitgliedschaftstypen.
Bereitstellen einer Richtlinienverzögerung und Zuweisen zu mehreren Mgmt-Gruppen Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist.
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.

ARM-Vorlagenressourcendefinition

Der policyDefinitions-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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": "2025-03-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalEvaluationEnforcementSettings": {
      "endpointSettings": {
        "details": {},
        "kind": "string"
      },
      "missingTokenAction": "string",
      "resultLifespan": "string",
      "roleDefinitionIds": [ "string" ]
    },
    "metadata": {},
    "mode": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyRule": {},
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Eigenschaftswerte

ExternalEvaluationEndpointSettings

Name Beschreibung Wert
Details Die Details des Endpunkts. jegliche
Art Die Art des Endpunkts. Schnur

ExternalEvaluationEnforcementSettings

Name Beschreibung Wert
endpointSettings Die Einstellungen eines externen Endpunkts, der Auswertungsergebnisse bereitstellt. ExternalEvaluationEndpointSettings
missingTokenAction Was zu tun ist, wenn eine Erzwingungsrichtlinie ausgewertet wird, die eine externe Auswertung erfordert und das Token fehlt. Mögliche Werte sind "Audit" und "Verweigern". Schnur
resultLifespan Die Lebensdauer des Endpunktaufrufergebnisses, nach dem er nicht mehr gültig ist. Es wird erwartet, dass der Wert dem ISO 8601-Dauerformat entspricht. Schnur

Zwänge:
Pattern = ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$
roleDefinitionIds Ein Array der Rollendefinitions-IDs, die die MSI-Datei der Zuordnung benötigt, um den Endpunkt aufzurufen. string[]

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
apiVersion Die API-Version '2025-03-01'
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-
Art Der Ressourcentyp "Microsoft.Authorization/policyDefinitions"

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

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
displayName Der Anzeigename der Richtliniendefinition. Schnur
externalEvaluationEnforcementSettings Die Details der Quelle externer Auswertungsergebnisse, die von der Richtlinie während der Erzwingungsbewertung benötigt werden. ExternalEvaluationEnforcementSettings
Metadaten Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. jegliche
Modus Der Richtliniendefinitionsmodus. Einige Beispiele sind "All", "Indexed", "Microsoft.KeyVault.Data". Schnur
Parameter Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. ParameterDefinitions-
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"
"Statisch"
Version Die Richtliniendefinitionsversion im #.#.#.#-Format. Schnur
Versionen Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. string[]

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Erstellen eines Azure Virtual Network Manager und Beispiel-VNETs-

Bereitstellen in Azure
Diese Vorlage stellt einen Azure Virtual Network Manager bereit und stellt virtuelle Netzwerke in der benannten Ressourcengruppe bereit. Sie unterstützt mehrere Verbindungstopologien und Netzwerkgruppenmitgliedschaftstypen.
Bereitstellen einer Richtlinienverzögerung und Zuweisen zu mehreren Mgmt-Gruppen

Bereitstellen in Azure
Diese Vorlage ist eine Vorlage auf Verwaltungsgruppenebene, die eine Richtliniendefinition erstellt und diese Richtlinie mehreren Verwaltungsgruppen zuweist.
Bereitstellen einer Richtliniendefinition und Zuweisen zu einer Verwaltungsgruppe

Bereitstellen in Azure
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.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der policyDefinitions-Ressourcentyp 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 Microsoft.Authorization/policyDefinitions-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2025-03-01"
  name = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      externalEvaluationEnforcementSettings = {
        endpointSettings = {
          details = ?
          kind = "string"
        }
        missingTokenAction = "string"
        resultLifespan = "string"
        roleDefinitionIds = [
          "string"
        ]
      }
      metadata = ?
      mode = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyRule = ?
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  }
}

Eigenschaftswerte

ExternalEvaluationEndpointSettings

Name Beschreibung Wert
Details Die Details des Endpunkts. jegliche
Art Die Art des Endpunkts. Schnur

ExternalEvaluationEnforcementSettings

Name Beschreibung Wert
endpointSettings Die Einstellungen eines externen Endpunkts, der Auswertungsergebnisse bereitstellt. ExternalEvaluationEndpointSettings
missingTokenAction Was zu tun ist, wenn eine Erzwingungsrichtlinie ausgewertet wird, die eine externe Auswertung erfordert und das Token fehlt. Mögliche Werte sind "Audit" und "Verweigern". Schnur
resultLifespan Die Lebensdauer des Endpunktaufrufergebnisses, nach dem er nicht mehr gültig ist. Es wird erwartet, dass der Wert dem ISO 8601-Dauerformat entspricht. Schnur

Zwänge:
Pattern = ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$
roleDefinitionIds Ein Array der Rollendefinitions-IDs, die die MSI-Datei der Zuordnung benötigt, um den Endpunkt aufzurufen. string[]

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-
Art Der Ressourcentyp "Microsoft.Authorization/policyDefinitions@2025-03-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

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
displayName Der Anzeigename der Richtliniendefinition. Schnur
externalEvaluationEnforcementSettings Die Details der Quelle externer Auswertungsergebnisse, die von der Richtlinie während der Erzwingungsbewertung benötigt werden. ExternalEvaluationEnforcementSettings
Metadaten Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren. jegliche
Modus Der Richtliniendefinitionsmodus. Einige Beispiele sind "All", "Indexed", "Microsoft.KeyVault.Data". Schnur
Parameter Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. ParameterDefinitions-
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"
"Statisch"
Version Die Richtliniendefinitionsversion im #.#.#.#-Format. Schnur
Versionen Eine Liste der verfügbaren Versionen für diese Richtliniendefinition. string[]