Compartilhar via


Microsoft.Authorization policyDefinitions

Definição de recurso do Bicep

O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2025-03-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    externalEvaluationEnforcementSettings: {
      endpointSettings: {
        details: any(...)
        kind: 'string'
      }
      missingTokenAction: 'string'
      resultLifespan: 'string'
      roleDefinitionIds: [
        'string'
      ]
    }
    metadata: any(...)
    mode: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any(...)
        ]
        defaultValue: any(...)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(...)
        type: 'string'
      }
    }
    policyRule: any(...)
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Valores da propriedade

Microsoft.Authorization/policyDefinitions

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obrigatório)
propriedades As propriedades de definição de política. PolicyDefinitionProperties
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

ExternalEvaluationEndpointSettings

Nome Descrição Valor
Detalhes Os detalhes do ponto de extremidade. qualquer
tipo O tipo de ponto de extremidade. cadeia

ExternalEvaluationEnforcementSettings

Nome Descrição Valor
Configurações de endpoint As configurações de um ponto de extremidade externo fornecendo resultados de avaliação. externalEvaluationEndpointSettings
missingTokenAction O que fazer ao avaliar uma política de imposição que requer uma avaliação externa e o token está ausente. Os valores possíveis são Auditoria e Negação e expressões de linguagem são compatíveis. cadeia
de resultadoVida útil O tempo de vida do resultado da invocação do ponto de extremidade após o qual ele não é mais válido. Espera-se que o valor siga o formato de duração ISO 8601 e expressões de linguagem têm suporte. cadeia
funçãoDefiniçãoIds Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. cadeia de caracteres[]

Definições de parâmetros

Nome Descrição Valor

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer
valor padrão 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'
'Booleano'
'Data/hora'
'Flutuar'
'Inteiro'
'Objeto'
'Corda'

ParâmetroDefiniçõesValorMetadados

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
tipo forte 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

PolicyDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição de política. cadeia
nome de exibição O nome de exibição da definição de política. cadeia
externalEvaluationEnforcementSettings Os detalhes da origem dos resultados de avaliação externa exigidos pela política durante a avaliação de imposição. ExternalEvaluationEnforcementSettings
metadados Os metadados de definição de política. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave. qualquer
modo O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. cadeia
parâmetros As definições de parâmetro para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. Definições de parâmetros
regra de política A regra de política. qualquer
tipo de política O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Embutido'
'Personalizado'
'Não especificado'
'Estático'
versão A versão de definição de política no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de política. cadeia de caracteres[]

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
Criar um Gerenciador de Rede Virtual do Azure e VNETs de exemplo Esse modelo implanta um Gerenciador de Rede Virtual do Azure e uma amostra de redes virtuais no grupo de recursos nomeado. Ele dá suporte a várias topologias de conectividade e tipos de associação de grupo de rede.
implantar um def de política e atribuir a vários grupos mgmt Esse modelo é um modelo de nível de grupo de gerenciamento que criará uma definição de política e atribuirá essa política a vários grupos de gerenciamento.
implantar uma definição de política e atribuir a um grupo de gerenciamento Esse modelo é um modelo de nível de grupo de gerenciamento que criará uma definição de política e atribuirá essa política ao grupo de gerenciamento de destino. Atualmente, esse modelo não pode ser implantado por meio do Portal do Azure.

Definição de recurso de modelo do ARM

O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2025-03-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalEvaluationEnforcementSettings": {
      "endpointSettings": {
        "details": {},
        "kind": "string"
      },
      "missingTokenAction": "string",
      "resultLifespan": "string",
      "roleDefinitionIds": [ "string" ]
    },
    "metadata": {},
    "mode": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyRule": {},
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Valores da propriedade

Microsoft.Authorization/policyDefinitions

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

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

ExternalEvaluationEndpointSettings

Nome Descrição Valor
Detalhes Os detalhes do ponto de extremidade. qualquer
tipo O tipo de ponto de extremidade. cadeia

ExternalEvaluationEnforcementSettings

Nome Descrição Valor
Configurações de endpoint As configurações de um ponto de extremidade externo fornecendo resultados de avaliação. externalEvaluationEndpointSettings
missingTokenAction O que fazer ao avaliar uma política de imposição que requer uma avaliação externa e o token está ausente. Os valores possíveis são Auditoria e Negação e expressões de linguagem são compatíveis. cadeia
de resultadoVida útil O tempo de vida do resultado da invocação do ponto de extremidade após o qual ele não é mais válido. Espera-se que o valor siga o formato de duração ISO 8601 e expressões de linguagem têm suporte. cadeia
funçãoDefiniçãoIds Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. cadeia de caracteres[]

Definições de parâmetros

Nome Descrição Valor

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer
valor padrão 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'
'Booleano'
'Data/hora'
'Flutuar'
'Inteiro'
'Objeto'
'Corda'

ParâmetroDefiniçõesValorMetadados

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
tipo forte 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

PolicyDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição de política. cadeia
nome de exibição O nome de exibição da definição de política. cadeia
externalEvaluationEnforcementSettings Os detalhes da origem dos resultados de avaliação externa exigidos pela política durante a avaliação de imposição. ExternalEvaluationEnforcementSettings
metadados Os metadados de definição de política. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave. qualquer
modo O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. cadeia
parâmetros As definições de parâmetro para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. Definições de parâmetros
regra de política A regra de política. qualquer
tipo de política O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Embutido'
'Personalizado'
'Não especificado'
'Estático'
versão A versão de definição de política no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de política. cadeia de caracteres[]

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
Criar um Gerenciador de Rede Virtual do Azure e VNETs de exemplo

Implantar no Azure
Esse modelo implanta um Gerenciador de Rede Virtual do Azure e uma amostra de redes virtuais no grupo de recursos nomeado. Ele dá suporte a várias topologias de conectividade e tipos de associação de grupo de rede.
implantar um def de política e atribuir a vários grupos mgmt

Implantar no Azure
Esse modelo é um modelo de nível de grupo de gerenciamento que criará uma definição de política e atribuirá essa política a vários grupos de gerenciamento.
implantar uma definição de política e atribuir a um grupo de gerenciamento

Implantar no Azure
Esse modelo é um modelo de nível de grupo de gerenciamento que criará uma definição de política e atribuirá essa política ao grupo de gerenciamento de destino. Atualmente, esse modelo não pode ser implantado por meio do Portal do Azure.

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

O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2025-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      externalEvaluationEnforcementSettings = {
        endpointSettings = {
          details = ?
          kind = "string"
        }
        missingTokenAction = "string"
        resultLifespan = "string"
        roleDefinitionIds = [
          "string"
        ]
      }
      metadata = ?
      mode = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyRule = ?
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  }
}

Valores da propriedade

Microsoft.Authorization/policyDefinitions

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
propriedades As propriedades de definição de política. PolicyDefinitionProperties
tipo O tipo de recurso "Microsoft.Authorization/policyDefinitions@2025-03-01"

ExternalEvaluationEndpointSettings

Nome Descrição Valor
Detalhes Os detalhes do ponto de extremidade. qualquer
tipo O tipo de ponto de extremidade. cadeia

ExternalEvaluationEnforcementSettings

Nome Descrição Valor
Configurações de endpoint As configurações de um ponto de extremidade externo fornecendo resultados de avaliação. externalEvaluationEndpointSettings
missingTokenAction O que fazer ao avaliar uma política de imposição que requer uma avaliação externa e o token está ausente. Os valores possíveis são Auditoria e Negação e expressões de linguagem são compatíveis. cadeia
de resultadoVida útil O tempo de vida do resultado da invocação do ponto de extremidade após o qual ele não é mais válido. Espera-se que o valor siga o formato de duração ISO 8601 e expressões de linguagem têm suporte. cadeia
funçãoDefiniçãoIds Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. cadeia de caracteres[]

Definições de parâmetros

Nome Descrição Valor

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro. qualquer
valor padrão 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'
'Booleano'
'Data/hora'
'Flutuar'
'Inteiro'
'Objeto'
'Corda'

ParâmetroDefiniçõesValorMetadados

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
tipo forte 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

PolicyDefinitionProperties

Nome Descrição Valor
descrição A descrição da definição de política. cadeia
nome de exibição O nome de exibição da definição de política. cadeia
externalEvaluationEnforcementSettings Os detalhes da origem dos resultados de avaliação externa exigidos pela política durante a avaliação de imposição. ExternalEvaluationEnforcementSettings
metadados Os metadados de definição de política. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave. qualquer
modo O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. cadeia
parâmetros As definições de parâmetro para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. Definições de parâmetros
regra de política A regra de política. qualquer
tipo de política O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. 'Embutido'
'Personalizado'
'Não especificado'
'Estático'
versão A versão de definição de política no formato #.#.#. cadeia
Versões Uma lista de versões disponíveis para essa definição de política. cadeia de caracteres[]

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação de definições de política de autorização.

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

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

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

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

data "azurerm_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    = ["*"]
}