Microsoft.Authorization policySetDefinitions

Bicep-Ressourcendefinition

Der Ressourcentyp policySetDefinitions 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.

Gültige Bereitstellungsbereiche für die Ressource policySetDefinitions sind:

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-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {}
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {}
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

Eigenschaftswerte

policySetDefinitions

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. PolicySetDefinitionProperties

PolicySetDefinitionProperties

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. Für Bicep können Sie die funktion any() verwenden.
parameters Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsverweisen verwendet werden können. Objekt
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"

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. Objekt
policyDefinitionId Die ID der Richtliniendefinition oder Richtliniensatzdefinition. Zeichenfolge (erforderlich)
policyDefinitionReferenceId Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp policySetDefinitions 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.

Gültige Bereitstellungsbereiche für die Ressource policySetDefinitions sind:

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-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {},
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {},
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string"
  }
}

Eigenschaftswerte

policySetDefinitions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Authorization/policySetDefinitions"
apiVersion Die Version der Ressourcen-API '2021-06-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.
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.
properties Die Eigenschaften der Richtliniendefinition. PolicySetDefinitionProperties

PolicySetDefinitionProperties

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. Objekt
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"

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. Objekt
policyDefinitionId Die ID der Richtliniendefinition oder Richtliniensatzdefinition. Zeichenfolge (erforderlich)
policyDefinitionReferenceId Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp policySetDefinitions 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.

Gültige Bereitstellungsbereiche für die Ressource policySetDefinitions sind:

  • 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/policySetDefinitions-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {}
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {}
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
    }
  })
}

Eigenschaftswerte

policySetDefinitions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Authorization/policySetDefinitions@2021-06-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. PolicySetDefinitionProperties

PolicySetDefinitionProperties

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. Objekt
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"

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. Objekt
policyDefinitionId Die ID der Richtliniendefinition oder Richtliniensatzdefinition. Zeichenfolge (erforderlich)
policyDefinitionReferenceId Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz. Zeichenfolge