Partilhar via

Microsoft.Authorization policySetDefinitions 2023-04-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso policySetDefinitions pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-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'
    ]
  }
}

Valores de propriedade

Microsoft.Authorization/policySetDefinitions

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Padrão = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obrigatório)
propriedades As propriedades de definição do conjunto de políticas. PolicySetDefinitionProperties

ParâmetroDefinições

Designação Descrição Valor

ParameterDefinitionsValue

Designação Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer[]
defaultValue O valor padrão para o parâmetro se nenhum valor for fornecido. qualquer
metadados Metadados gerais para o parâmetro. ParameterDefinitionsValueMetadata
Esquema Fornece validação de entradas de parâmetros durante a atribuição usando um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo objeto e segue a implementação do Json.NET Schema 2019-09. Você pode aprender mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. qualquer
tipo O tipo de dados do parâmetro. 'Matriz'
'Booleano'
'DateTime'
'Flutuar'
'Inteiro'
'Objeto'
'String'

ParameterDefinitionsValueMetadata

Designação Descrição Valor
assignPermissions Defina como true para que o portal do Azure crie atribuições de função na ID do recurso ou no valor do escopo do recurso desse parâmetro durante a atribuição de política. Essa propriedade é útil caso você deseje atribuir permissões fora do escopo da atribuição. Bool
Descrição A descrição do parâmetro. string
displayName O nome para exibição do parâmetro. string
strongType Usado ao atribuir a definição de política através do portal. Fornece uma lista sensível ao contexto de valores para o usuário escolher. string

ParâmetroValores

Designação Descrição Valor

ParameterValuesValue

Designação Descrição Valor
valor O valor do parâmetro. qualquer

PolicyDefinitionGroup

Designação Descrição Valor
adicionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. string
categoria A categoria do grupo. string
Descrição A descrição do grupo. string
displayName O nome de exibição do grupo. string
Designação O nome do grupo. string (obrigatório)

PolicyDefinitionReference

Designação Descrição Valor
definiçãoVersão A versão da definição de política a ser usada. string
groupNames O nome dos grupos aos quais esta referência de definição de política pertence. string[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. ParameterValues
policyDefinitionId A ID da definição de política ou definição de conjunto de políticas. string (obrigatório)
policyDefinitionReferenceId Uma id exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. string

PolicySetDefinitionProperties

Designação Descrição Valor
Descrição A descrição da definição do conjunto de políticas. string
displayName O nome para exibição da definição do conjunto de políticas. string
metadados Os metadados de definição do conjunto de políticas. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave. qualquer
Parâmetros Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. ParameterDefinitions
policyDefinitionGroups Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. PolicyDefinitionGroup[]
definições de políticas Uma matriz de referências de definição de política. PolicyDefinitionReference[] (obrigatório)
policyType O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Incorporado'
'Personalizado'
'Não especificado'
'Estática'
Versão A versão de definição do conjunto de políticas no formato #.#.#. string
Versões Uma lista de versões disponíveis para esta definição de conjunto de políticas. string[]

Definição de recurso de modelo ARM

O tipo de recurso policySetDefinitions pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.Authorization/policySetDefinitions

Designação Descrição Valor
apiVersion A versão api '2023-04-01'
Designação O nome do recurso string

Restrições:
Padrão = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obrigatório)
propriedades As propriedades de definição do conjunto de políticas. PolicySetDefinitionProperties
tipo O tipo de recurso 'Microsoft.Authorization/policySetDefinitions'

ParâmetroDefinições

Designação Descrição Valor

ParameterDefinitionsValue

Designação Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer[]
defaultValue O valor padrão para o parâmetro se nenhum valor for fornecido. qualquer
metadados Metadados gerais para o parâmetro. ParameterDefinitionsValueMetadata
Esquema Fornece validação de entradas de parâmetros durante a atribuição usando um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo objeto e segue a implementação do Json.NET Schema 2019-09. Você pode aprender mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. qualquer
tipo O tipo de dados do parâmetro. 'Matriz'
'Booleano'
'DateTime'
'Flutuar'
'Inteiro'
'Objeto'
'String'

ParameterDefinitionsValueMetadata

Designação Descrição Valor
assignPermissions Defina como true para que o portal do Azure crie atribuições de função na ID do recurso ou no valor do escopo do recurso desse parâmetro durante a atribuição de política. Essa propriedade é útil caso você deseje atribuir permissões fora do escopo da atribuição. Bool
Descrição A descrição do parâmetro. string
displayName O nome para exibição do parâmetro. string
strongType Usado ao atribuir a definição de política através do portal. Fornece uma lista sensível ao contexto de valores para o usuário escolher. string

ParâmetroValores

Designação Descrição Valor

ParameterValuesValue

Designação Descrição Valor
valor O valor do parâmetro. qualquer

PolicyDefinitionGroup

Designação Descrição Valor
adicionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. string
categoria A categoria do grupo. string
Descrição A descrição do grupo. string
displayName O nome de exibição do grupo. string
Designação O nome do grupo. string (obrigatório)

PolicyDefinitionReference

Designação Descrição Valor
definiçãoVersão A versão da definição de política a ser usada. string
groupNames O nome dos grupos aos quais esta referência de definição de política pertence. string[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. ParameterValues
policyDefinitionId A ID da definição de política ou definição de conjunto de políticas. string (obrigatório)
policyDefinitionReferenceId Uma id exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. string

PolicySetDefinitionProperties

Designação Descrição Valor
Descrição A descrição da definição do conjunto de políticas. string
displayName O nome para exibição da definição do conjunto de políticas. string
metadados Os metadados de definição do conjunto de políticas. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave. qualquer
Parâmetros Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. ParameterDefinitions
policyDefinitionGroups Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. PolicyDefinitionGroup[]
definições de políticas Uma matriz de referências de definição de política. PolicyDefinitionReference[] (obrigatório)
policyType O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Incorporado'
'Personalizado'
'Não especificado'
'Estática'
Versão A versão de definição do conjunto de políticas no formato #.#.#. string
Versões Uma lista de versões disponíveis para esta definição de conjunto de políticas. string[]

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso policySetDefinitions pode ser implantado com operações que visam:

  • Grupos de Gestão de* de Inquilinos* de Subscrição

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.Authorization/policySetDefinitions

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Padrão = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obrigatório)
propriedades As propriedades de definição do conjunto de políticas. PolicySetDefinitionProperties
tipo O tipo de recurso "Microsoft.Authorization/policySetDefinitions@2023-04-01"

ParâmetroDefinições

Designação Descrição Valor

ParameterDefinitionsValue

Designação Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer[]
defaultValue O valor padrão para o parâmetro se nenhum valor for fornecido. qualquer
metadados Metadados gerais para o parâmetro. ParameterDefinitionsValueMetadata
Esquema Fornece validação de entradas de parâmetros durante a atribuição usando um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo objeto e segue a implementação do Json.NET Schema 2019-09. Você pode aprender mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. qualquer
tipo O tipo de dados do parâmetro. 'Matriz'
'Booleano'
'DateTime'
'Flutuar'
'Inteiro'
'Objeto'
'String'

ParameterDefinitionsValueMetadata

Designação Descrição Valor
assignPermissions Defina como true para que o portal do Azure crie atribuições de função na ID do recurso ou no valor do escopo do recurso desse parâmetro durante a atribuição de política. Essa propriedade é útil caso você deseje atribuir permissões fora do escopo da atribuição. Bool
Descrição A descrição do parâmetro. string
displayName O nome para exibição do parâmetro. string
strongType Usado ao atribuir a definição de política através do portal. Fornece uma lista sensível ao contexto de valores para o usuário escolher. string

ParâmetroValores

Designação Descrição Valor

ParameterValuesValue

Designação Descrição Valor
valor O valor do parâmetro. qualquer

PolicyDefinitionGroup

Designação Descrição Valor
adicionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. string
categoria A categoria do grupo. string
Descrição A descrição do grupo. string
displayName O nome de exibição do grupo. string
Designação O nome do grupo. string (obrigatório)

PolicyDefinitionReference

Designação Descrição Valor
definiçãoVersão A versão da definição de política a ser usada. string
groupNames O nome dos grupos aos quais esta referência de definição de política pertence. string[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. ParameterValues
policyDefinitionId A ID da definição de política ou definição de conjunto de políticas. string (obrigatório)
policyDefinitionReferenceId Uma id exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. string

PolicySetDefinitionProperties

Designação Descrição Valor
Descrição A descrição da definição do conjunto de políticas. string
displayName O nome para exibição da definição do conjunto de políticas. string
metadados Os metadados de definição do conjunto de políticas. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave. qualquer
Parâmetros Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. ParameterDefinitions
policyDefinitionGroups Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. PolicyDefinitionGroup[]
definições de políticas Uma matriz de referências de definição de política. PolicyDefinitionReference[] (obrigatório)
policyType O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Incorporado'
'Personalizado'
'Não especificado'
'Estática'
Versão A versão de definição do conjunto de políticas no formato #.#.#. string
Versões Uma lista de versões disponíveis para esta definição de conjunto de políticas. string[]