Partilhar via


Política Microsoft.AuthorizationDefinições

Definição de recurso do Bicep

O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão no Bicep.

O tipo de recurso policyDefinitions pode ser implementado com operações que visam:

Pode referenciar este tipo de recurso como um recurso só de leitura ao nível de: Inquilinos

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

Formato do recurso

Para criar um recurso Microsoft.Authorization/policyDefinitions, adicione o seguinte Bicep ao seu 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 (obrigatório)

Limite de carateres: 1-128 nome a apresentar

1-64 nome do recurso

Carateres válidos:
O nome a apresentar pode conter quaisquer carateres.

O nome do recurso não pode utilizar:
<>*%&:\?+/ ou controlar carateres.

Não é possível terminar com ponto final ou espaço.
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. Recurso de destino

Para Bicep, defina esta propriedade como o nome simbólico do recurso para aplicar o recurso de extensão.
propriedades 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 a apresentar da definição de política. string
do IdP Os metadados de definição de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave. Para Bicep, pode utilizar a função any( ).
mode O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. string
parâmetros As definições de parâmetros para parâmetros utilizados na regra de política. As chaves são os nomes dos parâmetros. ParameterDefinitions
policyRule A regra de política. Para Bicep, pode utilizar 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'
"Personalizado"
"Não Indicado"
"Estático"
versão A versão de definição de política no formato #.#.#. string
versões Uma lista de versões disponíveis para esta definição de política. string[]

ParameterDefinitions

Nome Descrição Valor
{customized property} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro . any[]
valordepredefinido O valor predefinido para o parâmetro se não for fornecido nenhum valor. Para Bicep, pode utilizar a função any( ).
do IdP Metadados gerais para o parâmetro . ParameterDefinitionsValueMetadata
esquema Fornece a validação de entradas de parâmetros durante a atribuição com um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo de objeto e segue a implementação Json.NET Schema 2019-09. Pode saber mais sobre como utilizar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/. Para Bicep, pode utilizar a função any( ).
tipo O tipo de dados do parâmetro . "Matriz"
'Booleano'
"DateTime"
'Float'
"Número Inteiro"
'Objeto'
"Cadeia"

ParameterDefinitionsValueMetadata

Nome Descrição Valor
assignPermissions Defina como verdadeiro para ter portal do Azure criar atribuições de funções no ID do recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de política. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito de atribuição. bool
descrição A descrição do parâmetro . string
displayName O nome a apresentar do parâmetro . string
strongType Utilizado ao atribuir a definição de política através do portal. Fornece uma lista com deteção de contexto de valores para o utilizador escolher. string
{customized property} Para Bicep, pode utilizar a função any( ).

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Implementar uma definição de política e atribuir a um grupo de gestão

Implementar no Azure
Este modelo é um modelo de nível de grupo de gestão que irá criar uma definição de política e atribuir essa política ao grupo de gestão de destino. Atualmente, este modelo não pode ser implementado através do portal do Azure.
Implementar um Policy Def e Atribuir a vários Grupos Mgmt

Implementar no Azure
Este modelo é um modelo de nível de grupo de gestão que irá criar uma definição de política e atribuir essa política a vários grupos de gestão.
Create um Gestor de Rede Virtual do Azure e VNETs de exemplo

Implementar no Azure
Este modelo implementa um Gestor de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos com nome. Suporta várias topologias de conectividade e tipos de associação a grupos de rede.

Definição de recurso do modelo arm

O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão nos modelos do ARM.

O tipo de recurso policyDefinitions pode ser implementado com operações que visam:

Pode referenciar este tipo de recurso como um recurso só de leitura ao nível de: Inquilinos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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": "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 de recursos '2023-04-01'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-128 nome a apresentar

1-64 nome do recurso

Carateres válidos:
O nome a apresentar pode conter quaisquer carateres.

O nome do recurso não pode utilizar:
<>*%&:\?+/ ou controlar carateres.

Não é possível terminar com ponto final ou espaço.
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. Recurso de destino

Para JSON, defina o valor como o nome completo do recurso ao qual pretende aplicar o recurso de extensão .
propriedades 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 a apresentar da definição de política. string
do IdP Os metadados de definição de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave.
mode O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. string
parâmetros As definições de parâmetros para parâmetros utilizados 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"
"Não Indicado"
"Estático"
versão A versão de definição de política no formato #.#.#. string
versões Uma lista de versões disponíveis para esta definição de política. string[]

ParameterDefinitions

Nome Descrição Valor
{customized property} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro . any[]
valordepredefinido O valor predefinido para o parâmetro se não for fornecido nenhum valor.
do IdP Metadados gerais para o parâmetro . ParameterDefinitionsValueMetadata
esquema Fornece a validação de entradas de parâmetros durante a atribuição com um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo de objeto e segue a implementação Json.NET Schema 2019-09. Pode saber mais sobre como utilizar 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"
'Booleano'
"DateTime"
'Float'
"Número Inteiro"
'Objeto'
"Cadeia"

ParameterDefinitionsValueMetadata

Nome Descrição Valor
assignPermissions Defina como verdadeiro para ter portal do Azure criar atribuições de funções no ID do recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de política. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito de atribuição. bool
descrição A descrição do parâmetro . string
displayName O nome a apresentar do parâmetro . string
strongType Utilizado ao atribuir a definição de política através do portal. Fornece uma lista com deteção de contexto de valores para o utilizador escolher. string
{customized property}

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Implementar uma definição de política e atribuir a um grupo de gestão

Implementar no Azure
Este modelo é um modelo de nível de grupo de gestão que irá criar uma definição de política e atribuir essa política ao grupo de gestão de destino. Atualmente, este modelo não pode ser implementado através do portal do Azure.
Implementar um Policy Def e Atribuir a vários Grupos Mgmt

Implementar no Azure
Este modelo é um modelo de nível de grupo de gestão que irá criar uma definição de política e atribuir essa política a vários grupos de gestão.
Create um Gestor de Rede Virtual do Azure e VNETs de exemplo

Implementar no Azure
Este modelo implementa um Gestor de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos com nome. Suporta várias topologias de conectividade e tipos de associação a grupos de rede.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso policyDefinitions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a parent_id propriedade neste recurso para definir o âmbito deste recurso.

O tipo de recurso policyDefinitions pode ser implementado com operações que visam:

  • Grupos de gestão
  • Subscrições

Pode referenciar este tipo de recurso como um recurso só de leitura ao nível de: Inquilinos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@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 (obrigatório)

Limite de carateres: 1-128 nome a apresentar

1-64 nome do recurso

Carateres válidos:
O nome a apresentar pode conter quaisquer carateres.

O nome do recurso não pode utilizar:
<>*%&:\?+/ ou controlar carateres.

Não é possível terminar com ponto final ou espaço.
parent_id O ID do recurso ao quais aplicar este recurso de extensão. cadeia (obrigatório)
propriedades 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 a apresentar da definição de política. string
do IdP Os metadados de definição de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave.
mode O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. string
parâmetros As definições de parâmetros para parâmetros utilizados 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"
versão A versão de definição de política no formato #.#.#. string
versões Uma lista de versões disponíveis para esta definição de política. string[]

ParameterDefinitions

Nome Descrição Valor
{customized property} ParameterDefinitionsValue

ParameterDefinitionsValue

Nome Descrição Valor
allowedValues Os valores permitidos para o parâmetro . any[]
valordepredefinido O valor predefinido para o parâmetro se não for fornecido nenhum valor.
do IdP Metadados gerais para o parâmetro . ParameterDefinitionsValueMetadata
esquema Fornece a validação de entradas de parâmetros durante a atribuição com um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo de objeto e segue a implementação Json.NET Schema 2019-09. Pode saber mais sobre como utilizar 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"
"Booleano"
"DateTime"
"Flutuante"
"Número Inteiro"
"Objeto"
"Cadeia"

ParameterDefinitionsValueMetadata

Nome Descrição Valor
assignPermissions Defina como verdadeiro para ter portal do Azure criar atribuições de funções no ID do recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de política. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito de atribuição. bool
descrição A descrição do parâmetro . string
displayName O nome a apresentar do parâmetro . string
strongType Utilizado ao atribuir a definição de política através do portal. Fornece uma lista com deteção de contexto de valores para o utilizador escolher. string
{customized property}