Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Definição de recursos do bíceps
O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o seguinte Bíceps ao seu 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 de 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 |
| âmbito | 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 final. | cadeia (de caracteres) |
ExternalEvaluationEnforcementSettings
| Nome | Descrição | Valor |
|---|---|---|
| endpointSettings | As configurações de um ponto de extremidade externo que fornecem resultados de avaliação. | ExternalEvaluationEndpointSettings |
| missingTokenAction | O que fazer ao avaliar uma política de aplicação que requer uma avaliação externa e o token está faltando. Os valores possíveis são Audit e Deny e expressões de linguagem são suportadas. | cadeia (de caracteres) |
| resultadoTempo de vida ú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 as expressões de idioma são suportadas. | cadeia (de caracteres) |
| IDs de Definição de Função | Uma matriz dos IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. | string[] |
ParâmetroDefinições
| Nome | Descrição | Valor |
|---|
ParameterDefinitionsValue
| Nome | Descrição | Valor |
|---|---|---|
| valores permitidos | Os valores permitidos para o parâmetro. | qualquer[] |
| valor padrão | 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
| 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 da atribuição. | Bool |
| descrição | A descrição do parâmetro. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição do parâmetro. | cadeia (de caracteres) |
| 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. | cadeia (de caracteres) |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição da política. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição da definição de política. | cadeia (de caracteres) |
| externalEvaluationEnforcementSettings | Os detalhes da fonte dos resultados da avaliação externa exigidos pela política durante a avaliação da aplicação. | ExternalEvaluationEnforcementSettings |
| metadados | Os metadados de definição de política. Os metadados são um objeto aberto e normalmente são 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 (de caracteres) |
| parâmetros | As definições de parâmetros para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. | ParâmetroDefinições |
| policyRule | A regra política. | qualquer |
| policyType | O tipo de definição de política. 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 de política no formato #.#.#. | cadeia (de caracteres) |
| versões | Uma lista de versões disponíveis para esta definição de política. | string[] |
Exemplos de uso
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Criar um Gerenciador de Rede Virtual do Azure e exemplos de VNETs | Este modelo implanta um Gerenciador de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos nomeado. Ele suporta várias topologias de conectividade e tipos de associação de grupo de rede. |
| implantar uma definição de política e atribuir a vários grupos de gerenciamento | Este 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 | Este 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 ARM
O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o seguinte JSON ao seu 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
Microsoft.Authorization/policyDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| Versão da API | A versão 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 final. | cadeia (de caracteres) |
ExternalEvaluationEnforcementSettings
| Nome | Descrição | Valor |
|---|---|---|
| endpointSettings | As configurações de um ponto de extremidade externo que fornecem resultados de avaliação. | ExternalEvaluationEndpointSettings |
| missingTokenAction | O que fazer ao avaliar uma política de aplicação que requer uma avaliação externa e o token está faltando. Os valores possíveis são Audit e Deny e expressões de linguagem são suportadas. | cadeia (de caracteres) |
| resultadoTempo de vida ú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 as expressões de idioma são suportadas. | cadeia (de caracteres) |
| IDs de Definição de Função | Uma matriz dos IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. | string[] |
ParâmetroDefinições
| Nome | Descrição | Valor |
|---|
ParameterDefinitionsValue
| Nome | Descrição | Valor |
|---|---|---|
| valores permitidos | Os valores permitidos para o parâmetro. | qualquer[] |
| valor padrão | 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
| 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 da atribuição. | Bool |
| descrição | A descrição do parâmetro. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição do parâmetro. | cadeia (de caracteres) |
| 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. | cadeia (de caracteres) |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição da política. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição da definição de política. | cadeia (de caracteres) |
| externalEvaluationEnforcementSettings | Os detalhes da fonte dos resultados da avaliação externa exigidos pela política durante a avaliação da aplicação. | ExternalEvaluationEnforcementSettings |
| metadados | Os metadados de definição de política. Os metadados são um objeto aberto e normalmente são 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 (de caracteres) |
| parâmetros | As definições de parâmetros para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. | ParâmetroDefinições |
| policyRule | A regra política. | qualquer |
| policyType | O tipo de definição de política. 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 de política no formato #.#.#. | cadeia (de caracteres) |
| versões | Uma lista de versões disponíveis para esta definição de política. | string[] |
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
| Modelo | Descrição |
|---|---|
|
Criar um Gerenciador de Rede Virtual do Azure e exemplos de VNETs |
Este modelo implanta um Gerenciador de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos nomeado. Ele suporta várias topologias de conectividade e tipos de associação de grupo de rede. |
|
implantar uma definição de política e atribuir a vários grupos de gerenciamento |
Este 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 |
Este 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 recursos Terraform (provedor AzAPI)
O tipo de recurso policyDefinitions 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/policyDefinitions, adicione o seguinte Terraform 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 de 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. | string (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 final. | cadeia (de caracteres) |
ExternalEvaluationEnforcementSettings
| Nome | Descrição | Valor |
|---|---|---|
| endpointSettings | As configurações de um ponto de extremidade externo que fornecem resultados de avaliação. | ExternalEvaluationEndpointSettings |
| missingTokenAction | O que fazer ao avaliar uma política de aplicação que requer uma avaliação externa e o token está faltando. Os valores possíveis são Audit e Deny e expressões de linguagem são suportadas. | cadeia (de caracteres) |
| resultadoTempo de vida ú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 as expressões de idioma são suportadas. | cadeia (de caracteres) |
| IDs de Definição de Função | Uma matriz dos IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade. | string[] |
ParâmetroDefinições
| Nome | Descrição | Valor |
|---|
ParameterDefinitionsValue
| Nome | Descrição | Valor |
|---|---|---|
| valores permitidos | Os valores permitidos para o parâmetro. | qualquer[] |
| valor padrão | 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
| 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 da atribuição. | Bool |
| descrição | A descrição do parâmetro. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição do parâmetro. | cadeia (de caracteres) |
| 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. | cadeia (de caracteres) |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição da política. | cadeia (de caracteres) |
| nome de exibição | O nome para exibição da definição de política. | cadeia (de caracteres) |
| externalEvaluationEnforcementSettings | Os detalhes da fonte dos resultados da avaliação externa exigidos pela política durante a avaliação da aplicação. | ExternalEvaluationEnforcementSettings |
| metadados | Os metadados de definição de política. Os metadados são um objeto aberto e normalmente são 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 (de caracteres) |
| parâmetros | As definições de parâmetros para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros. | ParâmetroDefinições |
| policyRule | A regra política. | qualquer |
| policyType | O tipo de definição de política. 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 de política no formato #.#.#. | cadeia (de caracteres) |
| versões | Uma lista de versões disponíveis para esta definição de política. | string[] |
Exemplos de uso
Amostras 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 = ["*"]
}