Policy Assignments - Update

Ссылка

Service:: Policy

API Version:: 2021-06-01

Эта операция обновляет назначение политики с заданной областью и именем. Назначения политик применяются ко всем ресурсам, содержащимся в их области. Например, при назначении политики в области группы ресурсов эта политика применяется ко всем ресурсам в группе.

PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2021-06-01

Параметры URI

Name	In	Required	Type	Description
policyAssignmentName	path	True	string	Имя назначения политики.
scope	path	True	string	Область назначения политики. Допустимые области: группа управления (формат "/providers/Microsoft.Management/managementGroups/{managementGroup}"), подписка (формат : "/subscriptions/{subscriptionId}"), группа ресурсов (формат : "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	Версия API, используемая для операции.

Текст запроса

Name	Type	Description
identity	Identity	Управляемое удостоверение, связанное с назначением политики.
location	string	Расположение назначения политики. Требуется только при использовании управляемого удостоверения.

Ответы

Name	Type	Description
200 OK	PolicyAssignment	ОК . Возвращает сведения о назначении политики.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update a policy assignment with a system assigned identity

Update a policy assignment with a user assigned identity

Update a policy assignment with a system assigned identity

Sample Request

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2021-06-01

{
  "location": "eastus",
  "identity": {
    "type": "SystemAssigned"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.resources.models.Identity;
import com.azure.resourcemanager.resources.models.PolicyAssignmentUpdate;
import com.azure.resourcemanager.resources.models.ResourceIdentityType;
import java.util.HashMap;
import java.util.Map;

/** Samples for PolicyAssignments Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentity.json
     */
    /**
     * Sample code: Update a policy assignment with a system assigned identity.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAPolicyAssignmentWithASystemAssignedIdentity(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .policyClient()
            .getPolicyAssignments()
            .updateWithResponse(
                "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
                "EnforceNaming",
                new PolicyAssignmentUpdate()
                    .withLocation("eastus")
                    .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED)),
                Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armpolicy_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armpolicy"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentity.json
func ExampleAssignmentsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armpolicy.NewAssignmentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
		"EnforceNaming",
		armpolicy.AssignmentUpdate{
			Identity: &armpolicy.Identity{
				Type: to.Ptr(armpolicy.ResourceIdentityTypeSystemAssigned),
			},
			Location: to.Ptr("eastus"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { PolicyClient } = require("@azure/arm-policy");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to  This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 *
 * @summary  This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentity.json
 */
async function updateAPolicyAssignmentWithASystemAssignedIdentity() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2";
  const policyAssignmentName = "EnforceNaming";
  const parameters = {
    identity: { type: "SystemAssigned" },
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const result = await client.policyAssignments.update(scope, policyAssignmentName, parameters);
  console.log(result);
}

updateAPolicyAssignmentWithASystemAssignedIdentity().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Update a policy assignment with a user assigned identity

Sample Request

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2021-06-01

{
  "location": "eastus",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
    }
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.resources.models.Identity;
import com.azure.resourcemanager.resources.models.IdentityUserAssignedIdentitiesValue;
import com.azure.resourcemanager.resources.models.PolicyAssignmentUpdate;
import com.azure.resourcemanager.resources.models.ResourceIdentityType;
import java.util.HashMap;
import java.util.Map;

/** Samples for PolicyAssignments Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json
     */
    /**
     * Sample code: Update a policy assignment with a user assigned identity.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAPolicyAssignmentWithAUserAssignedIdentity(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .policyClient()
            .getPolicyAssignments()
            .updateWithResponse(
                "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
                "EnforceNaming",
                new PolicyAssignmentUpdate()
                    .withLocation("eastus")
                    .withIdentity(
                        new Identity()
                            .withType(ResourceIdentityType.USER_ASSIGNED)
                            .withUserAssignedIdentities(
                                mapOf(
                                    "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity",
                                    new IdentityUserAssignedIdentitiesValue()))),
                Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { PolicyClient } = require("@azure/arm-policy");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to  This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 *
 * @summary  This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json
 */
async function updateAPolicyAssignmentWithAUserAssignedIdentity() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2";
  const policyAssignmentName = "EnforceNaming";
  const parameters = {
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/ae640e6bBa3e42569d622993eecfa6f2/resourceGroups/testResourceGroup/providers/MicrosoftManagedIdentity/userAssignedIdentities/testIdentity":
          {},
      },
    },
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const result = await client.policyAssignments.update(scope, policyAssignmentName, parameters);
  console.log(result);
}

updateAPolicyAssignmentWithAUserAssignedIdentity().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Определения

CloudError	Ответ об ошибке операции политики.
createdByType	Тип удостоверения, создавшего ресурс.
enforcementMode	Режим принудительного применения назначений политики. Возможные значения: Default и DoNotEnforce.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Сообщение об ошибке
Identity	Удостоверение ресурса. Назначения политик поддерживают не более одного удостоверения. Это удостоверение, назначаемое системой, или одно удостоверение, назначаемое пользователем.
NonComplianceMessage	Сообщение, описывающее, почему ресурс не соответствует политике. Это показано в сообщениях об ошибках "запретить" и в результатах, не соответствующих требованиям к ресурсу.
ParameterValuesValue	Значение параметра.
PolicyAssignment	Назначение политики.
PolicyAssignmentUpdate
ResourceIdentityType	Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначаемого системой или пользователем, в ресурс.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentities	Удостоверение пользователя, связанное с политикой. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Ответ об ошибке операции политики.

Name	Type	Description
error	ErrorResponse	Сообщение об ошибке Распространенный ответ об ошибке для всех API-интерфейсов Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также соответствует формату ответа об ошибках OData.)

createdByType

Тип удостоверения, создавшего ресурс.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

Режим принудительного применения назначений политики. Возможные значения: Default и DoNotEnforce.

Name	Type	Description
Default	string	Этот эффект политики применяется при создании или обновлении ресурса.
DoNotEnforce	string	Эффект политики не применяется во время создания или обновления ресурсов.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name	Type	Description
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Сообщение об ошибке

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

Identity

Удостоверение ресурса. Назначения политик поддерживают не более одного удостоверения. Это удостоверение, назначаемое системой, или одно удостоверение, назначаемое пользователем.

Name	Type	Description
principalId	string	Идентификатор субъекта удостоверения ресурса. Это свойство будет предоставлено только для назначенного системой удостоверения.
tenantId	string	Идентификатор клиента удостоверения ресурса. Это свойство будет предоставлено только для назначенного системой удостоверения.
type	ResourceIdentityType	Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначаемого системой или пользователем, в ресурс.
userAssignedIdentities	UserAssignedIdentities	Удостоверение пользователя, связанное с политикой. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Сообщение, описывающее, почему ресурс не соответствует политике. Это показано в сообщениях об ошибках "запретить" и в результатах, не соответствующих требованиям к ресурсу.

Name	Type	Description
message	string	Сообщение, описывающее, почему ресурс не соответствует политике. Это показано в сообщениях об ошибках "запретить" и в результатах, не соответствующих требованиям к ресурсу.
policyDefinitionReferenceId	string	Идентификатор ссылки на определение политики в определении набора политик предназначен для сообщения. Это применимо только в том случае, если назначение политики назначает определение набора политик. Если это сообщение не указано, применяется ко всем политикам, назначенным этим назначением политики.

ParameterValuesValue

Значение параметра.

Name	Type	Description
value	object	Значение параметра.

PolicyAssignment

Назначение политики.

Name	Type	Default Value	Description
id	string		Идентификатор назначения политики.
identity	Identity		Управляемое удостоверение, связанное с назначением политики.
location	string		Расположение назначения политики. Требуется только при использовании управляемого удостоверения.
name	string		Имя назначения политики.
properties.description	string		Это сообщение будет частью ответа в случае нарушения политики.
properties.displayName	string		Отображаемое имя назначения политики.
properties.enforcementMode	enforcementMode	Default	Режим принудительного применения назначений политики. Возможные значения: Default и DoNotEnforce.
properties.metadata	object		Метаданные назначения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар "значение ключа".
properties.nonComplianceMessages	NonComplianceMessage[]		Сообщения, описывающие, почему ресурс не соответствует политике.
properties.notScopes	string[]		Исключенные области политики.
properties.parameters	<string, ParameterValuesValue>		Значения параметров для назначенного правила политики. Ключи — это имена параметров.
properties.policyDefinitionId	string		Идентификатор присваиваемого определения политики или набора политик.
properties.scope	string		Область назначения политики.
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
type	string		Тип назначения политики.

PolicyAssignmentUpdate

Name	Type	Description
identity	Identity	Управляемое удостоверение, связанное с назначением политики.
location	string	Расположение назначения политики. Требуется только при использовании управляемого удостоверения.

ResourceIdentityType

Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначаемого системой или пользователем, в ресурс.

Name	Type	Description
None	string	Указывает, что удостоверение не связано с ресурсом или что существующее удостоверение должно быть удалено.
SystemAssigned	string	Указывает, что назначенное системой удостоверение связано с ресурсом.
UserAssigned	string	Указывает, что назначенное системой удостоверение связано с ресурсом.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Name	Type	Description
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменило ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentities

Удостоверение пользователя, связанное с политикой. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Type	Description