Policy Assignments - Create By Id

Serviço:: Policy

Versão da API:: 2025-01-01

Cria ou atualiza uma atribuição de política.
Esta operação cria ou atualiza a atribuição de políticas com o ID indicado. As atribuições de políticas feitas num âmbito aplicam-se a todos os recursos contidos nesse âmbito. Por exemplo, quando atribui uma política a um grupo de recursos, essa política aplica-se a todos os recursos do grupo. Os IDs de atribuição de políticas têm este formato: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Os escopos válidos são: grupo de gestão (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscrição (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', ou resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}/{resourceName}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2025-01-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
policyAssignmentId	path	True	string	O ID da atribuição da política a criar. Use o formato '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
identity	Identity	A identidade gerenciada associada à atribuição de política.
location	string	O local da atribuição da política. Necessário apenas ao utilizar a identidade gerenciada.
properties.assignmentType	assignmentType	O tipo de atribuição de política. Os valores possíveis são NotSpecified, System, SystemHidden e Custom. Imutável.
properties.definitionVersion	string	A versão da definição de política a ser usada.
properties.description	string	Esta mensagem fará parte da resposta em caso de violação da política.
properties.displayName	string	O nome para exibição da atribuição de política.
properties.enforcementMode	enforcementMode	O modo de imposição de atribuição de política. Os valores possíveis são Default, DoNotEnforce e Enroll
properties.metadata	object	Os metadados de atribuição de política. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave.
properties.nonComplianceMessages	NonComplianceMessage[]	As mensagens que descrevem por que um recurso não está em conformidade com a política.
properties.notScopes	string[]	Os escopos excluídos da política.
properties.overrides	Override[]	A substituição do valor da propriedade da política.
properties.parameters	<string, ParameterValuesValue>	Os valores de parâmetro para a regra de política atribuída. As chaves são os nomes dos parâmetros.
properties.policyDefinitionId	string	A ID da definição de política ou definição de conjunto de políticas que está sendo atribuída.
properties.resourceSelectors	ResourceSelector[]	A lista de seletores de recursos para filtrar políticas por propriedades de recursos.

Respostas

Name	Tipo	Description
201 Created	PolicyAssignment	Criado - Devolve informações sobre a atribuição da apólice.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

Pedido de amostra

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Resposta da amostra

Código de estado:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

Pedido de amostra

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Resposta da amostra

Código de estado:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Definições

Name	Description
assignmentType	O tipo de atribuição de política. Os valores possíveis são NotSpecified, System, SystemHidden e Custom. Imutável.
CloudError	Uma resposta de erro de uma operação de política.
createdByType	O tipo de identidade que criou o recurso.
enforcementMode	O modo de imposição de atribuição de política. Os valores possíveis são Default, DoNotEnforce e Enroll
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso. As atribuições de políticas suportam um máximo de uma identidade. Ou seja, uma identidade atribuída ao sistema ou uma identidade atribuída por um único utilizador.
NonComplianceMessage	Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro "negar" e nos resultados de conformidade não compatíveis do recurso.
Override	A substituição do valor da propriedade da política.
OverrideKind	O tipo de substituição.
ParameterValuesValue	O valor de um parâmetro.
PolicyAssignment	A atribuição de políticas.
ResourceIdentityType	O tipo de identidade. Este é o único campo obrigatório ao adicionar uma identidade atribuída ao sistema ou usuário a um recurso.
ResourceSelector	O seletor de recursos para filtrar políticas por propriedades de recursos.
Selector	A expressão do seletor.
SelectorKind	O tipo seletor.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentities	A identidade do usuário associada à política. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

assignmentType

Enumeração

O tipo de atribuição de política. Os valores possíveis são NotSpecified, System, SystemHidden e Custom. Imutável.

Valor	Description
NotSpecified
System
SystemHidden
Custom

CloudError

Object

Uma resposta de erro de uma operação de política.

Name	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

enforcementMode

Enumeração

O modo de imposição de atribuição de política. Os valores possíveis são Default, DoNotEnforce e Enroll

Valor	Description
Default	O efeito da política é aplicado durante a criação ou atualização de recursos.
DoNotEnforce	O efeito da política não é aplicado durante a criação ou atualização de recursos.
Enroll	O efeito da política não é aplicado durante a criação ou atualização do recurso até que o recurso ou o âmbito do recurso seja inscrito na instância de atribuição. A inscrição ocorre após a implementação do recurso de inscrição de políticas.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

Identity

Object

Identidade do recurso. As atribuições de políticas suportam um máximo de uma identidade. Ou seja, uma identidade atribuída ao sistema ou uma identidade atribuída por um único utilizador.

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso. Esta propriedade só será fornecida para uma identidade atribuída ao sistema
tenantId	string	O ID do tenant da identidade do recurso. Esta propriedade só será fornecida para uma identidade atribuída ao sistema
type	ResourceIdentityType	O tipo de identidade. Este é o único campo obrigatório ao adicionar uma identidade atribuída ao sistema ou usuário a um recurso.
userAssignedIdentities	UserAssignedIdentities	A identidade do usuário associada à política. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Object

Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro "negar" e nos resultados de conformidade não compatíveis do recurso.

Name	Tipo	Description
message	string	Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro "negar" e nos resultados de conformidade não compatíveis do recurso.
policyDefinitionReferenceId	string	O ID de referência de definição de política dentro de uma definição de conjunto de políticas a que a mensagem se destina. Isso só é aplicável se a atribuição de política atribuir uma definição de conjunto de políticas. Se isso não for fornecido, a mensagem se aplicará a todas as políticas atribuídas por essa atribuição de política.

Override

Object

A substituição do valor da propriedade da política.

Name	Tipo	Description
kind	OverrideKind	O tipo de substituição.
selectors	Selector[]	A lista das expressões do seletor.
value	string	O valor para substituir a propriedade policy.

OverrideKind

Enumeração

O tipo de substituição.

Valor	Description
policyEffect	Irá sobrepor-se ao tipo de efeito da política.
definitionVersion	Irá sobrepor o valor da propriedade de definição de versão da atribuição da política.

ParameterValuesValue

Object

O valor de um parâmetro.

Name	Tipo	Description
value		O valor do parâmetro.