Microsoft.Authorization policySetDefinitions 2020-09-01
Definição de recurso do Bicep
O tipo de recurso policySetDefinitions é 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 policySetDefinitions 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/policySetDefinitions, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2020-09-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
}
}
Valores de propriedade
policySetDefinitions
| 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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome de exibição da definição do conjunto de políticas. | string |
| metadata | Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares chave-valor. | Para o Bicep, você pode usar a função any(). |
| parameters | Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. | ParameterDefinitions |
| policyDefinitionGroups | Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. | PolicyDefinitionGroup[] |
| policyDefinitions | Uma matriz de referências de definição de política. | PolicyDefinitionReference[] (obrigatório) |
| policyType | O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
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 |
| 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 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} | Para o Bicep, você pode usar a função any(). |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| category | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome de exibição do grupo. | string |
| name | O nome do grupo. | cadeia de caracteres (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| Groupnames | O nome dos grupos aos quais essa referência de definição de política pertence. | string[] |
| parameters | Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | A ID da definição de política ou definição do conjunto de políticas. | cadeia de caracteres (obrigatório) |
| policyDefinitionReferenceId | Uma ID exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| value | O valor do parâmetro. | Para o Bicep, você pode usar a função any(). |
Definição de recurso de modelo do ARM
O tipo de recurso policySetDefinitions é 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 policySetDefinitions 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 de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2020-09-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string"
}
}
Valores de propriedade
policySetDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.Authorization/policySetDefinitions' |
| apiVersion | A versão da API de recursos | '2020-09-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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome de exibição da definição do conjunto de políticas. | string |
| metadata | Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares de valores de chave. | |
| parameters | Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. | ParameterDefinitions |
| policyDefinitionGroups | Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. | PolicyDefinitionGroup[] |
| policyDefinitions | Uma matriz de referências de definição de política. | PolicyDefinitionReference[] (obrigatório) |
| 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' |
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 |
| tipo | O tipo de dados do parâmetro. | 'Array' 'Boolean' 'DateTime' 'Float' 'Inteiro' 'Object' 'String' |
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} |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| category | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome de exibição do grupo. | string |
| name | O nome do grupo. | cadeia de caracteres (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| Groupnames | O nome dos grupos aos quais essa referência de definição de política pertence. | string[] |
| parameters | Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | A ID da definição de política ou definição do conjunto de políticas. | cadeia de caracteres (obrigatório) |
| policyDefinitionReferenceId | Uma ID exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| value | O valor do parâmetro. |
Definição de recurso do Terraform (provedor AzAPI)
O tipo de recurso policySetDefinitions é 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 policySetDefinitions 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 de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2020-09-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
groupNames = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
}
})
}
Valores de propriedade
policySetDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Authorization/policySetDefinitions@2020-09-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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome de exibição da definição do conjunto de políticas. | string |
| metadata | Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto encerrado e normalmente é uma coleção de pares de valores de chave. | |
| parameters | Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. | ParameterDefinitions |
| policyDefinitionGroups | Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. | PolicyDefinitionGroup[] |
| policyDefinitions | Uma matriz de referências de definição de política. | PolicyDefinitionReference[] (obrigatório) |
| 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" |
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 |
| 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} |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Uma ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| category | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome de exibição do grupo. | string |
| name | O nome do grupo. | cadeia de caracteres (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| Groupnames | O nome dos grupos aos quais essa referência de definição de política pertence. | string[] |
| parameters | Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | A ID da definição de política ou definição do conjunto de políticas. | cadeia de caracteres (obrigatório) |
| policyDefinitionReferenceId | Uma ID exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| value | O valor do parâmetro. |