Sdílet prostřednictvím

Microsoft.Authorization policySetDefinitions 2023-04-01

  • Článek

Definice prostředku Bicep

Typ prostředku policySetDefinitions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru pro prostředky rozšíření v Bicep.

Typ prostředku policySetDefinitions je možné nasadit s operacemi, které cílí na:

Na tento typ prostředku můžete odkazovat jako na prostředek jen pro čtení na úrovni Tenanti.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Authorization/policySetDefinitions, přidejte do šablony následující bicep.

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'
    ]
  }
}

Hodnoty vlastností

definice policySetDefinitions

Název Description Hodnota
name Název prostředku string (povinné)

Omezení počtu znaků: zobrazovaný název 1–128

1–64 název prostředku

Platné znaky:
Zobrazovaný název může obsahovat libovolné znaky.

Název prostředku nemůže použít:
<>*%&:\?.+/ nebo řídicí znaky.

Nemůže končit tečkou nebo mezerou.
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro Bicep nastavte tuto vlastnost na symbolický název prostředku, aby se použil prostředek rozšíření.
properties Vlastnosti definice sady zásad PolicySetDefinitionProperties

PolicySetDefinitionProperties

Název Description Hodnota
description Popis definice sady zásad řetězec
displayName Zobrazovaný název definice sady zásad. řetězec
zprostředkovatele identity Metadata definice sady zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů. Pro Bicep můžete použít funkci any().
parameters Odkazy na parametry definice sady zásad, které lze použít v definici zásad. Definice parametrů
policyDefinitionGroups Metadata popisující skupiny definic zásad odkazují v rámci definice sady zásad. PolicyDefinitionGroup[]
definice zásad Odkazuje na pole definic zásad. PolicyDefinitionReference[] (povinné)
policyType Typ definice sady zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické. 'BuiltIn'
'Vlastní'
Neurčené
'Static'
verze Verze definice sady zásad ve formátu #.#.# řetězec
verze Seznam dostupných verzí pro tuto definici sady zásad. string[]

Definice parametrů

Název Description Hodnota
{přizpůsobená vlastnost} ParametrDefinitionsValue

ParametrDefinitionsValue

Název Description Hodnota
Allowedvalues Povolené hodnoty parametru. any[]
Defaultvalue Výchozí hodnota parametru, pokud není zadaná žádná hodnota. Pro Bicep můžete použít funkci any().
zprostředkovatele identity Obecná metadata parametru ParameterDefinitionsValueMetadata
schema Poskytuje ověřování vstupů parametrů během přiřazení pomocí samodefinované schématu JSON. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací schématu Json.NET 2019-09. Další informace o používání schémat najdete v https://json-schema.org/ tématu a testování konceptů schémat na adrese https://www.jsonschemavalidator.net/. Pro Bicep můžete použít funkci any().
typ Datový typ parametru. 'Pole'
'Logická hodnota'
'DateTime'
"Plovoucí"
'Celé číslo'
'Objekt'
'Řetězec'

ParameterDefinitionsValueMetadata

Název Description Hodnota
assignPermissions Nastavte na hodnotu true, aby Azure Portal vytvořit přiřazení rolí podle ID prostředku nebo oboru zdroje tohoto parametru během přiřazování zásad. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení. bool
description Popis parametru řetězec
displayName Zobrazovaný název parametru řetězec
strongType Používá se při přiřazování definice zásad prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat. řetězec
{přizpůsobená vlastnost} Pro Bicep můžete použít funkci any().

PolicyDefinitionGroup

Název Description Hodnota
additionalMetadataId ID prostředku, které obsahuje další metadata o skupině. řetězec
category Kategorie skupiny. řetězec
description Popis skupiny řetězec
displayName Zobrazovaný název skupiny. řetězec
name Název skupiny. string (povinné)

PolicyDefinitionReference

Název Description Hodnota
groupNames Název skupin, ke kterým tento odkaz na definici zásad patří. string[]
parameters Hodnoty parametrů pro odkazované pravidlo zásad. Klíče jsou názvy parametrů. Hodnoty parametrů
policyDefinitionId ID definice zásady nebo definice sady zásad. string (povinné)
policyDefinitionReferenceId Jedinečné ID (v rámci definice sady zásad) pro tento odkaz na definici zásad. řetězec

Hodnoty parametrů

Název Description Hodnota
{přizpůsobená vlastnost} ParametrValuesValue

ParametrValuesValue

Název Description Hodnota
hodnota Hodnota parametru. Pro Bicep můžete použít funkci any().

Definice prostředku šablony ARM

Typ prostředku policySetDefinitions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru pro prostředky rozšíření v šablonách ARM.

Typ prostředku policySetDefinitions je možné nasadit s operacemi, které cílí na:

Na tento typ prostředku můžete odkazovat jako na prostředek jen pro čtení na úrovni Tenanti.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Authorization/policySetDefinitions, přidejte do šablony následující kód JSON.

{
  "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" ]
  }
}

Hodnoty vlastností

definice policySetDefinitions

Název Description Hodnota
typ Typ prostředku Microsoft.Authorization/policySetDefinitions
apiVersion Verze rozhraní API prostředku '2023-04-01'
name Název prostředku string (povinné)

Omezení počtu znaků: zobrazované jméno 1–128

1–64 název prostředku

Platné znaky:
Zobrazovaný název může obsahovat libovolné znaky.

Název prostředku nemůže použít:
<>*%&:\?.+/ nebo řídicí znaky.

Nemůže končit tečkou nebo mezerou.
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro JSON nastavte hodnotu na úplný název prostředku, na který chcete prostředek rozšíření použít.
properties Vlastnosti definice sady zásad PolicySetDefinitionProperties

PolicySetDefinitionProperties

Název Description Hodnota
description Popis definice sady zásad řetězec
displayName Zobrazovaný název definice sady zásad. řetězec
zprostředkovatele identity Metadata definice sady zásad Metadata jsou objekt s otevřeným koncem a obvykle jde o kolekci párů hodnot klíčů.
parameters Parametry definice sady zásad, které lze použít v odkazech na definice zásad. ParametrDefinitions
policyDefinitionGroups Metadata popisující skupiny definic zásad odkazují v rámci definice sady zásad. PolicyDefinitionGroup[]
definice zásad Pole odkazů na definici zásad. PolicyDefinitionReference[] (povinné)
policyType Typ definice sady zásad. Možné hodnoty jsou Nezadaná, Předdefinovaná, Vlastní a Statická. 'BuiltIn'
Vlastní
Nezadá se
'Static'
verze Verze definice sady zásad ve formátu #.#.# řetězec
verze Seznam dostupných verzí pro tuto definici sady zásad. string[]

ParametrDefinitions

Název Description Hodnota
{přizpůsobená vlastnost} ParameterDefinitionsValue

ParameterDefinitionsValue

Název Description Hodnota
Allowedvalues Povolené hodnoty parametru. any[]
Defaultvalue Výchozí hodnota parametru, pokud není zadaná žádná hodnota.
zprostředkovatele identity Obecná metadata parametru ParameterDefinitionsValueMetadata
schema Poskytuje ověření vstupů parametrů během přiřazení pomocí samodefinovaného schématu JSON. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací Json.NET Schema 2019-09. Další informace o používání schémat najdete v tématu https://json-schema.org/ a testování konceptů schémat na stránce https://www.jsonschemavalidator.net/.
typ Datový typ parametru. Pole
"Logická hodnota"
'DateTime'
"Float"
'Celé číslo'
'Objekt'
'Řetězec'

ParameterDefinitionsValueMetadata

Název Description Hodnota
assignPermissions Nastavte na hodnotu true, aby při přiřazování zásad Azure Portal vytvářet přiřazení rolí podle ID prostředku nebo oboru zdroje tohoto parametru. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení. bool
description Popis parametru. řetězec
displayName Zobrazovaný název parametru. řetězec
strongType Používá se při přiřazování definice zásady prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat. řetězec
{přizpůsobená vlastnost}

PolicyDefinitionGroup

Název Description Hodnota
additionalMetadataId ID prostředku, které obsahuje další metadata o skupině. řetězec
category Kategorie skupiny. řetězec
description Popis skupiny řetězec
displayName Zobrazovaný název skupiny. řetězec
name Název skupiny. string (povinné)

PolicyDefinitionReference

Název Description Hodnota
groupNames Název skupin, ke kterým tento odkaz na definici zásad patří. string[]
parameters Hodnoty parametrů pro odkazované pravidlo zásad. Klíče jsou názvy parametrů. Hodnoty parametrů
policyDefinitionId ID definice zásady nebo definice sady zásad. string (povinné)
policyDefinitionReferenceId Jedinečné ID (v rámci definice sady zásad) pro tento odkaz na definici zásad. řetězec

Hodnoty parametrů

Název Description Hodnota
{přizpůsobená vlastnost} ParametrValuesValue

ParametrValuesValue

Název Description Hodnota
hodnota Hodnota parametru.

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku policySetDefinitions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

parent_id Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku.

Typ prostředku policySetDefinitions je možné nasadit s operacemi, které cílí na:

  • Skupiny pro správu
  • Předplatná

Na tento typ prostředku můžete odkazovat jako na prostředek jen pro čtení na úrovni Tenanti.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Authorization/policySetDefinitions, přidejte do šablony následující Terraform.

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"
      ]
    }
  })
}

Hodnoty vlastností

definice policySetDefinitions

Název Description Hodnota
typ Typ prostředku Microsoft.Authorization/policySetDefinitions@2023-04-01
name Název prostředku string (povinné)

Omezení počtu znaků: zobrazovaný název 1–128

1–64 název prostředku

Platné znaky:
Zobrazovaný název může obsahovat libovolné znaky.

Název prostředku nemůže použít:
<>*%&:\?.+/ nebo řídicí znaky.

Nemůže končit tečkou nebo mezerou.
parent_id ID prostředku, na který se má tento prostředek rozšíření použít. string (povinné)
properties Vlastnosti definice sady zásad PolicySetDefinitionProperties

PolicySetDefinitionProperties

Název Description Hodnota
description Popis definice sady zásad řetězec
displayName Zobrazovaný název definice sady zásad. řetězec
zprostředkovatele identity Metadata definice sady zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů.
parameters Odkazy na parametry definice sady zásad, které lze použít v definici zásad. Definice parametrů
policyDefinitionGroups Metadata popisující skupiny definic zásad odkazují v rámci definice sady zásad. PolicyDefinitionGroup[]
definice zásad Odkazuje na pole definic zásad. PolicyDefinitionReference[] (povinné)
policyType Typ definice sady zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické. "BuiltIn"
"Vlastní"
"Neurčené"
"Static"
verze Verze definice sady zásad ve formátu #.#.# řetězec
verze Seznam dostupných verzí pro tuto definici sady zásad. string[]

Definice parametrů

Název Description Hodnota
{přizpůsobená vlastnost} ParametrDefinitionsValue

ParametrDefinitionsValue

Název Description Hodnota
Allowedvalues Povolené hodnoty parametru. any[]
Defaultvalue Výchozí hodnota parametru, pokud není zadaná žádná hodnota.
zprostředkovatele identity Obecná metadata parametru ParameterDefinitionsValueMetadata
schema Poskytuje ověřování vstupů parametrů během přiřazení pomocí samodefinované schématu JSON. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací schématu Json.NET 2019-09. Další informace o používání schémat najdete v https://json-schema.org/ tématu a testování konceptů schémat na adrese https://www.jsonschemavalidator.net/.
typ Datový typ parametru. "Pole"
"Logická hodnota"
"DateTime"
"Float"
"Celé číslo"
"Objekt"
"Řetězec"

ParameterDefinitionsValueMetadata

Název Description Hodnota
assignPermissions Nastavte na hodnotu true, aby Azure Portal vytvořit přiřazení rolí podle ID prostředku nebo oboru zdroje tohoto parametru během přiřazování zásad. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení. bool
description Popis parametru řetězec
displayName Zobrazovaný název parametru řetězec
strongType Používá se při přiřazování definice zásad prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat. řetězec
{přizpůsobená vlastnost}

PolicyDefinitionGroup

Název Description Hodnota
additionalMetadataId ID prostředku, které obsahuje další metadata o skupině. řetězec
category Kategorie skupiny. řetězec
description Popis skupiny řetězec
displayName Zobrazovaný název skupiny. řetězec
name Název skupiny. string (povinné)

PolicyDefinitionReference

Název Description Hodnota
groupNames Název skupin, ke kterým tento odkaz na definici zásad patří. string[]
parameters Hodnoty parametrů pro odkazované pravidlo zásad. Klíče jsou názvy parametrů. Hodnoty parametrů
policyDefinitionId ID definice zásady nebo definice sady zásad. string (povinné)
policyDefinitionReferenceId Jedinečné ID (v rámci definice sady zásad) pro tento odkaz na definici zásad. řetězec

Hodnoty parametrů

Název Description Hodnota
{přizpůsobená vlastnost} ParametrValuesValue

ParametrValuesValue

Název Description Hodnota
hodnota Hodnota parametru.