Política Microsoft.AuthorizationSetDefinitions 2020-09-01
Definição de recurso do Bicep
O tipo de recurso policySetDefinitions é 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 policySetDefinitions pode ser implementado com operações que visam:
- Grupos de gestão – veja os comandos de implementação do grupo de gestão
- Subscrições - Veja os comandos de implementação da subscrição
Pode referenciar este tipo de recurso como um recurso só de leitura ao nível de: Inquilinos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Authorization/policySetDefinitions, adicione o seguinte Bicep ao seu 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 (obrigatório) Limite de carateres: 1-128 nome a apresentar 1-64 nome de 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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome a apresentar da definição do conjunto de políticas. | string |
| do IdP | Os metadados de definição do conjunto de políticas. Os metadados são um objeto com extremidade aberta e, normalmente, são uma coleção de pares de valores chave. | Para o Bicep, pode utilizar a função any( ). |
| parâmetros | Os parâmetros de definição do conjunto de políticas que podem ser utilizados em referências de definições de política. | ParameterDefinitions |
| policyDefinitionGroups | Os metadados que descrevem grupos de referências de definições de políticas na 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 |
|---|---|---|
| {customized property} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nome | Descrição | Valor |
|---|---|---|
| allowedValues | Os valores permitidos para o parâmetro. | any[] |
| defaultValue | O valor predefinido para o parâmetro se não for fornecido nenhum valor. | Para o Bicep, pode utilizar a função any( ). |
| do IdP | Metadados gerais para o parâmetro. | ParameterDefinitionsValueMetadata |
| 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( ). |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Um ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| categoria | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome a apresentar do grupo. | string |
| name | O nome do grupo. | cadeia (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| groupNames | O nome dos grupos a que esta referência de definição de política pertence. | string[] |
| parâmetros | Os valores dos parâmetros da regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | O ID da definição de política ou definição do conjunto de políticas. | cadeia (obrigatório) |
| policyDefinitionReferenceId | Um ID exclusivo (dentro da definição do conjunto de políticas) para esta referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| valor | O valor do parâmetro . | Para Bicep, pode utilizar a função any( ). |
Definição de recurso do modelo arm
O tipo de recurso policySetDefinitions é 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 policySetDefinitions pode ser implementado com operações que visam:
- Grupos de gestão – veja os comandos de implementação do grupo de gestão
- Subscrições – veja os comandos de implementação da subscrição
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/policySetDefinitions, adicione o seguinte JSON ao seu 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 (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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome a apresentar da definição do conjunto de políticas. | string |
| do IdP | Os metadados de definição do conjunto de políticas. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave. | |
| parâmetros | Os parâmetros de definição do conjunto de políticas que podem ser utilizados 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 na 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" "Não Indicado" "Estático" |
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 |
| 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} |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Um ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| categoria | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome a apresentar do grupo. | string |
| name | O nome do grupo. | cadeia (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| groupNames | O nome dos grupos a que esta referência de definição de política pertence. | string[] |
| parâmetros | Os valores dos parâmetros da regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | O ID da definição de política ou definição do conjunto de políticas. | cadeia (obrigatório) |
| policyDefinitionReferenceId | Um ID exclusivo (dentro da definição do conjunto de políticas) para esta referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| valor | O valor do parâmetro . |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso policySetDefinitions é 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 policySetDefinitions 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/policySetDefinitions, adicione o seguinte Terraform ao seu 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 (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. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| Nome | Descrição | Valor |
|---|---|---|
| descrição | A descrição da definição do conjunto de políticas. | string |
| displayName | O nome a apresentar da definição do conjunto de políticas. | string |
| do IdP | Os metadados de definição do conjunto de políticas. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave. | |
| parâmetros | Os parâmetros de definição do conjunto de políticas que podem ser utilizados 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 na 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 |
|---|---|---|
| {customized property} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nome | Descrição | Valor |
|---|---|---|
| allowedValues | Os valores permitidos para o parâmetro. | any[] |
| defaultValue | O valor predefinido para o parâmetro se não for fornecido nenhum valor. | |
| do IdP | Metadados gerais para o parâmetro. | ParameterDefinitionsValueMetadata |
| 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 de recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de políticas. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito da 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 de valores com suporte de contexto para o utilizador escolher. | string |
| {customized property} |
PolicyDefinitionGroup
| Nome | Descrição | Valor |
|---|---|---|
| additionalMetadataId | Um ID de recurso de um recurso que contém metadados adicionais sobre o grupo. | string |
| categoria | A categoria do grupo. | string |
| descrição | A descrição do grupo. | string |
| displayName | O nome a apresentar do grupo. | string |
| name | O nome do grupo. | cadeia (obrigatório) |
PolicyDefinitionReference
| Nome | Descrição | Valor |
|---|---|---|
| groupNames | O nome dos grupos a que esta referência de definição de política pertence. | cadeia[] |
| parâmetros | Os valores dos parâmetros da regra de política referenciada. As chaves são os nomes dos parâmetros. | ParameterValues |
| policyDefinitionId | O ID da definição de política ou definição do conjunto de políticas. | cadeia (obrigatório) |
| policyDefinitionReferenceId | Um ID exclusivo (dentro da definição do conjunto de políticas) para esta referência de definição de política. | string |
ParameterValues
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | ParameterValuesValue |
ParameterValuesValue
| Nome | Descrição | Valor |
|---|---|---|
| valor | O valor do parâmetro. |