Policy Exemptions - List For Resource Group

Service:

Policy

API Version:

2022-07-01-preview

リソース グループに適用されるすべてのポリシー除外を取得します。
この操作により、指定したサブスクリプション内の特定のリソース グループに関連付けられた、省略可能な特定の$filterと一致するすべてのポリシー除外の一覧が取得されます。 $filterの有効な値は、'atScope()'、'atExactScope()'、'excludeExpired()'、または 'policyAssignmentId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていない一覧には、リソース グループに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるもの、含まれているスコープから適用されるもの、およびリソース グループ内に含まれるリソースに適用されるものも含まれます。

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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースを含むリソース グループの名前。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	操作に使用する API バージョン。
$filter	query		string	操作に適用するフィルター。 $filterの有効な値は、'atScope()'、'atExactScope()'、'excludeExpired()'、または 'policyAssignmentId eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filterが指定されていない場合、フィルター処理されていない一覧には、スコープに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるものや、含まれているスコープから適用されるものも含まれます。 $filter=atScope() が指定されている場合、返されるリストには、スコープに適用されるすべてのポリシー除外のみが含まれます。これは、指定されたスコープ内に含まれるサブ スコープに適用されるものを除き、フィルター処理されていないリスト内のすべてです。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー除外のみが含まれます。 $filter=excludeExpired() が指定されている場合、返される一覧には、有効期限が切れていないか、有効期限が設定されていないすべてのポリシー除外のみが含まれます。 $filter=policyAssignmentId eq '{value}' が指定されている場合。 返される一覧には、give policyAssignmentId に関連付けられているすべてのポリシー除外のみが含まれます。

応答

名前	型	説明
200 OK	PolicyExemptionListResult	OK - ポリシー除外の配列を返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

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

定義

名前	説明
AssignmentScopeValidation	除外が割り当てスコープにあるか、または下にあるかを検証するオプション。
CloudError	ポリシー操作からのエラー応答。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
exemptionCategory	ポリシー除外カテゴリ。 可能な値は、権利放棄と軽減です。
PolicyExemption	ポリシーの除外。
PolicyExemptionListResult	ポリシー除外の一覧。
ResourceSelector	リソース プロパティでポリシーをフィルター処理するリソース セレクター。
Selector	セレクター式。
SelectorKind	セレクターの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AssignmentScopeValidation

除外が割り当てスコープにあるか、または下にあるかを検証するオプション。

名前	型	説明
Default	string	このオプションを選択すると、適用除外が割り当てスコープまたは割り当てスコープの下にあるか検証されます。
DoNotValidate	string	このオプションは、除外スコープがポリシーの割り当てスコープまたはポリシー割り当てスコープの下にある検証をバイパスします。

CloudError

ポリシー操作からのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

exemptionCategory

ポリシー除外カテゴリ。 可能な値は、権利放棄と軽減です。

名前	型	説明
Mitigated	string	通常、このカテゴリの除外は、軽減アクションがスコープに適用されていることを意味します。
Waiver	string	通常、このカテゴリの除外は、スコープがポリシーに適用されないことを意味します。

PolicyExemption

ポリシーの除外。

名前	型	既定値	説明
id	string		ポリシー除外の ID。
name	string		ポリシー除外の名前。
properties.assignmentScopeValidation	AssignmentScopeValidation	Default	除外が割り当てスコープにあるか、または下にあるかを検証するオプション。
properties.description	string		ポリシー除外の説明。
properties.displayName	string		ポリシー除外の表示名。
properties.exemptionCategory	exemptionCategory		ポリシー除外カテゴリ。 可能な値は、権利放棄と軽減です。
properties.expiresOn	string		ポリシー除外の有効期限の日付と時刻 (UTC ISO 8601 形式 yyyy-MM-ddTHH:mm:ssZ)。
properties.metadata	object		ポリシー除外メタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。
properties.policyAssignmentId	string		除外されるポリシー割り当ての ID。
properties.policyDefinitionReferenceIds	string[]		関連付けられたポリシーの割り当てがポリシー セット定義の割り当てである場合のポリシー定義参照 ID リスト。
properties.resourceSelectors	ResourceSelector[]		リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。
systemData	systemData		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string		リソースの種類 (Microsoft.Authorization/policyExemptions)。

PolicyExemptionListResult

ポリシー除外の一覧。

名前	型	説明
nextLink	string	次の結果セットを取得するために使用する URL。
value	PolicyExemption[]	ポリシー除外の配列。

ResourceSelector

リソース プロパティでポリシーをフィルター処理するリソース セレクター。

名前	型	説明
name	string	リソース セレクターの名前。
selectors	Selector[]	セレクター式の一覧。

Selector

セレクター式。

名前	型	説明
in	string[]	フィルター処理する値の一覧。
kind	SelectorKind	セレクターの種類。
notIn	string[]	除外する値の一覧。

SelectorKind

セレクターの種類。

名前	型	説明
policyDefinitionReferenceId	string	ポリシー定義参照 ID でポリシーをフィルター処理するセレクターの種類。
resourceLocation	string	リソースの場所でポリシーをフィルター処理するセレクターの種類。
resourceType	string	リソースの種類でポリシーをフィルター処理するセレクターの種類。
resourceWithoutLocation	string	場所のないリソースでポリシーをフィルター処理するセレクターの種類。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。