Microsoft.Authorization policyDefinitions
Definição de recurso do Bicep
O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão no Bicep.
O tipo de recurso policyDefinitions pode ser implantado com operações direcionadas:
- Grupos de gerenciamento – Consulte comandos de implantação do grupo de gerenciamento
- Assinaturas – Consulte comandos de implantação de assinatura
Você pode referenciar esse tipo de recurso como um recurso somente leitura no nível de: Locatários
Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Valores de propriedade
policyDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: nome de exibição de 1 a 128 Nome do recurso 1-64 Caracteres válidos: O nome para exibição pode conter qualquer caractere. O nome do recurso não pode usar: <>*%&:\?+/ ou caracteres de controle. Não pode terminar com ponto ou espaço. |
| scope | Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. | Recurso de destino Para o Bicep, defina essa propriedade como o nome simbólico do recurso para aplicar o recurso de extensão. |
| properties | As propriedades de definição de política. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição de política. | string |
| displayName | O nome de exibição da definição de política. | string |
| metadata | Os metadados de definição de política. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares chave-valor. | Para o Bicep, você pode usar a função any(). |
| mode | O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. | string |
| parameters | 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. | Para o Bicep, você pode usar a função any(). |
| policyType | O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| version | A versão de definição de política no formato #.#.#. | string |
| versões | Uma lista de versões disponíveis para essa definição de política. | string[] |
ParameterDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterDefinitionsValue |
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. | Para o Bicep, você pode usar a função any(). |
| metadata | Metadados gerais para o parâmetro . | ParameterDefinitionsValueMetadata |
| esquema | Fornece 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 do Esquema Json.NET 2019-09. Você pode saber mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. |
Para o Bicep, você pode usar a função any(). |
| tipo | O tipo de dados do parâmetro. | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| Nome | Descrição | Valor |
|---|---|---|
| assignPermissions | Defina como true para que 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ê queira atribuir permissões fora do escopo de atribuição. | bool |
| descrição | A descrição do parâmetro. | string |
| displayName | O nome de exibição do parâmetro. | string |
| 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. | string |
| {propriedade personalizada} | Para o Bicep, você pode usar a função any(). |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
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. |
| Implantar um def de política e atribuir a vários Grupos 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 a vários grupos de gerenciamento. |
| Create um Gerenciador de Rede Virtual do Azure e VNETs de exemplo |
Este modelo implanta um Gerenciador de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos nomeado. Ele dá suporte a várias topologias de conectividade e tipos de associação de grupo de rede. |
Definição de recurso de modelo do ARM
O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão em modelos do ARM.
O tipo de recurso policyDefinitions pode ser implantado com operações direcionadas:
- Grupos de gerenciamento – Consulte comandos de implantação do grupo de gerenciamento
- Assinaturas – Consulte comandos de implantação de assinatura
Você pode referenciar esse tipo de recurso como um recurso somente leitura no nível de: Locatários
Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Valores de propriedade
policyDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.Authorization/policyDefinitions' |
| apiVersion | A versão da API do recurso | '2023-04-01' |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: nome de exibição de 1 a 128 Nome do recurso 1-64 Caracteres válidos: O nome para exibição pode conter qualquer caractere. O nome do recurso não pode usar: <>*%&:\?+/ ou caracteres de controle. Não pode terminar com ponto ou espaço. |
| scope | Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. | Recurso de destino Para JSON, defina o valor como o nome completo do recurso ao qual aplicar o recurso de extensão . |
| properties | As propriedades de definição de política. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição de política. | string |
| displayName | O nome de exibição da definição de política. | string |
| metadata | Os metadados de definição de política. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares chave-valor. | |
| mode | O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. | string |
| parameters | 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. | |
| policyType | O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| version | A versão de definição de política no formato #.#.#. | string |
| versões | Uma lista de versões disponíveis para essa definição de política. | string[] |
ParameterDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterDefinitionsValue |
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. | |
| metadata | Metadados gerais para o parâmetro . | ParameterDefinitionsValueMetadata |
| esquema | Fornece 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 do Esquema Json.NET 2019-09. Você pode saber mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. |
|
| tipo | O tipo de dados do parâmetro. | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| Nome | Descrição | Valor |
|---|---|---|
| assignPermissions | Defina como true para que 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ê queira atribuir permissões fora do escopo de atribuição. | bool |
| descrição | A descrição do parâmetro. | string |
| displayName | O nome de exibição do parâmetro. | string |
| 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. | string |
| {propriedade personalizada} |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
| 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. |
| Implantar um def de política e atribuir a vários Grupos 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 a vários grupos de gerenciamento. |
| Create um Gerenciador de Rede Virtual do Azure e VNETs de exemplo |
Este modelo implanta um Gerenciador de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos nomeado. Ele dá suporte a várias topologias de conectividade e tipos de associação de grupo de rede. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a parent_id propriedade nesse recurso para definir o escopo desse recurso.
O tipo de recurso policyDefinitions pode ser implantado com operações direcionadas:
- Grupos de gerenciamento
- Assinaturas
Você pode referenciar esse tipo de recurso como um recurso somente leitura no nível de: Locatários
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Authorization/policyDefinitions, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Valores de propriedade
policyDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Authorization/policyDefinitions@2023-04-01" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: nome de exibição de 1 a 128 Nome do recurso 1-64 Caracteres válidos: O nome para exibição pode conter qualquer caractere. O nome do recurso não pode usar: <>*%&:\?+/ ou caracteres de controle. Não pode terminar com ponto ou espaço. |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | cadeia de caracteres (obrigatório) |
| properties | As propriedades de definição de política. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição de política. | string |
| displayName | O nome de exibição da definição de política. | string |
| metadata | Os metadados de definição de política. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares de valores de chave. | |
| mode | O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. | string |
| parameters | 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. | |
| 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" |
| version | A versão de definição de política no formato #.#.#. | string |
| versões | Uma lista de versões disponíveis para essa definição de política. | string[] |
ParameterDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterDefinitionsValue |
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. | |
| metadata | Metadados gerais para o parâmetro . | ParameterDefinitionsValueMetadata |
| esquema | Fornece 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 do Esquema Json.NET 2019-09. Você pode saber mais sobre como usar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. |
|
| tipo | O tipo de dados do parâmetro. | "Matriz" "Boolean" "DateTime" "Float" "Inteiro" "Object" "Cadeia de caracteres" |
ParameterDefinitionsValueMetadata
| Nome | Descrição | Valor |
|---|---|---|
| assignPermissions | Defina como true para ter portal do Azure criar 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ê queira atribuir permissões fora do escopo de atribuição. | bool |
| descrição | A descrição do parâmetro. | string |
| displayName | O nome de exibição do parâmetro. | string |
| 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. | string |
| {propriedade personalizada} |