Freigeben über


Microsoft.Authorization policyDefinitions 2018-05-01

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@2018-05-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(...)
    mode: 'string'
    parameters: any(...)
    policyRule: any(...)
    policyType: 'string'
  }
}

Eigenschaftswerte

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-
scope Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
Anzeigename Der Anzeigename der Richtliniendefinition. Schnur
Metadaten Die Metadaten der Richtliniendefinition. jegliche
Modus Der Richtliniendefinitionsmodus. Mögliche Werte sind "NotSpecified", "Indexed" und "All". "Alle"
"Indiziert"
"Nicht angegeben"
Parameter Erforderlich, wenn ein Parameter in der Richtlinienregel verwendet wird. jegliche
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn und Custom. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"

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": "2018-05-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {},
    "policyRule": {},
    "policyType": "string"
  }
}

Eigenschaftswerte

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
apiVersion Die API-Version '2018-05-01'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-
Art Der Ressourcentyp "Microsoft.Authorization/policyDefinitions"

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
Anzeigename Der Anzeigename der Richtliniendefinition. Schnur
Metadaten Die Metadaten der Richtliniendefinition. jegliche
Modus Der Richtliniendefinitionsmodus. Mögliche Werte sind "NotSpecified", "Indexed" und "All". "Alle"
"Indiziert"
"Nicht angegeben"
Parameter Erforderlich, wenn ein Parameter in der Richtlinienregel verwendet wird. jegliche
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn und Custom. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"

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:

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@2018-05-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      mode = "string"
      parameters = ?
      policyRule = ?
      policyType = "string"
    }
  }
}

Eigenschaftswerte

Microsoft.Authorization/policyDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Die Richtliniendefinitionseigenschaften. PolicyDefinitionProperties-
Art Der Ressourcentyp "Microsoft.Authorization/policyDefinitions@2018-05-01"

PolicyDefinitionProperties

Name Beschreibung Wert
Beschreibung Die Beschreibung der Richtliniendefinition. Schnur
Anzeigename Der Anzeigename der Richtliniendefinition. Schnur
Metadaten Die Metadaten der Richtliniendefinition. jegliche
Modus Der Richtliniendefinitionsmodus. Mögliche Werte sind "NotSpecified", "Indexed" und "All". "Alle"
"Indiziert"
"Nicht angegeben"
Parameter Erforderlich, wenn ein Parameter in der Richtlinienregel verwendet wird. jegliche
policyRule Die Richtlinienregel. jegliche
policyType Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn und Custom. 'BuiltIn'
'Benutzerdefiniert'
"Nicht angegeben"

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von Autorisierungsrichtliniendefinitionen.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "policyDefinition" {
  type      = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  parent_id = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      displayName = "my-policy-definition"
      mode        = "All"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyRule = {
        if = {
          not = {
            field = "location"
            in    = "[parameters('allowedLocations')]"
          }
        }
        then = {
          effect = "audit"
        }
      }
      policyType = "Custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}