Policy Definitions - Create Or Update
Cria ou atualiza uma definição de política numa subscrição.
Esta operação cria ou atualiza uma definição de política na subscrição especificada com o nome especificado.
PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
policy
|
path | True |
string |
O nome da definição de política a criar. Regex pattern: |
subscription
|
path | True |
string uuid |
O ID da subscrição de destino. O valor tem de ser um UUID. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
properties.description |
string |
A descrição da definição de política. |
properties.displayName |
string |
O nome a apresentar da definição de política. |
properties.metadata |
object |
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. |
properties.mode |
string |
O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. |
properties.parameters |
<string,
Parameter |
As definições de parâmetros para parâmetros utilizados na regra de política. As chaves são os nomes dos parâmetros. |
properties.policyRule |
object |
A regra de política. |
properties.policyType |
O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. |
|
properties.version |
string |
A versão de definição de política no formato #.#.#. |
properties.versions |
string[] |
Uma lista de versões disponíveis para esta definição de política. |
Respostas
Name | Tipo | Description |
---|---|---|
201 Created |
Criado – devolve informações sobre a definição de política. |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
Create or update a policy definition |
Create or update a policy definition with advanced parameters |
Create or update a policy definition
Sample Request
PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2023-04-01
{
"properties": {
"mode": "All",
"displayName": "Enforce resource naming convention",
"description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
"metadata": {
"category": "Naming"
},
"policyRule": {
"if": {
"not": {
"field": "name",
"like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
}
},
"then": {
"effect": "deny"
}
},
"parameters": {
"prefix": {
"type": "String",
"metadata": {
"displayName": "Prefix",
"description": "Resource name prefix"
}
},
"suffix": {
"type": "String",
"metadata": {
"displayName": "Suffix",
"description": "Resource name suffix"
}
}
}
}
}
Sample Response
{
"id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"type": "Microsoft.Authorization/policyDefinitions",
"name": "ResourceNaming",
"properties": {
"mode": "All",
"displayName": "Naming Convention",
"description": "Force resource names to begin with 'prefix' and end with 'suffix'",
"metadata": {
"category": "Naming"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"policyRule": {
"if": {
"not": {
"field": "name",
"like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
}
},
"then": {
"effect": "deny"
}
},
"parameters": {
"prefix": {
"type": "String",
"metadata": {
"displayName": "Prefix",
"description": "Resource name prefix"
}
},
"suffix": {
"type": "String",
"metadata": {
"displayName": "Suffix",
"description": "Resource name suffix"
}
}
},
"policyType": "Custom"
}
}
Create or update a policy definition with advanced parameters
Sample Request
PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/EventHubDiagnosticLogs?api-version=2023-04-01
{
"properties": {
"mode": "Indexed",
"displayName": "Event Hubs should have diagnostic logging enabled",
"description": "Audit enabling of logs and retain them up to a year. This enables recreation of activity trails for investigation purposes when a security incident occurs or your network is compromised",
"metadata": {
"category": "Event Hub"
},
"policyRule": {
"if": {
"field": "type",
"equals": "Microsoft.EventHub/namespaces"
},
"then": {
"effect": "AuditIfNotExists",
"details": {
"type": "Microsoft.Insights/diagnosticSettings",
"existenceCondition": {
"allOf": [
{
"field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.enabled",
"equals": "true"
},
{
"field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.days",
"equals": "[parameters('requiredRetentionDays')]"
}
]
}
}
}
},
"parameters": {
"requiredRetentionDays": {
"type": "Integer",
"defaultValue": 365,
"allowedValues": [
0,
30,
90,
180,
365
],
"metadata": {
"displayName": "Required retention (days)",
"description": "The required diagnostic logs retention in days"
}
}
}
}
}
Sample Response
{
"id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"type": "Microsoft.Authorization/policyDefinitions",
"name": "ResourceNaming",
"properties": {
"mode": "Indexed",
"displayName": "Event Hubs should have diagnostic logging enabled",
"description": "Audit enabling of logs and retain them up to a year. This enables recreation of activity trails for investigation purposes when a security incident occurs or your network is compromised",
"metadata": {
"category": "Event Hub"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"policyRule": {
"if": {
"field": "type",
"equals": "Microsoft.EventHub/namespaces"
},
"then": {
"effect": "AuditIfNotExists",
"details": {
"type": "Microsoft.Insights/diagnosticSettings",
"existenceCondition": {
"allOf": [
{
"field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.enabled",
"equals": "true"
},
{
"field": "Microsoft.Insights/diagnosticSettings/logs[*].retentionPolicy.days",
"equals": "[parameters('requiredRetentionDays')]"
}
]
}
}
}
},
"parameters": {
"requiredRetentionDays": {
"type": "Integer",
"defaultValue": 365,
"allowedValues": [
0,
30,
90,
180,
365
],
"metadata": {
"displayName": "Required retention (days)",
"description": "The required diagnostic logs retention in days"
}
}
}
}
}
Definições
Name | Description |
---|---|
Cloud |
Uma resposta de erro de uma operação de política. |
created |
O tipo de identidade que criou o recurso. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
Resposta a Erros |
Metadata |
Metadados gerais para o parâmetro . |
Parameter |
A definição de um parâmetro que pode ser fornecido à política. |
parameter |
O tipo de dados do parâmetro . |
Policy |
A definição de política. |
policy |
O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. |
system |
Metadados relativos à criação e última modificação do recurso. |
CloudError
Uma resposta de erro de uma operação de política.
Name | Tipo | Description |
---|---|---|
error |
Resposta a Erros |
createdByType
O tipo de identidade que criou o recurso.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informações adicionais. |
ErrorResponse
Resposta a Erros
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
Metadata
Metadados gerais para o parâmetro .
Name | Tipo | Description |
---|---|---|
assignPermissions |
boolean |
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. |
description |
string |
A descrição do parâmetro . |
displayName |
string |
O nome a apresentar do parâmetro . |
strongType |
string |
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. |
ParameterDefinitionsValue
A definição de um parâmetro que pode ser fornecido à política.
Name | Tipo | Description |
---|---|---|
allowedValues |
object[] |
Os valores permitidos para o parâmetro . |
defaultValue |
object |
O valor predefinido para o parâmetro se não for fornecido nenhum valor. |
metadata |
Metadados gerais para o parâmetro . |
|
schema |
object |
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/. |
type |
O tipo de dados do parâmetro . |
parameterType
O tipo de dados do parâmetro .
Name | Tipo | Description |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
PolicyDefinition
A definição de política.
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
id |
string |
O ID da definição de política. |
|
name |
string |
O nome da definição de política. |
|
properties.description |
string |
A descrição da definição de política. |
|
properties.displayName |
string |
O nome a apresentar da definição de política. |
|
properties.metadata |
object |
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. |
|
properties.mode |
string |
Indexed |
O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data. |
properties.parameters |
<string,
Parameter |
As definições de parâmetros para parâmetros utilizados na regra de política. As chaves são os nomes dos parâmetros. |
|
properties.policyRule |
object |
A regra de política. |
|
properties.policyType |
O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. |
||
properties.version |
string |
A versão de definição de política no formato #.#.#. |
|
properties.versions |
string[] |
Uma lista de versões disponíveis para esta definição de política. |
|
systemData |
Os metadados do sistema relacionados com este recurso. |
||
type |
string |
O tipo de recurso (Microsoft.Authorization/policyDefinitions). |
policyType
O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
Name | Tipo | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |