Microsoft.Authorization policySetDefinitions

Artikel
05/09/2024

Bicep-resursdefinition

Resurstypen policySetDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.

Använd egenskapen för den scope här resursen för att ange omfånget för den här resursen. Se Ange omfång för tilläggsresurser i Bicep.

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

Hanteringsgrupper – Se kommandon för distribution av hanteringsgrupper
Prenumerationer – Se kommandon för prenumerationsdistribution

Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer

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@2023-04-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {
      {customized property}: {
        allowedValues: [
          any
        ]
        defaultValue: any()
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
          {customized property}: any()
        }
        schema: any()
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any()
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Egenskapsvärden

policySetDefinitions

Name	Beskrivning	Värde
name	Resursnamnet	sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: `<>*%&:\?.+/` eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg.
omfång	Använd när du skapar en tilläggsresurs i ett omfång som skiljer sig från distributionsomfånget.	Målresurs För Bicep anger du den här egenskapen till det symboliska namnet på resursen för att tillämpa tilläggsresursen.
properties	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

Name	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 objekt och är vanligtvis en samling nyckel/värde-par.	För Bicep kan du använda funktionen any().
parametrar	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitions	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	Definitionsversionen för principuppsättningen i #.#.#-format.	sträng
versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

ParameterDefinitions

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterDefinitionsValue

ParameterDefinitionsValue

Name	Beskrivning	Värde
allowedValues	Tillåtna värden för parametern.	any[]
Standardvärde	Standardvärdet för parametern om inget värde anges.	För Bicep kan du använda funktionen any().
metadata	Allmänna metadata för parametern .	ParameterDefinitionsValueMetadata
schema	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 objekttypsparametrar och följer implementeringen Json.NET Schema 2019-09. Du kan läsa mer om att använda scheman på `https://json-schema.org/` och testa utkastscheman på `https://www.jsonschemavalidator.net/.`	För Bicep kan du använda funktionen any().
typ	Parameterns datatyp.	Matris "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Name	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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.	boolesk
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
{anpassad egenskap}		För Bicep kan du använda funktionen any().

PolicyDefinitionGroup

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

PolicyDefinitionReference

Name	Beskrivning	Värde
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 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

ParameterValues

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterValuesValue

ParameterValuesValue

Name	Beskrivning	Värde
värde	Värdet för parametern.	För Bicep kan du använda funktionen any().

Resursdefinition för ARM-mall

Resurstypen policySetDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.

Använd egenskapen för scope den här resursen för att ange omfånget för den här resursen. Se Ange omfång för tilläggsresurser i ARM-mallar.

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

Hanteringsgrupper – Se distributionskommandon för hanteringsgrupp
Prenumerationer – Se distributionskommandon för prenumerationer

Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer

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": "2023-04-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ object ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string",
          "{customized property}": {}
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Egenskapsvärden

policySetDefinitions

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.Authorization/policySetDefinitions"
apiVersion	Resurs-API-versionen	'2023-04-01'
name	Resursnamnet	sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: `<>*%&:\?.+/` eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg.
omfång	Använd när du skapar en tilläggsresurs i ett omfång som skiljer sig från distributionsomfånget.	Målresurs För JSON anger du värdet till det fullständiga namnet på resursen som tilläggsresursen ska tillämpas på.
properties	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

Name	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 objekt och är vanligtvis en samling nyckel/värde-par.
parametrar	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitions	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	Definitionsversionen för principuppsättningen i #.#.#-format.	sträng
versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

ParameterDefinitions

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterDefinitionsValue

ParameterDefinitionsValue

Name	Beskrivning	Värde
allowedValues	Tillåtna värden för parametern.	any[]
Standardvärde	Standardvärdet för parametern om inget värde anges.
metadata	Allmänna metadata för parametern .	ParameterDefinitionsValueMetadata
schema	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 objekttypsparametrar och följer implementeringen Json.NET Schema 2019-09. Du kan läsa mer om att använda scheman på `https://json-schema.org/` och testa utkastscheman på `https://www.jsonschemavalidator.net/.`
typ	Parameterns datatyp.	Matris "Booleskt" "DateTime" "Float" Heltal "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Name	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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.	boolesk
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
{anpassad egenskap}

PolicyDefinitionGroup

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

PolicyDefinitionReference

Name	Beskrivning	Värde
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 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

ParameterValues

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterValuesValue

ParameterValuesValue

Name	Beskrivning	Värde
värde	Värdet för parametern.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen policySetDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.

Använd egenskapen för parent_id den här resursen för att ange omfånget för den här resursen.

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

Hanteringsgrupper
Prenumerationer

Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer

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@2023-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {
        {customized property} = {
          allowedValues = [ object ]
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {}
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  })
}

Egenskapsvärden

policySetDefinitions

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.Authorization/policySetDefinitions@2023-04-01"
name	Resursnamnet	sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: `<>*%&:\?.+/` eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg.
parent_id	ID:t för resursen som den här tilläggsresursen ska tillämpas på.	sträng (krävs)
properties	Definitionsegenskaperna för principuppsättningen.	PolicySetDefinitionEgenskaper

PolicySetDefinitionEgenskaper

Name	Beskrivning	Värde
beskrivning	Definitionsbeskrivningen för principuppsättningen.	sträng
displayName	Visningsnamnet för principuppsättningsdefinitionen.	sträng
metadata	Definitionsmetadata för principuppsättningar. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
parametrar	Principuppsättningens definitionsparametrar som kan användas i principdefinitionsreferenser.	ParameterDefinitions
policyDefinitionGroups	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.	PolicyDefinitionGroup[]
policyDefinitions	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	Definitionsversionen för principuppsättningen i #.#.#-format.	sträng
versioner	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.	string[]

ParameterDefinitions

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterDefinitionsValue

ParameterDefinitionsValue

Name	Beskrivning	Värde
allowedValues	Tillåtna värden för parametern.	any[]
Standardvärde	Standardvärdet för parametern om inget värde anges.
metadata	Allmänna metadata för parametern .	ParameterDefinitionsValueMetadata
schema	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 objekttypsparametrar och följer implementeringen Json.NET Schema 2019-09. Du kan läsa mer om att använda scheman på `https://json-schema.org/` och testa utkastscheman på `https://www.jsonschemavalidator.net/.`
typ	Parameterns datatyp.	"Matris" "Booleskt" "DateTime" "Float" "Heltal" "Objekt" "Sträng"

ParameterDefinitionsValueMetadata

Name	Beskrivning	Värde
assignPermissions	Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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.	boolesk
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
{anpassad egenskap}

PolicyDefinitionGroup

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

PolicyDefinitionReference

Name	Beskrivning	Värde
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 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

ParameterValues

Name	Beskrivning	Värde
{anpassad egenskap}		ParameterValuesValue

ParameterValuesValue

Name	Beskrivning	Värde
värde	Värdet för parametern .

Dela via

Microsoft.Authorization policySetDefinitions

Bicep-resursdefinition

Resursformat

Egenskapsvärden

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

policySetDefinitions

PolicySetDefinitionEgenskaper

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Feedback

Ytterligare resurser