Compartilhar via


Microsoft.Authorization policySetDefinitions

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2025-03-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(...)
    parameters: {
      {customized property}: {
        allowedValues: [
          any(...)
        ]
        defaultValue: any(...)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(...)
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        definitionVersion: 'string'
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any(...)
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Valores da propriedade

Microsoft.Authorization/policySetDefinitions

Nome Descrição Valor
nome O nome do recurso corda

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

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

Nome 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 de atribuição. Bool
descrição A descrição do parâmetro. cadeia
nome de exibição O nome de exibição do parâmetro. cadeia
strongType Usado ao atribuir a definição de política por meio do portal. Fornece uma lista de valores com reconhecimento de contexto para o usuário escolher. cadeia

ParameterValuesValue

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

PolicyDefinitionGroup

Nome Descrição Valor
additionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. cadeia
categoria A categoria do grupo. cadeia
descrição A descrição do grupo. cadeia
nome de exibição O nome de exibição do grupo. cadeia
nome O nome do grupo. cadeia de caracteres (obrigatório)

PolicyDefinitionReference

Nome Descrição Valor
definitionVersion A versão da definição de política a ser usada. cadeia
groupNames O nome dos grupos aos quais essa referência de definição de política pertence. cadeia de caracteres[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. DefiniçãoPolíticaParâmetrosReferênciaT
policyDefinitionId A ID da definição de política ou definição do conjunto de políticas. cadeia de caracteres (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. cadeia

DefiniçãoPolíticaParâmetrosReferênciaT

Nome Descrição Valor

PolicySetDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição do conjunto de políticas. cadeia
nome de exibição O nome de exibição da definição do conjunto de políticas. cadeia
metadados Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto e normalmente é 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. PolicySetDefinitionPropertiesParameters
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 []
policyDefinitions 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. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Estático'
versão A versão de definição do conjunto de políticas no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de conjunto de políticas. cadeia de caracteres[]

PolicySetDefinitionPropertiesParameters

Nome Descrição Valor

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2025-03-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 da propriedade

Microsoft.Authorization/policySetDefinitions

Nome Descrição Valor
apiVersion A versão da API '2025-03-01'
nome O nome do recurso corda

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'

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

Nome 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 de atribuição. Bool
descrição A descrição do parâmetro. cadeia
nome de exibição O nome de exibição do parâmetro. cadeia
strongType Usado ao atribuir a definição de política por meio do portal. Fornece uma lista de valores com reconhecimento de contexto para o usuário escolher. cadeia

ParameterValuesValue

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

PolicyDefinitionGroup

Nome Descrição Valor
additionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. cadeia
categoria A categoria do grupo. cadeia
descrição A descrição do grupo. cadeia
nome de exibição O nome de exibição do grupo. cadeia
nome O nome do grupo. cadeia de caracteres (obrigatório)

PolicyDefinitionReference

Nome Descrição Valor
definitionVersion A versão da definição de política a ser usada. cadeia
groupNames O nome dos grupos aos quais essa referência de definição de política pertence. cadeia de caracteres[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. DefiniçãoPolíticaParâmetrosReferênciaT
policyDefinitionId A ID da definição de política ou definição do conjunto de políticas. cadeia de caracteres (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. cadeia

DefiniçãoPolíticaParâmetrosReferênciaT

Nome Descrição Valor

PolicySetDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição do conjunto de políticas. cadeia
nome de exibição O nome de exibição da definição do conjunto de políticas. cadeia
metadados Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto e normalmente é 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. PolicySetDefinitionPropertiesParameters
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 []
policyDefinitions 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. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Estático'
versão A versão de definição do conjunto de políticas no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de conjunto de políticas. cadeia de caracteres[]

PolicySetDefinitionPropertiesParameters

Nome Descrição Valor

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

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

  • grupos de gerenciamento de * de assinatura

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2025-03-01"
  name = "string"
  parent_id = "string"
  body = {
    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 da propriedade

Microsoft.Authorization/policySetDefinitions

Nome Descrição Valor
nome O nome do recurso corda

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@2025-03-01"

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

Nome 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 de atribuição. Bool
descrição A descrição do parâmetro. cadeia
nome de exibição O nome de exibição do parâmetro. cadeia
strongType Usado ao atribuir a definição de política por meio do portal. Fornece uma lista de valores com reconhecimento de contexto para o usuário escolher. cadeia

ParameterValuesValue

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

PolicyDefinitionGroup

Nome Descrição Valor
additionalMetadataId Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. cadeia
categoria A categoria do grupo. cadeia
descrição A descrição do grupo. cadeia
nome de exibição O nome de exibição do grupo. cadeia
nome O nome do grupo. cadeia de caracteres (obrigatório)

PolicyDefinitionReference

Nome Descrição Valor
definitionVersion A versão da definição de política a ser usada. cadeia
groupNames O nome dos grupos aos quais essa referência de definição de política pertence. cadeia de caracteres[]
Parâmetros Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. DefiniçãoPolíticaParâmetrosReferênciaT
policyDefinitionId A ID da definição de política ou definição do conjunto de políticas. cadeia de caracteres (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. cadeia

DefiniçãoPolíticaParâmetrosReferênciaT

Nome Descrição Valor

PolicySetDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição do conjunto de políticas. cadeia
nome de exibição O nome de exibição da definição do conjunto de políticas. cadeia
metadados Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto e normalmente é 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. PolicySetDefinitionPropertiesParameters
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 []
policyDefinitions 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. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Estático'
versão A versão de definição do conjunto de políticas no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de conjunto de políticas. cadeia de caracteres[]

PolicySetDefinitionPropertiesParameters

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implementação da definição do conjunto de políticas.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

data "azapi_client_config" "current" {}

resource "azapi_resource" "policyDefinition" {
  type      = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  parent_id = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      displayName = "my-policy-definition"
      mode        = "All"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyRule = {
        if = {
          not = {
            field = "location"
            in    = "[parameters('allowedLocations')]"
          }
        }
        then = {
          effect = "audit"
        }
      }
      policyType = "Custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policySetDefinition" {
  type      = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
  parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}"
  name      = "acctestpolset-${var.resource_name}"
  body = {
    properties = {
      description = ""
      displayName = "acctestpolset-${var.resource_name}"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyDefinitions = [{
        groupNames = []
        parameters = {
          listOfAllowedLocations = {
            value = "[parameters('allowedLocations')]"
          }
        }
        policyDefinitionId          = azapi_resource.policyDefinition.id
        policyDefinitionReferenceId = ""
      }]
      policyType = "Custom"
    }
  }
}