Policy Exemptions - List For Resource Group

Service:

Policy

API Version:

2022-07-01-preview

Lekéri az erőforráscsoportra vonatkozó összes szabályzati kivételt.
Ez a művelet lekéri az adott előfizetés adott erőforráscsoportjával társított szabályzatmentességek listáját, amelyek megfelelnek az adott $filter nem kötelezőnek. A $filter érvényes értékei a következők: "atScope()", "atExactScope()", "excludeExpired()" vagy "policyAssignmentId eq "{value}". Ha $filter nincs megadva, a szűretlen lista tartalmazza az erőforráscsoporthoz társított összes szabályzati kivételt, beleértve azokat is, amelyek közvetlenül vonatkoznak vagy hatóköröket tartalmaznak, valamint az erőforráscsoportban található erőforrásokra.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.
$filter	query		string	A műveletre alkalmazandó szűrő. A $filter érvényes értékei a következők: "atScope()", "atExactScope()", "excludeExpired()" vagy "policyAssignmentId eq "{value}". Ha $filter nincs megadva, nem történik szűrés. Ha $filter nincs megadva, a szűretlen lista tartalmazza a hatókörhöz társított összes szabályzat-kivételt, beleértve a közvetlenül alkalmazandó vagy a hatókörökből származó kivételeket is. Ha $filter=atScope() van megadva, a visszaadott lista csak a hatókörre vonatkozó összes szabályzati kivételt tartalmazza, amely a szűretlen listában található minden, kivéve azokat, amelyek az adott hatókörben található alhatókörökre vonatkoznak. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott hatókörben lévő összes szabályzatkivételt tartalmazza. Ha $filter=excludeExpired() van megadva, a visszaadott lista csak az összes olyan szabályzatkivételt tartalmazza, amely nem járt le, vagy nem állította be a lejárati dátumot. Ha $filter=policyAssignmentId eq '{value}' meg van adva. a visszaadott lista csak a give policyAssignmentId azonosítóhoz társított összes szabályzati kivételt tartalmazza.

Válaszok

Name	Típus	Description
200 OK	PolicyExemptionListResult	OK – A szabályzatok kivételeinek tömbje.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

List policy exemptions that apply to a resource group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions?$filter=atScope()&api-version=2022-07-01-preview

Java

/** Samples for PolicyExemptions ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Authorization/preview/2022-07-01-preview/examples/
     * listPolicyExemptionsForResourceGroup.json
     */
    /**
     * Sample code: List policy exemptions that apply to a resource group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listPolicyExemptionsThatApplyToAResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicyExemptions().listByResourceGroup("TestResourceGroup",
            "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/listPolicyExemptionsForResourceGroup.json
func ExampleExemptionsClient_NewListForResourceGroupPager() {
	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().NewListForResourceGroupPager("TestResourceGroup", &armpolicy.ExemptionsClientListForResourceGroupOptions{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("TestVMSub"),
		// 			Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 			ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyExemptions/TestVMSub"),
		// 			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/DevOrg/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("TestVNetRG"),
		// 				Type: to.Ptr("Microsoft.Authorization/policyExemptions"),
		// 				ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions/TestVNetRG"),
		// 				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/DevOrg/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/DevOrg/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/providers/Microsoft.Authorization/policyExemptions/TestVMSub",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "TestVMSub"
    },
    {
      "properties": {
        "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/DevOrg/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.Authorization/policyExemptions/TestVNetRG",
      "type": "Microsoft.Authorization/policyExemptions",
      "name": "TestVNetRG"
    }
  ]
}

Definíciók

Name	Description
AssignmentScopeValidation	Az a lehetőség, hogy a kivétel ellenőrzése a hozzárendelés hatókörében vagy alatt található-e.
CloudError	Egy szabályzatművelet hibaválasza.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
exemptionCategory	A szabályzatmentességi kategória. Lehetséges értékek: Lemondás és Enyhítve.
PolicyExemption	A szabályzat kivétele.
PolicyExemptionListResult	Szabályzatmentességek listája.
ResourceSelector	Az erőforrás-választó, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.
Selector	A választókifejezés.
SelectorKind	A választó típusa.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AssignmentScopeValidation

Az a lehetőség, hogy a kivétel ellenőrzése a hozzárendelés hatókörében vagy alatt található-e.

Name	Típus	Description
Default	string	Ezzel a beállítással ellenőrizheti, hogy a kivétel a hozzárendelés hatókörében van-e.
DoNotValidate	string	Ez a beállítás megkerüli azt az ellenőrzést, amelynél a kivétel hatóköre a szabályzat-hozzárendelés hatókörében vagy alatt található.

CloudError

Egy szabályzatművelet hibaválasza.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

exemptionCategory

A szabályzatmentességi kategória. Lehetséges értékek: Lemondás és Enyhítve.

Name	Típus	Description
Mitigated	string	Ez a kivételkategória általában azt jelenti, hogy a kockázatcsökkentési műveleteket alkalmazták a hatókörre.
Waiver	string	Ez a kivételkategória általában azt jelenti, hogy a hatókör nem alkalmazható a szabályzatra.

PolicyExemption

A szabályzat kivétele.

Name	Típus	Alapértelmezett érték	Description
id	string		A szabályzatmentesség azonosítója.
name	string		A szabályzat kivételének neve.
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	Az a lehetőség, hogy a kivétel ellenőrzése a hozzárendelés hatókörében vagy alatt található-e.
properties.description	string		A szabályzatmentesség leírása.
properties.displayName	string		A szabályzatkivétel megjelenítendő neve.
properties.exemptionCategory	exemptionCategory		A szabályzatmentességi kategória. Lehetséges értékek: Lemondás és Enyhítve.
properties.expiresOn	string		A szabályzat kivételének lejárati dátuma és időpontja (UTC ISO 8601 formátumban yyyy-MM-ddTHH:mm:ssZ).
properties.metadata	object		A szabályzat kivételének metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye.
properties.policyAssignmentId	string		A mentesített szabályzat-hozzárendelés azonosítója.
properties.policyDefinitionReferenceIds	string[]		A szabályzatdefiníció referencia-azonosítójának listája, ha a társított szabályzat-hozzárendelés egy szabályzatkészlet-definíció hozzárendelése.
properties.resourceSelectors	ResourceSelector[]		Az erőforrás-választó lista, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.
systemData	systemData		Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatokat.
type	string		Az erőforrás típusa (Microsoft.Authorization/policyExemptions).

PolicyExemptionListResult

Szabályzatmentességek listája.

Name	Típus	Description
nextLink	string	A következő találatkészlet lekéréséhez használandó URL-cím.
value	PolicyExemption[]	Szabályzatmentességek tömbje.

ResourceSelector

Az erőforrás-választó, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.

Name	Típus	Description
name	string	Az erőforrás-választó neve.
selectors	Selector[]	A választókifejezések listája.

Selector

A választókifejezés.

Name	Típus	Description
in	string[]	A szűrni kívánt értékek listája.
kind	SelectorKind	A választó típusa.
notIn	string[]	A kiszűrni kívánt értékek listája.

SelectorKind

A választó típusa.

Name	Típus	Description
policyDefinitionReferenceId	string	A szabályzatok szabályzatdefiníció referencia-azonosító alapján történő szűrésére szolgáló választótípus.
resourceLocation	string	A szabályzatok erőforráshely szerinti szűrésére vonatkozó választótípus.
resourceType	string	A szabályzatok erőforrástípus szerinti szűrésére vonatkozó választótípus.
resourceWithoutLocation	string	A választó típusa a szabályzatok hely nélküli erőforrás szerinti szűréséhez.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.