Policy Exemptions - List For Resource

Service:

Policy

API Version:

2022-07-01-preview

Lekéri az erőforrásokra vonatkozó összes szabályzatmentességet.
Ez a művelet lekéri az adott erőforráscsoportban és előfizetésben lévő, az opcionális $filter megfelelő erőforráshoz társított összes szabályzatmentesség listáját. 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áshoz társított összes házirend-kivételt, beleértve a közvetlenül vagy az összes hatókörre vonatkozó kivételt, valamint az erőforrásban található erőforrásokra alkalmazott összes kivételt. A rendszer három paramétert és az erőforrás nevét használja egy adott erőforrás azonosításához. Ha az erőforrás nem része a szülőerőforrásnak (ez a gyakoribb eset), a szülőerőforrás elérési útját nem szabad megadni (vagy "" néven megadni). Egy webalkalmazás például megadható a következőként: ({resourceProviderNamespace} == "Microsoft.Web", {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Ha az erőforrás egy szülőerőforrás része, akkor minden paramétert meg kell adni. Megadható például egy virtuális gép DNS-neve a következőként: ({resourceProviderNamespace} == "Microsoft.Compute", {parentResourcePath} == "virtualMachines/MyVirtualMachine", {resourceType} == "domainNames", {resourceName} == 'MyComputerName'). A névtér és a típusnév külön-külön történő megadásának kényelmes alternatíva a {resourceType} paraméter formátumának megadása: ({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

URI-paraméterek

Name	In	Kötelező	Típus	Description
parentResourcePath	path	True	string	A szülőerőforrás elérési útja. Üres sztring használata, ha nincs.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Regex pattern: ^[-\w\._\(\)]+$
resourceName	path	True	string	Az erőforrás neve.
resourceProviderNamespace	path	True	string	Az erőforrás-szolgáltató névtere. Egy virtuális gép névtere például a Microsoft.Compute (Microsoft.Compute/virtualMachines)
resourceType	path	True	string	Az erőforrástípus neve. Egy webalkalmazás típusneve például "webhelyek" (a Microsoft.Web/sites webhelyről).
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használni kívánt 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, a szűrés nem történik meg. Ha $filter nincs megadva, a szűretlen lista tartalmazza a hatókörhöz társított összes szabályzatmentességet, beleértve a hatókörökből közvetlenül alkalmazandókat is. Ha $filter=atScope() van megadva, a visszaadott lista csak a hatókörre vonatkozó összes házirend-kivételt tartalmazza, ami a szűretlen listában található minden, kivéve azokat, amelyek az adott hatókörben található alható ható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 vagy még 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 az összes szabályzatmentességet tartalmazza, amely a give policyAssignmentId azonosítóhoz van társítva.

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

Definíciók

Name	Description
AssignmentScopeValidation	Az a lehetőség, hogy a kivétel érvényesítése a hozzárendelés hatókörében vagy alatt van-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ályzat kivételének kategóriája. A lehetséges értékek a Mentesség és a 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 érvényesítése a hozzárendelés hatókörében vagy alatt van-e.

Name	Típus	Description
Default	string	Ez a beállítás ellenőrzi, 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 van vagy alatta van.

CloudError

Egy szabályzatművelet hibaválasza.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen 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 információtí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 hibacél.

exemptionCategory

A szabályzat kivételének kategóriája. A lehetséges értékek a Mentesség és a 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 érvényesítése a hozzárendelés hatókörében vagy alatt van-e.
properties.description	string		A szabályzatmentesség leírása.
properties.displayName	string		A szabályzat kivételének megjelenítendő neve.
properties.exemptionCategory	exemptionCategory		A szabályzat kivételének kategóriája. A lehetséges értékek a Mentesség és a 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ó referenciaazonosítóinak 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ó metaadatok.
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álatok 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 szűrni kívánt értékek listája.

SelectorKind

A választó típusa.

Name	Típus	Description
policyDefinitionReferenceId	string	A szabályzatokat a szabályzatdefiníció referencia-azonosítója alapján szűrni kívánt választótípus.
resourceLocation	string	A választó típusa, amely az erőforrás helye alapján szűri a szabályzatokat.
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, amely hely nélkül szűri a szabályzatokat az erőforrás alapján.

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 az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.