Policy Definition Versions - Create Or Update At Management Group
Cria ou atualiza uma versão de definição de política num grupo de gestão.
Esta operação cria ou atualiza uma versão de definição de política no grupo de gestão especificado com o nome especificado.
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions/{policyDefinitionVersion}?api-version=2023-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
management
|
path | True |
string |
O nome do grupo de gestão. O nome não é sensível a maiúsculas e minúsculas. |
policy
|
path | True |
string |
O nome da definição de política. Regex pattern: |
policy
|
path | True |
string |
A versão de definição de política. O formato é x.y.z, em que x é o número da versão principal, y é o número da versão secundária e z é o número do patch Regex pattern: |
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 com extremidade aberta 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 #.#.#. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK – versão de definição de política atualizada com êxito. |
|
201 Created |
Criado – devolve informações sobre a versão de definição de política. |
|
Other Status Codes |
Resposta de erro que descreve a razão 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 version at management group level
Sample Request
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1?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"
},
"version": "1.2.1",
"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": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1",
"type": "Microsoft.Authorization/policyDefinitions/versions",
"name": "1.2.1",
"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",
"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"
}
}
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1",
"type": "Microsoft.Authorization/policyDefinitions/versions",
"name": "1.2.1",
"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",
"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"
}
}
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 |
O ID da versão de 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ção adicional. |
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 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. |
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 de valores com suporte de contexto 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 |
PolicyDefinitionVersion
O ID da versão de definição de política.
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
id |
string |
O ID da versão de definição de política. |
|
name |
string |
O nome da versão de 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 com extremidade aberta 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 #.#.#. |
|
systemData |
Os metadados do sistema relacionados com este recurso. |
||
type |
string |
O tipo de recurso (Microsoft.Authorization/policyDefinitions/versions). |
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. |