Policy Exemptions - List For Resource

Service:

Policy

API Version:

2022-07-01-preview

Obtém todas as isenções de política que se aplicam a um recurso.
Esta operação obtém a lista de todas as isenções de política associadas ao recurso especificado no grupo de recursos especificado e na subscrição que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atScope()", "atExactScope()", "excludeExpired()" ou "policyAssignmentId eq "{value}". Se $filter não for fornecida, a lista não filtrada inclui todas as isenções de política associadas ao recurso, incluindo as que se aplicam diretamente ou de todos os âmbitos que contêm, bem como quaisquer aplicações aos recursos contidos no recurso. São utilizados três parâmetros e o nome do recurso para identificar um recurso específico. Se o recurso não fizer parte de um recurso principal (o caso mais comum), o caminho do recurso principal não deve ser fornecido (ou fornecido como ''). Por exemplo, uma aplicação Web pode ser especificada como ({resourceProviderNamespace} == "Microsoft.Web", {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Se o recurso fizer parte de um recurso principal, todos os parâmetros devem ser fornecidos. Por exemplo, um nome DNS de máquina virtual pode ser especificado como ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Uma alternativa conveniente para fornecer o espaço de nomes e o nome do tipo separadamente é fornecer ambos no parâmetro {resourceType} formato: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyExemptions?api-version=2022-07-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyExemptions?$filter={$filter}&api-version=2022-07-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
parentResourcePath	path	True	string	O caminho do recurso principal. Utilize a cadeia vazia se não existir nenhuma.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Regex pattern: ^[-\w\._\(\)]+$
resourceName	path	True	string	O nome do recurso.
resourceProviderNamespace	path	True	string	O espaço de nomes do fornecedor de recursos. Por exemplo, o espaço de nomes de uma máquina virtual é Microsoft.Compute (de Microsoft.Compute/virtualMachines)
resourceType	path	True	string	O nome do tipo de recurso. Por exemplo, o nome do tipo de uma aplicação Web é "sites" (a partir de Microsoft.Web/sites).
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para a operação.
$filter	query		string	O filtro a aplicar na operação. Os valores válidos para $filter são: "atScope()", "atExactScope()", "excludeExpired()" ou "policyAssignmentId eq "{value}". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se $filter não for fornecida, a lista não filtrada inclui todas as isenções de política associadas ao âmbito, incluindo as que se aplicam diretamente ou se aplicam a partir da contenção de âmbitos. Se for fornecido $filter=atScope(), a lista devolvida inclui apenas todas as isenções de política que se aplicam ao âmbito, que é tudo na lista não filtrada, exceto as aplicadas a sub-âmbitos contidos no âmbito especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as isenções de política que estejam no âmbito especificado. Se $filter=excludeExpired() for fornecida, a lista devolvida inclui apenas todas as isenções de política que não expiraram ou não definiram a data de expiração. Se $filter=policyAssignmentId eq "{value}" for fornecido. a lista devolvida inclui apenas todas as isenções de política associadas ao give policyAssignmentId.

Respostas

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

List all policy exemptions that apply to a resource

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/domainNames/MyTestComputer.cloudapp.net/providers/Microsoft.Authorization/policyExemptions?api-version=2022-07-01-preview

Java

/** Samples for PolicyExemptions ListForResource. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Authorization/preview/2022-07-01-preview/examples/
     * listPolicyExemptionsForResource.json
     */
    /**
     * Sample code: List all policy exemptions that apply to a resource.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listAllPolicyExemptionsThatApplyToAResource(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicyExemptions().listForResource("TestResourceGroup",
            "Microsoft.Compute", "virtualMachines/MyTestVm", "domainNames", "MyTestComputer.cloudapp.net", null,
            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/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/listPolicyExemptionsForResource.json
func ExampleExemptionsClient_NewListForResourcePager() {
	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)
	}
	pager := clientFactory.NewExemptionsClient().NewListForResourcePager("TestResourceGroup", "Microsoft.Compute", "virtualMachines/MyTestVm", "domainNames", "MyTestComputer.cloudapp.net", &armpolicy.ExemptionsClientListForResourceOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExemptionListResult = armpolicy.ExemptionListResult{
		// 	Value: []*armpolicy.Exemption{
		// 		{
		// 			Name: to.Ptr("DemoExpensiveVMGroup"),
		// 			Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 			ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVMGroup"),
		// 			Properties: &armpolicy.ExemptionProperties{
		// 				Description: to.Ptr("Exempt demo cluster from limit sku"),
		// 				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")},
		// 				},
		// 				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),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("jumpBoxExemption"),
		// 				Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 				ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/providers/Microsoft.Authorization/policyExemptions/jumpBoxExemption"),
		// 				Properties: &armpolicy.ExemptionProperties{
		// 					Description: to.Ptr("Exempt jump box open ports from limit ports policy"),
		// 					DisplayName: to.Ptr("Exempt jump box open ports"),
		// 					ExemptionCategory: to.Ptr(armpolicy.ExemptionCategoryMitigated),
		// 					Metadata: map[string]any{
		// 						"reason": "Need to open RDP port to corp net",
		// 					},
		// 					PolicyAssignmentID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/LimitPorts"),
		// 				},
		// 				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

{
  "value": [
    {
      "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"
        }
      },
      "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/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVMGroup",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "DemoExpensiveVMGroup"
    },
    {
      "properties": {
        "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/LimitPorts",
        "exemptionCategory": "Mitigated",
        "displayName": "Exempt jump box open ports",
        "description": "Exempt jump box open ports from limit ports policy",
        "metadata": {
          "reason": "Need to open RDP port to corp net"
        }
      },
      "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/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/providers/Microsoft.Authorization/policyExemptions/jumpBoxExemption",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "jumpBoxExemption"
    }
  ]
}

Definições

Name	Description
AssignmentScopeValidation	A opção quer valide 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 de política.
PolicyExemptionListResult	Lista de isenções de políticas.
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 a isenção está no âmbito da atribuição ou no âmbito da atribuição.

Name	Tipo	Description
Default	string	Esta opção irá validar 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 da 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 Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros 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ção adicional.

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 de 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 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 (no formato UTC ISO 8601 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 com extremidade aberta 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 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 informações createdBy e modifiedBy.
type	string		O tipo de recurso (Microsoft.Authorization/policyExemptions).

PolicyExemptionListResult

Lista de isenções de políticas.

Name	Tipo	Description
nextLink	string	O URL a utilizar para obter o próximo conjunto de resultados.
value	PolicyExemption[]	Uma matriz de isenções de política.

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 seletor tipo 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 seletor tipo 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.