Policy Exemptions - List For Management Group

Service:

Policy

API Version:

2022-07-01-preview

Recupera todas las exenciones de directiva que se aplican a un grupo de administración.
Esta operación recupera la lista de todas las exenciones de directiva aplicables al grupo de administración que coinciden con el $filter especificado. Los valores válidos para $filter son: 'atScope()', 'atExactScope()', 'excludeExpired()' o 'policyAssignmentId eq '{value}'. Si se proporciona $filter=atScope(), la lista devuelta incluye todas las exenciones de directiva asignadas al grupo de administración o a los antecesores del grupo de administración.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyExemptions?api-version=2022-07-01-preview

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyExemptions?$filter={$filter}&api-version=2022-07-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
managementGroupId	path	True	string	Identificador del grupo de administración.
api-version	query	True	string	La versión de API que se va a usar para la operación.
$filter	query		string	Filtro que se va a aplicar en la operación. Los valores válidos para $filter son: 'atScope()', 'atExactScope()', 'excludeExpired()' o 'policyAssignmentId eq '{value}'. Si no se proporciona $filter, no se realiza ningún filtrado. Si no se proporciona $filter, la lista sin filtrar incluye todas las exenciones de directiva asociadas al ámbito, incluidas las que se aplican directamente o se aplican desde ámbitos contenedoras. Si se proporciona $filter=atScope(), la lista devuelta solo incluye todas las exenciones de directiva que se aplican al ámbito, que es todo lo que hay en la lista sin filtrar, excepto las que se aplican a los sub ámbitos contenidos en el ámbito especificado. Si se proporciona $filter=atExactScope(), la lista devuelta solo incluye todas las exenciones de directiva que se incluyen en el ámbito especificado. Si se proporciona $filter=excludeExpired(), la lista devuelta solo incluye todas las exenciones de directiva que no han expirado o no han establecido la fecha de expiración. Si se proporciona $filter=policyAssignmentId eq '{value}'. la lista devuelta solo incluye todas las exenciones de directiva asociadas con el valor de give policyAssignmentId.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyExemptionListResult	Ok: devuelve una matriz de exenciones de directiva.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List policy exemptions that apply to a management group

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions?$filter=atScope()&api-version=2022-07-01-preview

Java

/** Samples for PolicyExemptions ListForManagementGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Authorization/preview/2022-07-01-preview/examples/
     * listPolicyExemptionsForManagementGroup.json
     */
    /**
     * Sample code: List policy exemptions that apply to a management group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listPolicyExemptionsThatApplyToAManagementGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicyExemptions().listForManagementGroup("DevOrg",
            "atScope()", 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/listPolicyExemptionsForManagementGroup.json
func ExampleExemptionsClient_NewListForManagementGroupPager() {
	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().NewListForManagementGroupPager("DevOrg", &armpolicy.ExemptionsClientListForManagementGroupOptions{Filter: to.Ptr("atScope()")})
	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("ResearchBudgetExemption"),
		// 			Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/ResearchBudgetExemption"),
		// 			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("/providers/Microsoft.Management/managementGroups/HardwareDivision/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("VNetIsMonitored"),
		// 				Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 				ID: to.Ptr("/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/VNetIsMonitored"),
		// 				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("/providers/Microsoft.Management/managementGroups/HardwareDivision/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": "/providers/Microsoft.Management/managementGroups/HardwareDivision/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": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/ResearchBudgetExemption",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "ResearchBudgetExemption"
    },
    {
      "properties": {
        "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/HardwareDivision/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": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/VNetIsMonitored",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "VNetIsMonitored"
    }
  ]
}

Definiciones

Nombre	Description
AssignmentScopeValidation	Opción si valida que la exención esté en el ámbito de asignación o en el ámbito de asignación.
CloudError	Respuesta de error de una operación de directiva.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
exemptionCategory	Categoría de exención de directiva. Los valores posibles son Renuncia y Mitigado.
PolicyExemption	Exención de directiva.
PolicyExemptionListResult	Lista de exenciones de directiva.
ResourceSelector	Selector de recursos para filtrar las directivas por propiedades de recursos.
Selector	Expresión del selector.
SelectorKind	Tipo de selector.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

AssignmentScopeValidation

Opción si valida que la exención esté en el ámbito de asignación o en el ámbito de asignación.

Nombre	Tipo	Description
Default	string	Esta opción validará que la exención está en o en el ámbito de asignación.
DoNotValidate	string	Esta opción omitirá la validación en que el ámbito de exención está en el ámbito de asignación de directiva o en el ámbito de asignación de directivas.

CloudError

Respuesta de error de una operación de directiva.

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

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

Respuesta de error

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

exemptionCategory

Categoría de exención de directiva. Los valores posibles son Renuncia y Mitigado.

Nombre	Tipo	Description
Mitigated	string	Esta categoría de exenciones normalmente significa que las acciones de mitigación se han aplicado al ámbito.
Waiver	string	Esta categoría de exenciones normalmente significa que el ámbito no es aplicable a la directiva.

PolicyExemption

Exención de directiva.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de la exención de directiva.
name	string		Nombre de la exención de directiva.
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	Opción si valida que la exención esté en el ámbito de asignación o en el ámbito de asignación.
properties.description	string		Descripción de la exención de directiva.
properties.displayName	string		Nombre para mostrar de la exención de directiva.
properties.exemptionCategory	exemptionCategory		Categoría de exención de directiva. Los valores posibles son Renuncia y Mitigado.
properties.expiresOn	string		Fecha y hora de expiración (en formato ISO 8601 UTC aaaa-MM-ddTHH:mm:ssZ) de la exención de directiva.
properties.metadata	object		Metadatos de exención de directiva. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor.
properties.policyAssignmentId	string		Identificador de la asignación de directiva que se está eximiendo.
properties.policyDefinitionReferenceIds	string[]		La lista de identificadores de referencia de definición de directiva cuando la asignación de directiva asociada es una asignación de una definición de conjunto de directivas.
properties.resourceSelectors	ResourceSelector[]		Lista del selector de recursos para filtrar las directivas por propiedades de recursos.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string		Tipo del recurso (Microsoft.Authorization/policyExemptions).

PolicyExemptionListResult

Lista de exenciones de directiva.

Nombre	Tipo	Description
nextLink	string	Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value	PolicyExemption[]	Matriz de exenciones de directiva.

ResourceSelector

Selector de recursos para filtrar las directivas por propiedades de recursos.

Nombre	Tipo	Description
name	string	Nombre del selector de recursos.
selectors	Selector[]	Lista de las expresiones del selector.

Selector

Expresión del selector.

Nombre	Tipo	Description
in	string[]	Lista de valores en los que se va a filtrar.
kind	SelectorKind	Tipo de selector.
notIn	string[]	Lista de valores que se van a filtrar.

SelectorKind

Tipo de selector.

Nombre	Tipo	Description
policyDefinitionReferenceId	string	Tipo de selector para filtrar las directivas por el identificador de referencia de definición de directiva.
resourceLocation	string	Tipo de selector para filtrar las directivas por la ubicación del recurso.
resourceType	string	Tipo de selector para filtrar las directivas por el tipo de recurso.
resourceWithoutLocation	string	Tipo de selector para filtrar las directivas por el recurso sin ubicación.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.