Policy Assignments - Update By Id

Ссылка

Service:: Policy

API Version:: 2021-06-01

Обновляет назначение политики.
Эта операция обновляет назначение политики с заданным идентификатором. Назначения политик, сделанные в области, применяются ко всем ресурсам, содержащимся в этой области. Например, при назначении политики группе ресурсов, которая применяется ко всем ресурсам в группе. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат "/providers/Microsoft.Management/managementGroups/{managementGroup}"), подписка (формат "/subscriptions/{subscriptionId}"), группа ресурсов (формат "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PATCH https://management.azure.com/{policyAssignmentId}?api-version=2021-06-01

Параметры URI

Name	In	Required	Type	Description
policyAssignmentId	path	True	string	Идентификатор обновляемого назначения политики. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
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

Azure Active Directory OAuth2 Flow

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

Scopes

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

Примеры

Update policy assignment with a managed identity by ID

Sample Request

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

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

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;

/** Samples for PolicyAssignments UpdateById. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentityById.json
     */
    /**
     * Sample code: Update policy assignment with a managed identity by ID.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatePolicyAssignmentWithAManagedIdentityByID(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .policyClient()
            .getPolicyAssignments()
            .updateByIdWithResponse(
                "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
                new PolicyAssignmentUpdate()
                    .withLocation("eastus")
                    .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED)),
                Context.NONE);
    }
}

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

// x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentityById.json
func ExamplePolicyAssignmentsClient_UpdateByID() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpolicy.NewPolicyAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateByID(ctx,
		"<policy-assignment-id>",
		armpolicy.PolicyAssignmentUpdate{
			Identity: &armpolicy.Identity{
				Type: armpolicy.ResourceIdentityTypeSystemAssigned.ToPtr(),
			},
			Location: to.StringPtr("<location>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PolicyAssignment.ID: %s\n", *res.ID)
}

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 the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
 *
 * @summary This operation updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/examples/updatePolicyAssignmentWithIdentityById.json
 */
async function updatePolicyAssignmentWithAManagedIdentityById() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const policyAssignmentId =
    "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage";
  const parameters = {
    identity: { type: "SystemAssigned" },
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const result = await client.policyAssignments.updateById(policyAssignmentId, parameters);
  console.log(result);
}

updatePolicyAssignmentWithAManagedIdentityById().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 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",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "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"
}

Определения

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