Policy Exemptions - List For Management Group

Service:

Policy

API Version:

2022-07-01-preview

Ruft alle Richtlinienausnahmen ab, die für eine Verwaltungsgruppe gelten.
Dieser Vorgang ruft die Liste aller Richtlinienausnahmen ab, die für die Verwaltungsgruppe gelten und den angegebenen $filter entsprechen. Gültige Werte für $filter sind: "atScope()", "atExactScope()", "excludeExpired()" oder "policyAssignmentId eq "{value}". Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste alle Richtlinienausnahmen, die der Verwaltungsgruppe oder den Vorgängern der Verwaltungsgruppe zugewiesen sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
managementGroupId	path	True	string	Die ID der Verwaltungsgruppe.
api-version	query	True	string	Die API-Version, die für den Vorgang verwendet werden soll.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll. Gültige Werte für $filter sind: "atScope()", "atExactScope()", "excludeExpired()" oder "policyAssignmentId eq "{value}". Wenn $filter nicht bereitgestellt wird, wird keine Filterung durchgeführt. Wenn $filter nicht bereitgestellt wird, enthält die ungefilterte Liste alle Richtlinienausnahmen, die dem Bereich zugeordnet sind, einschließlich derjenigen, die direkt gelten oder aus bereichen enthalten. Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienausnahmen, die für den Bereich gelten, d. h. alles in der ungefilterten Liste mit Ausnahme derjenigen, die auf Teilbereiche angewendet werden, die innerhalb des angegebenen Bereichs enthalten sind. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienausnahmen, die sich im angegebenen Bereich befinden. Wenn $filter=excludeExpired() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienausnahmen, die entweder nicht abgelaufen sind oder kein Ablaufdatum festgelegt haben. Wenn $filter=policyAssignmentId eq '{value}' angegeben wird. Die zurückgegebene Liste enthält nur alle Richtlinienausnahmen, die der give policyAssignmentId zugeordnet sind.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyExemptionListResult	OK: Gibt ein Array von Richtlinienausnahmen zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
    }
  ]
}

Definitionen

Name	Beschreibung
AssignmentScopeValidation	Die Option, ob überprüft wird, ob die Ausnahme im Zuweisungsbereich oder unter dem Zuweisungsbereich liegt.
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
exemptionCategory	Die Richtlinienausnahmekategorie. Mögliche Werte sind Waiver und Entschärft.
PolicyExemption	Die Richtlinienausnahme.
PolicyExemptionListResult	Liste der Richtlinienausnahmen.
ResourceSelector	Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.
Selector	Der Selektorausdruck.
SelectorKind	Die Selektorart.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AssignmentScopeValidation

Die Option, ob überprüft wird, ob die Ausnahme im Zuweisungsbereich oder unter dem Zuweisungsbereich liegt.

Name	Typ	Beschreibung
Default	string	Mit dieser Option wird überprüft, ob die Ausnahme im Zuweisungsbereich oder unter dem Zuweisungsbereich liegt.
DoNotValidate	string	Diese Option umgeht die Überprüfung, für die sich der Ausnahmebereich im Richtlinienzuweisungsbereich befindet.

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

exemptionCategory

Die Richtlinienausnahmekategorie. Mögliche Werte sind Waiver und Entschärft.

Name	Typ	Beschreibung
Mitigated	string	Diese Kategorie von Ausnahmen bedeutet in der Regel, dass die Maßnahmen zur Entschärfung auf den Bereich angewendet wurden.
Waiver	string	Diese Kategorie von Ausnahmen bedeutet in der Regel, dass der Bereich für die Richtlinie nicht gilt.

PolicyExemption

Die Richtlinienausnahme.

Name	Typ	Standardwert	Beschreibung
id	string		Die ID der Richtlinienausnahme.
name	string		Der Name der Richtlinienausnahme.
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	Die Option, ob überprüft wird, ob die Ausnahme im Zuweisungsbereich oder unter dem Zuweisungsbereich liegt.
properties.description	string		Die Beschreibung der Richtlinienausnahme.
properties.displayName	string		Der Anzeigename der Richtlinienausnahme.
properties.exemptionCategory	exemptionCategory		Die Richtlinienausnahmekategorie. Mögliche Werte sind Waiver und Entschärft.
properties.expiresOn	string		Das Ablaufdatum und die Uhrzeit (im UTC ISO 8601-Format yyyy-MM-ddTHH:mm:ssZ) der Richtlinienausnahme.
properties.metadata	object		Die Richtlinienausnahmemetadaten. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.policyAssignmentId	string		Die ID der Richtlinienzuweisung, die ausgenommen wird.
properties.policyDefinitionReferenceIds	string[]		Die Referenz-ID-Liste der Richtliniendefinition, wenn die zugeordnete Richtlinienzuweisung eine Zuweisung einer Richtliniensatzdefinition ist.
properties.resourceSelectors	ResourceSelector[]		Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften.
systemData	systemData		Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string		Der Typ der Ressource (Microsoft.Authorization/policyExemptions).

PolicyExemptionListResult

Liste der Richtlinienausnahmen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	PolicyExemption[]	Ein Array von Richtlinienausnahmen.

ResourceSelector

Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.

Name	Typ	Beschreibung
name	string	Der Name der Ressourcenauswahl.
selectors	Selector[]	Die Liste der Selektorausdrücke.

Selector

Der Selektorausdruck.

Name	Typ	Beschreibung
in	string[]	Die Liste der zu filternden Werte.
kind	SelectorKind	Die Selektorart.
notIn	string[]	Die Liste der zu filternden Werte.

SelectorKind

Die Selektorart.

Name	Typ	Beschreibung
policyDefinitionReferenceId	string	Die Selektorart zum Filtern von Richtlinien nach der Referenz-ID der Richtliniendefinition.
resourceLocation	string	Die Selektorart zum Filtern von Richtlinien nach dem Ressourcenspeicherort.
resourceType	string	Die Selektorart zum Filtern von Richtlinien nach dem Ressourcentyp.
resourceWithoutLocation	string	Die Selektorart zum Filtern von Richtlinien nach der Ressource ohne Speicherort.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.