Condividi tramite

Microsoft.Authorization policySetDefinitions

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa policySetDefinitions è una risorsa di estensione, il che significa che è possibile applicarlo a un'altra risorsa.

Usare la scope proprietà in questa risorsa per impostare l'ambito per questa risorsa. Vedere Impostare l'ambito sulle risorse di estensione in Bicep.

Il tipo di risorsa policySetDefinitions può essere distribuito con operazioni destinate a:

È possibile fare riferimento a questo tipo di risorsa come risorsa di sola lettura a livello di : Tenant

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Authorization/policySetDefinitions, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

policySetDefinitions

Nome Descrizione valore
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: nome visualizzato da 1 a 128

Nome risorsa 1-64

Caratteri validi:
Il nome visualizzato può contenere qualsiasi carattere.

Il nome della risorsa non può usare:
<>*%&:\?.+/ o caratteri di controllo.

Non può terminare con un punto o uno spazio.
ambito Usare quando si crea una risorsa di estensione in un ambito diverso dall'ambito di distribuzione. Risorsa di destinazione

Per Bicep, impostare questa proprietà sul nome simbolico della risorsa per applicare la risorsa di estensione.
properties Proprietà di definizione del set di criteri. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nome Descrizione Valore
description Descrizione della definizione del set di criteri. string
displayName Nome visualizzato della definizione del set di criteri. string
metadata Metadati di definizione del set di criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie chiave-valore. Per Bicep, è possibile usare la funzione any().
parametri Parametri di definizione del set di criteri che possono essere usati nei riferimenti alle definizioni dei criteri. ParameterDefinitions
policyDefinitionGroups Metadati che descrivono i gruppi di riferimenti alla definizione dei criteri all'interno della definizione del set di criteri. PolicyDefinitionGroup[]
policyDefinitions Matrice di riferimenti alle definizioni dei criteri. PolicyDefinitionReference[] (obbligatorio)
policyType Tipo di definizione del set di criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static. 'BuiltIn'
'Custom'
'NotSpecified'
'Static'
version Versione della definizione del set di criteri in formato #.#.#. string
versions Elenco delle versioni disponibili per questa definizione del set di criteri. string[]

ParameterDefinitions

Nome Descrizione Valore
{proprietà personalizzata} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrizione Valore
allowedValues Valori consentiti per il parametro . any[]
defaultValue Valore predefinito per il parametro se non viene specificato alcun valore. Per Bicep, è possibile usare la funzione any().
metadata Metadati generali per il parametro . ParameterDefinitionsValueMetadata
schema Fornisce la convalida degli input dei parametri durante l'assegnazione usando uno schema JSON self-defined. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema 2019-09 Json.NET. Per altre informazioni sull'uso degli schemi in https://json-schema.org/ e sui progetti di test, vedere https://www.jsonschemavalidator.net/. Per Bicep, è possibile usare la funzione any().
tipo Tipo di dati del parametro. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nome Descrizione Valore
assignPermissions Impostare su true per avere portale di Azure creare assegnazioni di ruolo nell'ID risorsa o nel valore dell'ambito della risorsa di questo parametro durante l'assegnazione dei criteri. Questa proprietà è utile nel caso in cui si desideri assegnare autorizzazioni al di fuori dell'ambito di assegnazione. bool
description Descrizione del parametro. string
displayName Nome visualizzato per il parametro. string
strongType Usato quando si assegna la definizione dei criteri tramite il portale. Fornisce un elenco di valori che riconosce il contesto tra cui l'utente può scegliere. string
{proprietà personalizzata} Per Bicep, è possibile usare la funzione any().

PolicyDefinitionGroup

Nome Descrizione Valore
additionalMetadataId ID risorsa di una risorsa che contiene metadati aggiuntivi sul gruppo. string
category Categoria del gruppo. string
description Descrizione del gruppo. string
displayName il nome visualizzato del gruppo. string
name Nome del gruppo. stringa (obbligatorio)

PolicyDefinitionReference

Nome Descrizione Valore
groupNames Nome dei gruppi a cui appartiene il riferimento alla definizione dei criteri. string[]
parametri Valori dei parametri per la regola dei criteri a cui si fa riferimento. Le chiavi sono i nomi dei parametri. ParameterValues
policyDefinitionId ID della definizione dei criteri o della definizione del set di criteri. stringa (obbligatorio)
policyDefinitionReferenceId ID univoco (all'interno della definizione del set di criteri) per questo riferimento alla definizione dei criteri. string

ParameterValues

Nome Descrizione Valore
{proprietà personalizzata} ParameterValuesValue

ParameterValuesValue

Nome Descrizione Valore
Valore Valore del parametro. Per Bicep, è possibile usare la funzione any().

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa policySetDefinitions è una risorsa di estensione, il che significa che è possibile applicarlo a un'altra risorsa.

Usare la scope proprietà in questa risorsa per impostare l'ambito per questa risorsa. Vedere Impostare l'ambito sulle risorse di estensione nei modelli di Resource Manager.

Il tipo di risorsa policySetDefinitions può essere distribuito con operazioni destinate a:

È possibile fare riferimento a questo tipo di risorsa come risorsa di sola lettura a livello di : Tenant

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Authorization/policySetDefinitions, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

policySetDefinitions

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.Authorization/policySetDefinitions'
apiVersion Versione dell'API della risorsa '2023-04-01'
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 1-128 nome visualizzato

Nome risorsa 1-64

Caratteri validi:
Il nome visualizzato può contenere qualsiasi carattere.

Il nome della risorsa non può usare:
<>*%&:\?.+/ o caratteri di controllo.

Non può terminare con un punto o uno spazio.
ambito Usare quando si crea una risorsa di estensione in un ambito diverso dall'ambito di distribuzione. Risorsa di destinazione

Per JSON, impostare il valore sul nome completo della risorsa per applicare la risorsa di estensione a.
properties Proprietà di definizione del set di criteri. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nome Descrizione Valore
description Descrizione della definizione del set di criteri. string
displayName Nome visualizzato della definizione del set di criteri. string
metadata Metadati delle definizioni del set di criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie di valori chiave.
parametri Parametri di definizione del set di criteri che possono essere usati nei riferimenti alle definizioni dei criteri. ParameterDefinitions
policyDefinitionGroups I metadati che descrivono i gruppi di riferimenti alle definizioni dei criteri all'interno della definizione del set di criteri. PolicyDefinitionGroup[]
policyDefinitions Matrice di riferimenti alla definizione dei criteri. PolicyDefinitionReference[] (obbligatorio)
policyType Tipo di definizione del set di criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static. 'BuiltIn'
'Personalizzato'
'NotSpecified'
'Statico'
version Versione della definizione del set di criteri in formato #.#.# . string
versions Elenco delle versioni disponibili per questa definizione del set di criteri. string[]

ParameterDefinitions

Nome Descrizione Valore
{proprietà personalizzata} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrizione Valore
allowedValues Valori consentiti per il parametro. any[]
defaultValue Valore predefinito per il parametro se non viene specificato alcun valore.
metadata Metadati generali per il parametro. ParameterDefinitionsValueMetadata
schema Fornisce la convalida degli input dei parametri durante l'assegnazione usando uno schema JSON auto-definito. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema Json.NET schema 2019-09. Per altre informazioni sull'uso di schemi in https://json-schema.org/ e schemi di test, vedere https://www.jsonschemavalidator.net/.
tipo Tipo di dati del parametro. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nome Descrizione Valore
assignPermissions Impostare su true per avere portale di Azure creare assegnazioni di ruolo nel valore dell'ID risorsa o dell'ambito della risorsa di questo parametro durante l'assegnazione dei criteri. Questa proprietà è utile nel caso in cui si desideri assegnare autorizzazioni al di fuori dell'ambito di assegnazione. bool
description Descrizione del parametro. string
displayName Nome visualizzato per il parametro. string
strongType Usato per assegnare la definizione dei criteri tramite il portale. Fornisce un elenco di valori con riconoscimento del contesto da cui scegliere l'utente. string
{proprietà personalizzata}

PolicyDefinitionGroup

Nome Descrizione Valore
additionalMetadataId ID risorsa di una risorsa contenente metadati aggiuntivi sul gruppo. string
category Categoria del gruppo. string
description Descrizione del gruppo. string
displayName il nome visualizzato del gruppo. string
name Nome del gruppo. stringa (obbligatoria)

PolicyDefinitionReference

Nome Descrizione Valore
groupNames Nome dei gruppi a cui appartiene questo riferimento alla definizione dei criteri. string[]
parametri Valori dei parametri per la regola dei criteri a cui si fa riferimento. Le chiavi sono i nomi dei parametri. ParameterValues
policyDefinitionId ID della definizione o del set di criteri. stringa (obbligatoria)
policyDefinitionReferenceId ID univoco (all'interno della definizione del set di criteri) per questo riferimento alla definizione dei criteri. string

ParameterValues

Nome Descrizione Valore
{proprietà personalizzata} ParameterValuesValue

ParameterValuesValue

Nome Descrizione Valore
Valore Valore del parametro.

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa policySetDefinitions è una risorsa di estensione, che significa che è possibile applicarla a un'altra risorsa.

Utilizzare la proprietà in questa risorsa per impostare l'ambito parent_id per questa risorsa.

Il tipo di risorsa policySetDefinitions può essere distribuito con le operazioni di destinazione:

  • Gruppi di gestione
  • Sottoscrizioni

È possibile fare riferimento a questo tipo di risorsa come risorsa di sola lettura a livello di tenant: Tenant

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Authorization/policySetDefinitions, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

policySetDefinitions

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.Authorization/policySetDefinitions@2023-04-01"
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 1-128 nome visualizzato

Nome risorsa 1-64

Caratteri validi:
Il nome visualizzato può contenere qualsiasi carattere.

Il nome della risorsa non può usare:
<>*%&:\?.+/ o caratteri di controllo.

Non può terminare con un punto o uno spazio.
parent_id ID della risorsa a cui applicare questa risorsa di estensione. stringa (obbligatoria)
properties Proprietà di definizione del set di criteri. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nome Descrizione Valore
description Descrizione della definizione del set di criteri. string
displayName Nome visualizzato della definizione del set di criteri. string
metadata Metadati delle definizioni del set di criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie di valori chiave.
parametri Parametri di definizione del set di criteri che possono essere usati nei riferimenti alle definizioni dei criteri. ParameterDefinitions
policyDefinitionGroups I metadati che descrivono i gruppi di riferimenti alle definizioni dei criteri all'interno della definizione del set di criteri. PolicyDefinitionGroup[]
policyDefinitions Matrice di riferimenti alla definizione dei criteri. PolicyDefinitionReference[] (obbligatorio)
policyType Tipo di definizione del set di criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static. "BuiltIn"
"Personalizzato"
"NotSpecified"
"Statico"
version Versione della definizione del set di criteri in formato #.#.# . string
versions Elenco delle versioni disponibili per questa definizione del set di criteri. string[]

ParameterDefinitions

Nome Descrizione Valore
{proprietà personalizzata} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrizione Valore
allowedValues Valori consentiti per il parametro. any[]
defaultValue Valore predefinito per il parametro se non viene specificato alcun valore.
metadata Metadati generali per il parametro. ParameterDefinitionsValueMetadata
schema Fornisce la convalida degli input dei parametri durante l'assegnazione usando uno schema JSON auto-definito. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema Json.NET schema 2019-09. Per altre informazioni sull'uso di schemi in https://json-schema.org/ e schemi di test, vedere https://www.jsonschemavalidator.net/.
tipo Tipo di dati del parametro. "Array"
"Boolean"
"DateTime"
"Float"
"Integer"
"Oggetto"
"String"

ParameterDefinitionsValueMetadata

Nome Descrizione Valore
assignPermissions Impostare su true per avere portale di Azure creare assegnazioni di ruolo nel valore dell'ID risorsa o dell'ambito della risorsa di questo parametro durante l'assegnazione dei criteri. Questa proprietà è utile nel caso in cui si desideri assegnare autorizzazioni al di fuori dell'ambito di assegnazione. bool
description Descrizione del parametro. string
displayName Nome visualizzato per il parametro. string
strongType Usato per assegnare la definizione dei criteri tramite il portale. Fornisce un elenco di valori con riconoscimento del contesto da cui scegliere l'utente. string
{proprietà personalizzata}

PolicyDefinitionGroup

Nome Descrizione Valore
additionalMetadataId ID risorsa di una risorsa contenente metadati aggiuntivi sul gruppo. string
category Categoria del gruppo. string
description Descrizione del gruppo. string
displayName il nome visualizzato del gruppo. string
name Nome del gruppo. stringa (obbligatoria)

PolicyDefinitionReference

Nome Descrizione Valore
groupNames Nome dei gruppi a cui appartiene questo riferimento alla definizione dei criteri. string[]
parametri Valori dei parametri per la regola dei criteri a cui si fa riferimento. Le chiavi sono i nomi dei parametri. ParameterValues
policyDefinitionId ID della definizione o del set di criteri. stringa (obbligatoria)
policyDefinitionReferenceId ID univoco (all'interno della definizione del set di criteri) per questo riferimento alla definizione dei criteri. string

ParameterValues

Nome Descrizione Valore
{proprietà personalizzata} ParameterValuesValue

ParameterValuesValue

Nome Descrizione Valore
Valore Valore del parametro.