Policy Exemptions - Update

Service:

Policy

API Version:

2022-07-01-preview

Esta operação atualiza uma isenção de política com o âmbito e o nome especificados.

PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}?api-version=2022-07-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
policyExemptionName	path	True	string	O nome da isenção de política a eliminar.
scope	path	True	string	O âmbito da isenção de política. Os âmbitos 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 recurso (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	A versão da API a utilizar para a operação.

Corpo do Pedido

Name	Tipo	Description
properties.assignmentScopeValidation	AssignmentScopeValidation	A opção quer valide se a isenção está no âmbito da atribuição ou no âmbito da atribuição.
properties.resourceSelectors	ResourceSelector[]	A lista de seletores de recursos para filtrar políticas por propriedades de recursos.

Respostas

Name	Tipo	Description
200 OK	PolicyExemption	OK - Devolve informações sobre a isenção de política.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo 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

Update a policy exemption with resource selectors

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM?api-version=2022-07-01-preview

{
  "properties": {
    "assignmentScopeValidation": "Default",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  }
}

Java

import com.azure.resourcemanager.resources.models.AssignmentScopeValidation;
import com.azure.resourcemanager.resources.models.PolicyExemptionUpdate;
import com.azure.resourcemanager.resources.models.ResourceSelector;
import com.azure.resourcemanager.resources.models.Selector;
import com.azure.resourcemanager.resources.models.SelectorKind;
import java.util.Arrays;

/** Samples for PolicyExemptions Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Authorization/preview/2022-07-01-preview/examples/
     * updatePolicyExemptionWithResourceSelectors.json
     */
    /**
     * Sample code: Update a policy exemption with resource selectors.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAPolicyExemptionWithResourceSelectors(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicyExemptions().updateWithResponse(
            "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster", "DemoExpensiveVM",
            new PolicyExemptionUpdate()
                .withResourceSelectors(Arrays.asList(new ResourceSelector().withName("SDPRegions")
                    .withSelectors(Arrays.asList(new Selector().withKind(SelectorKind.RESOURCE_LOCATION)
                        .withIn(Arrays.asList("eastus2euap", "centraluseuap"))))))
                .withAssignmentScopeValidation(AssignmentScopeValidation.DEFAULT),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

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/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/resources/resource-manager/Microsoft.Authorization/preview/2022-07-01-preview/examples/updatePolicyExemptionWithResourceSelectors.json
func ExampleExemptionsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicy.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExemptionsClient().Update(ctx, "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster", "DemoExpensiveVM", armpolicy.ExemptionUpdate{
		Properties: &armpolicy.ExemptionUpdateProperties{
			AssignmentScopeValidation: to.Ptr(armpolicy.AssignmentScopeValidationDefault),
			ResourceSelectors: []*armpolicy.ResourceSelector{
				{
					Name: to.Ptr("SDPRegions"),
					Selectors: []*armpolicy.Selector{
						{
							In: []*string{
								to.Ptr("eastus2euap"),
								to.Ptr("centraluseuap")},
							Kind: to.Ptr(armpolicy.SelectorKindResourceLocation),
						}},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Exemption = armpolicy.Exemption{
	// 	Name: to.Ptr("DemoExpensiveVM"),
	// 	Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
	// 	ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM"),
	// 	Properties: &armpolicy.ExemptionProperties{
	// 		Description: to.Ptr("Exempt demo cluster from limit sku"),
	// 		AssignmentScopeValidation: to.Ptr(armpolicy.AssignmentScopeValidationDefault),
	// 		DisplayName: to.Ptr("Exempt demo cluster"),
	// 		ExemptionCategory: to.Ptr(armpolicy.ExemptionCategoryWaiver),
	// 		Metadata: map[string]any{
	// 			"reason": "Temporary exemption for a expensive VM demo",
	// 		},
	// 		PolicyAssignmentID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement"),
	// 		PolicyDefinitionReferenceIDs: []*string{
	// 			to.Ptr("Limit_Skus")},
	// 			ResourceSelectors: []*armpolicy.ResourceSelector{
	// 				{
	// 					Name: to.Ptr("SDPRegions"),
	// 					Selectors: []*armpolicy.Selector{
	// 						{
	// 							In: []*string{
	// 								to.Ptr("eastus2euap"),
	// 								to.Ptr("centraluseuap")},
	// 								Kind: to.Ptr(armpolicy.SelectorKindResourceLocation),
	// 						}},
	// 				}},
	// 			},
	// 			SystemData: &armpolicy.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-01T01:01:01.107Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armpolicy.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-01T02:01:01.107Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armpolicy.CreatedByTypeUser),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    },
    "assignmentScopeValidation": "Default",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM",
  "type": "Microsoft.Authorization/policyExemptions",
  "name": "DemoExpensiveVM"
}

Definições

Name	Description
AssignmentScopeValidation	A opção quer valide se a isenção está no âmbito da atribuição ou no âmbito da atribuição.
CloudError	Uma resposta de erro de uma operação de política.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
exemptionCategory	A categoria de isenção de política. Os valores possíveis são Renúncia e Mitigação.
PolicyExemption	A isenção da política.
PolicyExemptionUpdate	A isenção de política para o pedido de Patch.
ResourceSelector	O seletor de recursos para filtrar políticas por propriedades de recursos.
Selector	A expressão do seletor.
SelectorKind	O tipo de seletor.
systemData	Metadados relativos à criação e última modificação do recurso.

AssignmentScopeValidation

A opção quer valide se a isenção está no âmbito da atribuição ou no âmbito da atribuição.

Name	Tipo	Description
Default	string	Esta opção valida se a isenção está no âmbito da atribuição ou no âmbito da atribuição.
DoNotValidate	string	Esta opção irá ignorar a validação em que o âmbito de isenção está no âmbito de atribuição de políticas ou no âmbito da atribuição de políticas.

CloudError

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

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

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ções adicionais.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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.

exemptionCategory

A categoria de isenção de política. Os valores possíveis são Renúncia e Mitigação.

Name	Tipo	Description
Mitigated	string	Normalmente, esta categoria de isenções significa que as ações de mitigação foram aplicadas ao âmbito.
Waiver	string	Normalmente, esta categoria de isenções significa que o âmbito não é aplicável à política.

PolicyExemption

A isenção da política.

Name	Tipo	Valor Predefinido	Description
id	string		O ID da isenção de política.
name	string		O nome da isenção de política.
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	A opção quer valide se a isenção está no âmbito da atribuição ou no âmbito da atribuição.
properties.description	string		A descrição da isenção de política.
properties.displayName	string		O nome a apresentar da isenção de política.
properties.exemptionCategory	exemptionCategory		A categoria de isenção de política. Os valores possíveis são Renúncia e Mitigação.
properties.expiresOn	string		A data e hora de expiração (em UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) da isenção da política.
properties.metadata	object		Os metadados de isenção de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave.
properties.policyAssignmentId	string		O ID da atribuição de política que está a ser isenta.
properties.policyDefinitionReferenceIds	string[]		A lista de ID de referência da definição de política quando a atribuição de política associada é uma atribuição de uma definição de conjunto de políticas.
properties.resourceSelectors	ResourceSelector[]		A lista de seletores de recursos para filtrar políticas por propriedades de recursos.
systemData	systemData		O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type	string		O tipo de recurso (Microsoft.Authorization/policyExemptions).

PolicyExemptionUpdate

A isenção de política para o pedido de Patch.

Name	Tipo	Valor Predefinido	Description
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	A opção quer valide se a isenção está no âmbito da atribuição ou no âmbito da atribuição.
properties.resourceSelectors	ResourceSelector[]		A lista de seletores de recursos para filtrar políticas por propriedades de recursos.

ResourceSelector

O seletor de recursos para filtrar políticas por propriedades de recursos.

Name	Tipo	Description
name	string	O nome do seletor de recursos.
selectors	Selector[]	A lista das expressões do seletor.

Selector

A expressão do seletor.

Name	Tipo	Description
in	string[]	A lista de valores a filtrar.
kind	SelectorKind	O tipo de seletor.
notIn	string[]	A lista de valores a filtrar.

SelectorKind

O tipo de seletor.

Name	Tipo	Description
policyDefinitionReferenceId	string	O tipo de seletor para filtrar políticas pelo ID de referência da definição de política.
resourceLocation	string	O tipo de seletor para filtrar políticas pela localização do recurso.
resourceType	string	O tipo de seletor para filtrar políticas pelo tipo de recurso.
resourceWithoutLocation	string	O tipo de seletor para filtrar políticas pelo recurso sem localização.

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	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	createdByType	O tipo de identidade que modificou o recurso pela última vez.