Share via

Microsoft.Authorization policySetDefinitions/versions 2023-04-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu policySetDefinitions/versions można wdrożyć z operacjami docelowymi:

Ten typ zasobu można odwoływać jako zasób tylko do odczytu na poziomie: Dzierżawy

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Authorization/policySetDefinitions/versions, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions/versions@2023-04-01' = {
  name: 'string'
  parent: 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'
  }
}

Wartości właściwości

policySetDefinitions/versions

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
Nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: policySetDefinitions
properties Właściwości wersji definicji zestawu zasad. PolicySetDefinitionVersionProperties

PolicySetDefinitionVersionProperties

Nazwa Opis Wartość
description (opis) Opis definicji zestawu zasad. ciąg
displayName Nazwa wyświetlana definicji zestawu zasad. ciąg
metadane Metadane definicji zestawu zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. W przypadku funkcji Bicep można użyć funkcji any().
parameters Parametry definicji zestawu zasad, które mogą być używane w odwołaniach do definicji zasad. ParametryDefinitions
policyDefinitionGroups Metadane opisujące grupy odwołań definicji zasad w ramach definicji zestawu zasad. PolicyDefinitionGroup[]
Policydefinitions Tablica odwołań definicji zasad. PolicyDefinitionReference[] (wymagane)
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"Nieokreślone"
"Statyczny"
Wersja Wersja definicji zestawu zasad w formacie #.#.# ciąg

ParametryDefinitions

Nazwa Opis Wartość
{niestandardowa właściwość} ParameterDefinitionsValue

ParameterDefinitionsValue

Nazwa Opis Wartość
Allowedvalues Dozwolone wartości parametru. any[]
Defaultvalue Wartość domyślna parametru, jeśli nie podano żadnej wartości. W przypadku funkcji Bicep można użyć funkcji any().
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schema Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można uzyskać na stronie https://json-schema.org/ i przetestować schematy robocze na stronie https://www.jsonschemavalidator.net/. W przypadku funkcji Bicep można użyć funkcji any().
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby Azure Portal utworzyć przypisania ról dla wartości identyfikatora zasobu lub zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. bool
description (opis) Opis parametru. ciąg
displayName Nazwa wyświetlana parametru. ciąg
strongType Używany podczas przypisywania definicji zasad za pośrednictwem portalu. Zawiera listę kontekstowych wartości do wyboru przez użytkownika. ciąg
{niestandardowa właściwość} W przypadku funkcji Bicep można użyć funkcji any().

PolicyDefinitionGroup

Nazwa Opis Wartość
additionalMetadataId Identyfikator zasobu, który zawiera dodatkowe metadane dotyczące grupy. ciąg
category Kategoria grupy. ciąg
description (opis) Opis grupy. ciąg
displayName Nazwa wyświetlana grupy. ciąg
name Nazwa grupy. ciąg (wymagany)

PolicyDefinitionReference

Nazwa Opis Wartość
groupNames Nazwa grup, do których należy odwołanie do tej definicji zasad. ciąg[]
parameters Wartości parametrów dla reguły zasad, do których odwołuje się odwołanie. Klucze są nazwami parametrów. Parametervalues
policyDefinitionId Identyfikator definicji zasad lub definicji zestawu zasad. ciąg (wymagany)
policyDefinitionReferenceId Unikatowy identyfikator (w ramach definicji zestawu zasad) dla tej dokumentacji definicji zasad. ciąg

Parametervalues

Nazwa Opis Wartość
{niestandardowa właściwość} ParameterValuesValue

ParameterValuesValue

Nazwa Opis Wartość
wartość Wartość parametru. W przypadku funkcji Bicep można użyć funkcji any().

Definicja zasobu szablonu usługi ARM

Typ zasobu policySetDefinitions/versions można wdrożyć z operacjami docelowymi:

Ten typ zasobu można odwoływać jako zasób tylko do odczytu na poziomie: Dzierżawy

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Authorization/policySetDefinitions/versions, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "apiVersion": "2023-04-01",
  "name": "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"
  }
}

Wartości właściwości

policySetDefinitions/versions

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Authorization/policySetDefinitions/versions"
apiVersion Wersja interfejsu API zasobów '2023-04-01'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
properties Właściwości wersji definicji zestawu zasad. PolicySetDefinitionVersionProperties

PolicySetDefinitionVersionProperties

Nazwa Opis Wartość
description (opis) Opis definicji zestawu zasad. ciąg
displayName Nazwa wyświetlana definicji zestawu zasad. ciąg
metadane Metadane definicji zestawu zasad. Metadane to otwarty obiekt i zazwyczaj jest kolekcją par klucz wartości.
parameters Parametry definicji zestawu zasad, które mogą być używane w odwołaniach do definicji zasad. ParametrDefinitions
policyDefinitionGroups Metadane opisujące grupy odwołań do definicji zasad w definicji zestawu zasad. PolicyDefinitionGroup[]
Policydefinitions Tablica odwołań do definicji zasad. PolicyDefinitionReference[] (wymagane)
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"NotSpecified"
"Statyczny"
Wersja Wersja definicji zestawu zasad w formacie #.#.# ciąg

ParametrDefinitions

Nazwa Opis Wartość
{niestandardowa właściwość} ParametrDefinitionsValue

ParametrDefinitionsValue

Nazwa Opis Wartość
Allowedvalues Dozwolone wartości parametru. dowolny[]
Defaultvalue Wartość domyślna parametru, jeśli nie podano żadnej wartości.
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schema Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można dowiedzieć się na stronie https://json-schema.org/ i przetestować schematy robocze pod adresem https://www.jsonschemavalidator.net/.
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby Azure Portal utworzyć przypisania ról w identyfikatorze zasobu lub wartości zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. bool
description (opis) Opis parametru. ciąg
displayName Nazwa wyświetlana parametru. ciąg
strongType Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia listę kontekstowych wartości do wyboru przez użytkownika. ciąg
{niestandardowa właściwość}

PolicyDefinitionGroup

Nazwa Opis Wartość
additionalMetadataId Identyfikator zasobu, który zawiera dodatkowe metadane dotyczące grupy. ciąg
category Kategoria grupy. ciąg
description (opis) Opis grupy. ciąg
displayName Nazwa wyświetlana grupy. ciąg
name Nazwa grupy. ciąg (wymagany)

PolicyDefinitionReference

Nazwa Opis Wartość
groupNames Nazwa grup, do których należy odwołanie do tej definicji zasad. ciąg[]
parameters Wartości parametrów dla reguły zasad, do których odwołuje się odwołanie. Klucze są nazwami parametrów. Parametervalues
policyDefinitionId Identyfikator definicji zasad lub definicji zestawu zasad. ciąg (wymagany)
policyDefinitionReferenceId Unikatowy identyfikator (w ramach definicji zestawu zasad) dla tej dokumentacji definicji zasad. ciąg

Parametervalues

Nazwa Opis Wartość
{niestandardowa właściwość} ParameterValuesValue

ParameterValuesValue

Nazwa Opis Wartość
wartość Wartość parametru.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu policySetDefinitions/versions można wdrożyć z operacjami docelowymi:

  • Grupy zarządzania
  • Subskrypcje

Ten typ zasobu można odwoływać jako zasób tylko do odczytu na poziomie: Dzierżawy

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Authorization/policySetDefinitions/versions, dodaj następujący element Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions/versions@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"
    }
  })
}

Wartości właściwości

policySetDefinitions/versions

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Authorization/policySetDefinitions/versions@2023-04-01"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: policySetDefinitions
properties Właściwości wersji definicji zestawu zasad. PolicySetDefinitionVersionProperties

PolicySetDefinitionVersionProperties

Nazwa Opis Wartość
description (opis) Opis definicji zestawu zasad. ciąg
displayName Nazwa wyświetlana definicji zestawu zasad. ciąg
metadane Metadane definicji zestawu zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość.
parameters Parametry definicji zestawu zasad, które mogą być używane w odwołaniach do definicji zasad. ParametryDefinitions
policyDefinitionGroups Metadane opisujące grupy odwołań definicji zasad w ramach definicji zestawu zasad. PolicyDefinitionGroup[]
Policydefinitions Tablica odwołań definicji zasad. PolicyDefinitionReference[] (wymagane)
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"Nieokreślone"
"Statyczny"
Wersja Wersja definicji zestawu zasad w formacie #.#.# ciąg

ParametryDefinitions

Nazwa Opis Wartość
{niestandardowa właściwość} ParameterDefinitionsValue

ParameterDefinitionsValue

Nazwa Opis Wartość
Allowedvalues Dozwolone wartości parametru. any[]
Defaultvalue Wartość domyślna parametru, jeśli nie podano żadnej wartości.
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schema Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można uzyskać na stronie https://json-schema.org/ i przetestować schematy robocze na stronie https://www.jsonschemavalidator.net/.
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby Azure Portal utworzyć przypisania ról dla wartości identyfikatora zasobu lub zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. bool
description (opis) Opis parametru. ciąg
displayName Nazwa wyświetlana parametru. ciąg
strongType Używany podczas przypisywania definicji zasad za pośrednictwem portalu. Zawiera listę kontekstowych wartości do wyboru przez użytkownika. ciąg
{niestandardowa właściwość}

PolicyDefinitionGroup

Nazwa Opis Wartość
additionalMetadataId Identyfikator zasobu, który zawiera dodatkowe metadane dotyczące grupy. ciąg
category Kategoria grupy. ciąg
description (opis) Opis grupy. ciąg
displayName Nazwa wyświetlana grupy. ciąg
name Nazwa grupy. ciąg (wymagany)

PolicyDefinitionReference

Nazwa Opis Wartość
groupNames Nazwa grup, do których należy odwołanie do tej definicji zasad. ciąg[]
parameters Wartości parametrów dla reguły zasad, do których odwołuje się odwołanie. Klucze są nazwami parametrów. Parametervalues
policyDefinitionId Identyfikator definicji zasad lub definicji zestawu zasad. ciąg (wymagany)
policyDefinitionReferenceId Unikatowy identyfikator (w ramach definicji zestawu zasad) dla tej dokumentacji definicji zasad. ciąg

Parametervalues

Nazwa Opis Wartość
{niestandardowa właściwość} ParameterValuesValue

ParameterValuesValue

Nazwa Opis Wartość
wartość Wartość parametru.