Policy Assignments - Create By Id

Servicio:: Policy

Versión de la API:: 2025-01-01

Crea o actualiza una asignación de directiva.
Esta operación crea o actualiza la asignación de políticas con el ID dado. Las asignaciones de políticas realizadas en un ámbito se aplican a todos los recursos contenidos en ese ámbito. Por ejemplo, cuando asignas una política a un grupo de recursos, esa política se aplica a todos los recursos del grupo. Los identificadores de asignación de políticas tienen este formato: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Los ámbitos válidos son: grupo de gestión (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', o resource (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}/{resourceName}'.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
policyAssignmentId	path	True	string	El ID de la asignación de política a crear. Use el formato '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	Identity	Identidad administrada asociada a la asignación de directiva.
location	string	Ubicación de la asignación de directiva. Solo es necesario al usar la identidad administrada.
properties.assignmentType	assignmentType	Tipo de asignación de directiva. Los valores posibles son NotSpecified, System, SystemHidden y Custom. El valor es inmutable.
properties.definitionVersion	string	Versión de la definición de directiva que se va a usar.
properties.description	string	Este mensaje formará parte de la respuesta en caso de infracción de directiva.
properties.displayName	string	Nombre para mostrar de la asignación de directiva.
properties.enforcementMode	enforcementMode	Modo de cumplimiento de asignación de directivas. Los valores posibles son Default, DoNotEnforce e Enroll
properties.metadata	object	Metadatos de asignación de directiva. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor.
properties.nonComplianceMessages	NonComplianceMessage[]	Los mensajes que describen por qué un recurso no es compatible con la directiva.
properties.notScopes	string[]	Ámbitos excluidos de la directiva.
properties.overrides	Override[]	Invalidación del valor de la propiedad de directiva.
properties.parameters	<string, ParameterValuesValue>	Valores de parámetro para la regla de directiva asignada. Las claves son los nombres de parámetro.
properties.policyDefinitionId	string	Identificador de la definición de directiva o definición del conjunto de directivas que se asigna.
properties.resourceSelectors	ResourceSelector[]	Lista del selector de recursos para filtrar las directivas por propiedades de recursos.

Respuestas

Nombre	Tipo	Description
201 Created	PolicyAssignment	Creado - Información de devolución sobre la asignación de póliza.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Solicitud de ejemplo

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"
  }
}

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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"
  }
}

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
assignmentType	Tipo de asignación de directiva. Los valores posibles son NotSpecified, System, SystemHidden y Custom. El valor es inmutable.
CloudError	Respuesta de error de una operación de directiva.
createdByType	Tipo de identidad que creó el recurso.
enforcementMode	Modo de cumplimiento de asignación de directivas. Los valores posibles son Default, DoNotEnforce e Enroll
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
Identity	Identidad del recurso. Las asignaciones de políticas soportan un máximo de una identidad. Eso es o bien una identidad asignada por el sistema o una identidad asignada por un solo usuario.
NonComplianceMessage	Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.
Override	Invalidación del valor de la propiedad de directiva.
OverrideKind	Tipo de invalidación.
ParameterValuesValue	El valor de un parámetro.
PolicyAssignment	La asignación de política.
ResourceIdentityType	Tipo de identidad. Este es el único campo obligatorio al agregar una identidad asignada por el sistema o el usuario a un recurso.
ResourceSelector	Selector de recursos para filtrar las directivas por propiedades de recursos.
Selector	Expresión del selector.
SelectorKind	Tipo de selector.
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentities	Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

assignmentType

Enumeración

Tipo de asignación de directiva. Los valores posibles son NotSpecified, System, SystemHidden y Custom. El valor es inmutable.

Valor	Description
NotSpecified
System
SystemHidden
Custom

CloudError

Objeto

Respuesta de error de una operación de directiva.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

enforcementMode

Enumeración

Modo de cumplimiento de asignación de directivas. Los valores posibles son Default, DoNotEnforce e Enroll

Valor	Description
Default	El efecto de la directiva se aplica durante la creación o actualización de recursos.
DoNotEnforce	El efecto de la política no se aplica durante la creación o actualización de recursos.
Enroll	El efecto de la política no se aplica durante la creación o actualización del recurso hasta que el recurso o el alcance del recurso se inscribe en la instancia de asignación. La inscripción se produce tras el despliegue del recurso de inscripción de pólizas.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

Identity

Objeto

Identidad del recurso. Las asignaciones de políticas soportan un máximo de una identidad. Eso es o bien una identidad asignada por el sistema o una identidad asignada por un solo usuario.

Nombre	Tipo	Description
principalId	string	El ID principal de la identidad del recurso. Esta propiedad solo se proporcionará para una identidad asignada al sistema
tenantId	string	El ID de tenant de la identidad del recurso. Esta propiedad solo se proporcionará para una identidad asignada al sistema
type	ResourceIdentityType	Tipo de identidad. Este es el único campo obligatorio al agregar una identidad asignada por el sistema o el usuario a un recurso.
userAssignedIdentities	UserAssignedIdentities	Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Objeto

Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.

Nombre	Tipo	Description
message	string	Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.
policyDefinitionReferenceId	string	Identificador de referencia de definición de directiva dentro de una definición de conjunto de directivas para el que está destinado el mensaje. Esto solo es aplicable si la asignación de directiva asigna una definición de conjunto de directivas. Si no se proporciona, el mensaje se aplica a todas las directivas asignadas por esta asignación de directiva.

Override

Objeto

Invalidación del valor de la propiedad de directiva.

Nombre	Tipo	Description
kind	OverrideKind	Tipo de invalidación.
selectors	Selector[]	Lista de las expresiones del selector.
value	string	Valor que se va a invalidar la propiedad de directiva.

OverrideKind

Enumeración

Tipo de invalidación.

Valor	Description
policyEffect	Anulará el tipo de efecto de la política.
definitionVersion	Anulará el valor de la propiedad de la versión de definición de la asignación de política.

ParameterValuesValue

Objeto

El valor de un parámetro.

Nombre	Tipo	Description
value		Valor del parámetro .