Microsoft.Authorization policySetDefinitions

Artikel
12/20/2024

Bicep-resursdefinition

Resurstypen policySetDefinitions kan distribueras med åtgärder som mål:

Klientorganisation – Se klientdistributionskommandon* Hanteringsgrupper – Se distributionskommandon för hanteringsgrupp* Prenumeration – Se distributionskommandon för prenumerationer

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Authorization/policySetDefinitions-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2025-01-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
    parameters: {
      {customized property}: {
        allowedValues: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(Azure.Bicep.Types.Concrete.AnyType)
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        definitionVersion: 'string'
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any(Azure.Bicep.Types.Concrete.AnyType)
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

Namn	Beskrivning	Värde
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$` (krävs)
Egenskaper	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionProperties

ParameterDefinitioner

Namn	Beskrivning	Värde

ParameterDefinitionsValue

Namn	Beskrivning	Värde
allowedValues	De tillåtna värdena för parametern.	any[]
defaultValue	Standardvärdet för parametern om inget värde anges.	någon
metadata	Allmänna metadata för parametern.	ParameterDefinitionsValueMetadata
Schemat	Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för parametrar av objekttyp och följer implementeringen Json.NET Schema 2019-09. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.	någon
typ	Parameterns datatyp.	Matris "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Namn	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.	Bool
beskrivning	Beskrivningen av parametern.	sträng
displayName	Visningsnamnet för parametern.	sträng
strongType	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.	sträng

ParameterValues

Namn	Beskrivning	Värde

ParameterValuesValue

Namn	Beskrivning	Värde
värde	Värdet för parametern.	någon

PolicyDefinitionGroup

Namn	Beskrivning	Värde
additionalMetadataId	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.	sträng
kategori	Gruppens kategori.	sträng
beskrivning	Gruppens beskrivning.	sträng
displayName	Gruppens visningsnamn.	sträng
Namn	Namnet på gruppen.	sträng (krävs)

PolicyDefinitionReference

Namn	Beskrivning	Värde
definitionVersion	Den version av principdefinitionen som ska användas.	sträng
groupNames	Namnet på de grupper som den här principdefinitionsreferensen tillhör.	string[]
Parametrar	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.	ParameterValues
policyDefinitionId	ID:t för principdefinitionen eller principuppsättningsdefinitionen.	sträng (krävs)
policyDefinitionReferenceId	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.	sträng

PolicySetDefinitionProperties

Namn	Beskrivning	Värde
beskrivning	Definitionsbeskrivningen för principuppsättningen.	sträng
displayName	Visningsnamnet för principuppsättningsdefinitionen.	sträng
metadata	Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.	någon
Parametrar	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitioner	En matris med principdefinitionsreferenser.	PolicyDefinitionReference[] (krävs)
policyType	Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.	"BuiltIn" "Anpassad" "NotSpecified" "Statisk"
version	Principuppsättningens definitionsversion i #.#.#-format.	sträng
Versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

Resursdefinition för ARM-mall

Resurstypen policySetDefinitions kan distribueras med åtgärder som mål:

Klientorganisation – Se klientdistributionskommandon* Hanteringsgrupper – Se distributionskommandon för hanteringsgrupp* Prenumeration – Se distributionskommandon för prenumerationer

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Authorization/policySetDefinitions-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2025-01-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "definitionVersion": "string",
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2025-01-01'
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$` (krävs)
Egenskaper	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionProperties
typ	Resurstypen	"Microsoft.Authorization/policySetDefinitions"

ParameterDefinitioner

Namn	Beskrivning	Värde

ParameterDefinitionsValue

Namn	Beskrivning	Värde
allowedValues	De tillåtna värdena för parametern.	any[]
defaultValue	Standardvärdet för parametern om inget värde anges.	någon
metadata	Allmänna metadata för parametern.	ParameterDefinitionsValueMetadata
Schemat	Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för parametrar av objekttyp och följer implementeringen Json.NET Schema 2019-09. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.	någon
typ	Parameterns datatyp.	Matris "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Namn	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.	Bool
beskrivning	Beskrivningen av parametern.	sträng
displayName	Visningsnamnet för parametern.	sträng
strongType	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.	sträng

ParameterValues

Namn	Beskrivning	Värde

ParameterValuesValue

Namn	Beskrivning	Värde
värde	Värdet för parametern.	någon

PolicyDefinitionGroup

Namn	Beskrivning	Värde
additionalMetadataId	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.	sträng
kategori	Gruppens kategori.	sträng
beskrivning	Gruppens beskrivning.	sträng
displayName	Gruppens visningsnamn.	sträng
Namn	Namnet på gruppen.	sträng (krävs)

PolicyDefinitionReference

Namn	Beskrivning	Värde
definitionVersion	Den version av principdefinitionen som ska användas.	sträng
groupNames	Namnet på de grupper som den här principdefinitionsreferensen tillhör.	string[]
Parametrar	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.	ParameterValues
policyDefinitionId	ID:t för principdefinitionen eller principuppsättningsdefinitionen.	sträng (krävs)
policyDefinitionReferenceId	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.	sträng

PolicySetDefinitionProperties

Namn	Beskrivning	Värde
beskrivning	Definitionsbeskrivningen för principuppsättningen.	sträng
displayName	Visningsnamnet för principuppsättningsdefinitionen.	sträng
metadata	Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.	någon
Parametrar	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitioner	En matris med principdefinitionsreferenser.	PolicyDefinitionReference[] (krävs)
policyType	Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.	"BuiltIn" "Anpassad" "NotSpecified" "Statisk"
version	Principuppsättningens definitionsversion i #.#.#-format.	sträng
Versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen policySetDefinitions kan distribueras med åtgärder som mål:

hanteringsgrupper för klientorganisation* * prenumeration

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Authorization/policySetDefinitions-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          definitionVersion = "string"
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {
              value = ?
            }
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  })
}

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

Namn	Beskrivning	Värde
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$` (krävs)
Egenskaper	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionProperties
typ	Resurstypen	"Microsoft.Authorization/policySetDefinitions@2025-01-01"

ParameterDefinitioner

Namn	Beskrivning	Värde

ParameterDefinitionsValue

Namn	Beskrivning	Värde
allowedValues	De tillåtna värdena för parametern.	any[]
defaultValue	Standardvärdet för parametern om inget värde anges.	någon
metadata	Allmänna metadata för parametern.	ParameterDefinitionsValueMetadata
Schemat	Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för parametrar av objekttyp och följer implementeringen Json.NET Schema 2019-09. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.	någon
typ	Parameterns datatyp.	Matris "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Namn	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.	Bool
beskrivning	Beskrivningen av parametern.	sträng
displayName	Visningsnamnet för parametern.	sträng
strongType	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.	sträng

ParameterValues

Namn	Beskrivning	Värde

ParameterValuesValue

Namn	Beskrivning	Värde
värde	Värdet för parametern.	någon

PolicyDefinitionGroup

Namn	Beskrivning	Värde
additionalMetadataId	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.	sträng
kategori	Gruppens kategori.	sträng
beskrivning	Gruppens beskrivning.	sträng
displayName	Gruppens visningsnamn.	sträng
Namn	Namnet på gruppen.	sträng (krävs)

PolicyDefinitionReference

Namn	Beskrivning	Värde
definitionVersion	Den version av principdefinitionen som ska användas.	sträng
groupNames	Namnet på de grupper som den här principdefinitionsreferensen tillhör.	string[]
Parametrar	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.	ParameterValues
policyDefinitionId	ID:t för principdefinitionen eller principuppsättningsdefinitionen.	sträng (krävs)
policyDefinitionReferenceId	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.	sträng

PolicySetDefinitionProperties

Namn	Beskrivning	Värde
beskrivning	Definitionsbeskrivningen för principuppsättningen.	sträng
displayName	Visningsnamnet för principuppsättningsdefinitionen.	sträng
metadata	Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.	någon
Parametrar	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitioner	En matris med principdefinitionsreferenser.	PolicyDefinitionReference[] (krävs)
policyType	Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.	"BuiltIn" "Anpassad" "NotSpecified" "Statisk"
version	Principuppsättningens definitionsversion i #.#.#-format.	sträng
Versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

Dela via

Microsoft.Authorization policySetDefinitions

Bicep-resursdefinition

Resursformat

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

ParameterDefinitioner

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

ParameterValues

ParameterValuesValue

PolicyDefinitionGroup

PolicyDefinitionReference

PolicySetDefinitionProperties

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

ParameterDefinitioner

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

ParameterValues

ParameterValuesValue

PolicyDefinitionGroup

PolicyDefinitionReference

PolicySetDefinitionProperties

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

Microsoft.Authorization/policySetDefinitions

ParameterDefinitioner

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

ParameterValues

ParameterValuesValue

PolicyDefinitionGroup

PolicyDefinitionReference

PolicySetDefinitionProperties

Feedback

Ytterligare resurser