Microsoft.Authorization policyDefinitions

Artigo
03/18/2025

Definição de recurso do Bicep

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

de Locatário – Consulte os comandos de implantação de locatário grupos de gerenciamento - Consulte os comandos de implantação do grupo de gerenciamento de Assinatura - Consulte comandos de implantação 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/policyDefinitions, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2025-03-01' = {
  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 de propriedade

ExternalEvaluationEndpointSettings

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

ExternalEvaluationEnforcementSettings

Nome	Descrição	Valor
endpointSettings	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.	corda
resultLifespan	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.	corda Restrições: Padrão = `^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$`
roleDefinitionIds	Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade.	string[]

Microsoft.Authorization/policyDefinitions

Nome	Descrição	Valor
nome	O nome do recurso	corda Restrições: Padrão = `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$` (obrigatório)
Propriedades	As propriedades de definição de política.	PolicyDefinitionProperties

ParameterDefinitions

Nome	Descrição	Valor

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.	corda
displayName	O nome de exibição do parâmetro.	corda
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.	corda

PolicyDefinitionProperties

Nome	Descrição	Valor
descrição	A descrição da definição de política.	corda
displayName	O nome de exibição da definição de política.	corda
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.	corda
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.	ParameterDefinitions
policyRule	A regra de política.	qualquer
policyType	O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.	'BuiltIn' 'Personalizado' 'NotSpecified' 'Estático'
Versão	A versão de definição de política no formato #.#.#.	corda
Versões	Uma lista de versões disponíveis para essa definição de política.	string[]

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:

de Locatário – Consulte os comandos de implantação de locatário grupos de gerenciamento - Consulte os comandos de implantação do grupo de gerenciamento de Assinatura - Consulte comandos de implantação 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/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 de propriedade

ExternalEvaluationEndpointSettings

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

ExternalEvaluationEnforcementSettings

Nome	Descrição	Valor
endpointSettings	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.	corda
resultLifespan	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.	corda Restrições: Padrão = `^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$`
roleDefinitionIds	Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade.	string[]

Microsoft.Authorization/policyDefinitions

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 de política.	PolicyDefinitionProperties
tipo	O tipo de recurso	'Microsoft.Authorization/policyDefinitions'

ParameterDefinitions

Nome	Descrição	Valor

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.	corda
displayName	O nome de exibição do parâmetro.	corda
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.	corda

PolicyDefinitionProperties

Nome	Descrição	Valor
descrição	A descrição da definição de política.	corda
displayName	O nome de exibição da definição de política.	corda
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.	corda
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.	ParameterDefinitions
policyRule	A regra de política.	qualquer
policyType	O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.	'BuiltIn' 'Personalizado' 'NotSpecified' 'Estático'
Versão	A versão de definição de política no formato #.#.#.	corda
Versões	Uma lista de versões disponíveis para essa definição de política.	string[]

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	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 do Terraform (provedor de AzAPI)

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

grupos de gerenciamento dede locatários 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/policyDefinitions, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2025-03-01"
  name = "string"
  body = jsonencode({
    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 de propriedade

ExternalEvaluationEndpointSettings

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

ExternalEvaluationEnforcementSettings

Nome	Descrição	Valor
endpointSettings	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.	corda
resultLifespan	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.	corda Restrições: Padrão = `^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$`
roleDefinitionIds	Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade.	string[]

Microsoft.Authorization/policyDefinitions

Nome	Descrição	Valor
nome	O nome do recurso	corda Restrições: Padrão = `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$` (obrigatório)
Propriedades	As propriedades de definição de política.	PolicyDefinitionProperties
tipo	O tipo de recurso	"Microsoft.Authorization/policyDefinitions@2025-03-01"

ParameterDefinitions

Nome	Descrição	Valor

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.	corda
displayName	O nome de exibição do parâmetro.	corda
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.	corda

PolicyDefinitionProperties

Nome	Descrição	Valor
descrição	A descrição da definição de política.	corda
displayName	O nome de exibição da definição de política.	corda
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.	corda
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.	ParameterDefinitions
policyRule	A regra de política.	qualquer
policyType	O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.	'BuiltIn' 'Personalizado' 'NotSpecified' 'Estático'
Versão	A versão de definição de política no formato #.#.#.	corda
Versões	Uma lista de versões disponíveis para essa definição de política.	string[]

Compartilhar via

Microsoft.Authorization policyDefinitions

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

ExternalEvaluationEndpointSettings

ExternalEvaluationEnforcementSettings

Microsoft.Authorization/policyDefinitions

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionProperties

Exemplos de uso

Exemplos de Início Rápido do Azure

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

ExternalEvaluationEndpointSettings

ExternalEvaluationEnforcementSettings

Microsoft.Authorization/policyDefinitions

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionProperties

Exemplos de uso

Modelos de Início Rápido do Azure

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

Formato de recurso

Valores de propriedade

ExternalEvaluationEndpointSettings

ExternalEvaluationEnforcementSettings

Microsoft.Authorization/policyDefinitions

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionProperties

Comentários

Recursos adicionais