Policy Set Definition Versions - List

サービス:

Policy

API バージョン:

2023-04-01

サブスクリプション内の特定のポリシー セット定義のポリシー セット定義バージョンを取得します。
この操作は、指定されたポリシー セット定義のすべてのポリシー セット定義バージョンの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions?api-version=2023-04-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions?api-version=2023-04-01&$expand={$expand}&$top={$top}

URI パラメーター

名前	/	必須	型	説明
policySetDefinitionName	path	True	string pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$	ポリシー セット定義の名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$expand	query		string	応答に含める追加プロパティのコンマ区切りの一覧。 サポートされている値は 'LatestDefinitionVersion, EffectiveDefinitionVersion' です。
$top	query		integer (int32) minimum: 1 maximum: 1000	返されるレコードの最大数。 $top フィルターが指定されていない場合、500 レコードが返されます。

応答

名前	型	説明
200 OK	PolicySetDefinitionVersionListResult	OK - ポリシー セット定義バージョンの配列を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

List policy set definitions

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions?api-version=2023-04-01

Java

/**
 * Samples for PolicySetDefinitionVersions List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/
     * listPolicySetDefinitionVersions.json
     */
    /**
     * Sample code: List policy set definitions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPolicySetDefinitions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicySetDefinitionVersions().list("CostManagement", null,
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.policy import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_policy_set_definition_versions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_set_definition_versions.list(
        policy_set_definition_name="CostManagement",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json
if __name__ == "__main__":
    main()

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/219b2e3ef270f18149774eb2793b48baacde982f/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json
func ExampleSetDefinitionVersionsClient_NewListPager() {
	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.NewSetDefinitionVersionsClient().NewListPager("CostManagement", &armpolicy.SetDefinitionVersionsClientListOptions{Expand: nil,
		Top: 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.SetDefinitionVersionListResult = armpolicy.SetDefinitionVersionListResult{
		// 	Value: []*armpolicy.SetDefinitionVersion{
		// 		{
		// 			Name: to.Ptr("1.2.1"),
		// 			Type: to.Ptr("Microsoft.Authorization/policySetDefinitions/versions"),
		// 			ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1"),
		// 			Properties: &armpolicy.SetDefinitionVersionProperties{
		// 				Description: to.Ptr("Policies to enforce low cost storage SKUs"),
		// 				DisplayName: to.Ptr("Cost Management"),
		// 				Metadata: map[string]any{
		// 					"category": "Cost Management",
		// 				},
		// 				PolicyDefinitions: []*armpolicy.DefinitionReference{
		// 					{
		// 						DefinitionVersion: to.Ptr("1.*.*"),
		// 						Parameters: map[string]*armpolicy.ParameterValuesValue{
		// 							"listOfAllowedSKUs": &armpolicy.ParameterValuesValue{
		// 								Value: []any{
		// 									"Standard_GRS",
		// 									"Standard_LRS",
		// 								},
		// 							},
		// 						},
		// 						PolicyDefinitionID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
		// 						PolicyDefinitionReferenceID: to.Ptr("Limit_Skus"),
		// 					},
		// 					{
		// 						DefinitionVersion: to.Ptr("1.*.*"),
		// 						Parameters: map[string]*armpolicy.ParameterValuesValue{
		// 							"prefix": &armpolicy.ParameterValuesValue{
		// 								Value: "DeptA",
		// 							},
		// 							"suffix": &armpolicy.ParameterValuesValue{
		// 								Value: "-LC",
		// 							},
		// 						},
		// 						PolicyDefinitionID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
		// 						PolicyDefinitionReferenceID: to.Ptr("Resource_Naming"),
		// 				}},
		// 				Version: to.Ptr("1.2.1"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyClient } = require("@azure/arm-policy");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to This operation retrieves a list of all the policy set definition versions for the given policy set definition.
 *
 * @summary This operation retrieves a list of all the policy set definition versions for the given policy set definition.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json
 */
async function listPolicySetDefinitions() {
  const subscriptionId =
    process.env["POLICY_SUBSCRIPTION_ID"] || "ae640e6b-ba3e-4256-9d62-2993eecfa6f2";
  const policySetDefinitionName = "CostManagement";
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.policySetDefinitionVersions.list(policySetDefinitionName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
      "type": "Microsoft.Authorization/policySetDefinitions/versions",
      "name": "1.2.1",
      "properties": {
        "displayName": "Cost Management",
        "description": "Policies to enforce low cost storage SKUs",
        "metadata": {
          "category": "Cost Management"
        },
        "version": "1.2.1",
        "policyDefinitions": [
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

定義

名前	説明
CloudError	ポリシー操作からのエラー応答。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
Metadata	パラメーターの一般的なメタデータ。
ParameterDefinitionsValue	ポリシーに指定できるパラメーターの定義。
parameterType	パラメーターのデータ型。
ParameterValuesValue	パラメーターの値。
PolicyDefinitionGroup	ポリシー定義グループ。
PolicyDefinitionReference	ポリシー定義のリファレンス。
PolicySetDefinitionVersion	ポリシー セット定義のバージョン。
PolicySetDefinitionVersionListResult	ポリシー セット定義のバージョンの一覧。
policyType	ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

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

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

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

エラー応答

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

Metadata

Object

パラメーターの一般的なメタデータ。

名前	型	説明
assignPermissions	boolean	ポリシーの割り当て中に Azure portal でこのパラメーターのリソース ID またはリソース スコープ値にロールの割り当てを作成するには、true に設定します。 このプロパティは、割り当てスコープ外でアクセス許可を割り当てる場合に便利です。
description	string	パラメーターの説明。
displayName	string	パラメーターの表示名。
strongType	string	ポータルを使用してポリシー定義を割り当てるときに使用されます。 ユーザーが選択する値のコンテキスト対応リストを提供します。

ParameterDefinitionsValue

Object

ポリシーに指定できるパラメーターの定義。

名前	型	説明
allowedValues	object[]	パラメーターに使用できる値。
defaultValue	object	値が指定されていない場合のパラメーターの既定値。
metadata	Metadata	パラメーターの一般的なメタデータ。
schema	object	自己定義 JSON スキーマを使用した割り当て時のパラメーター入力の検証を提供します。 このプロパティは、オブジェクト型パラメーターでのみサポートされ、Json.NET Schema 2019-09 の実装に従います。 スキーマの使用の詳細については、「https://json-schema.org/」を参照し、https://www.jsonschemavalidator.net/で下書きスキーマをテストします。
type	parameterType	パラメーターのデータ型。

parameterType

列挙

パラメーターのデータ型。

値	説明
String
Array
Object
Boolean
Integer
Float
DateTime

ParameterValuesValue

Object

パラメーターの値。

名前	型	説明
value	object	パラメーターの値。

PolicyDefinitionGroup

Object

ポリシー定義グループ。

名前	型	説明
additionalMetadataId	string	グループに関する追加のメタデータを含むリソースのリソース ID。
category	string	グループのカテゴリ。
description	string	グループの説明。
displayName	string	グループの表示名。
name	string	グループの名前。

PolicyDefinitionReference

Object

ポリシー定義のリファレンス。

名前	型	説明
definitionVersion	string	使用するポリシー定義のバージョン。
effectiveDefinitionVersion	string	使用中のポリシー定義の有効なバージョン。 これは、$expand クエリ パラメーターを使用して要求された場合にのみ存在します。
groupNames	string[]	このポリシー定義が参照するグループの名前。
latestDefinitionVersion	string	使用可能なポリシー定義の最新バージョン。 これは、$expand クエリ パラメーターを使用して要求された場合にのみ存在します。
parameters	<string,  ParameterValuesValue>	参照されるポリシー 規則のパラメーター値。 キーはパラメーター名です。
policyDefinitionId	string	ポリシー定義またはポリシー セット定義の ID。
policyDefinitionReferenceId	string	このポリシー定義参照の一意の ID (ポリシー セット定義内)。

PolicySetDefinitionVersion

Object

ポリシー セット定義のバージョン。

名前	型	説明
id	string	ポリシー セット定義バージョンの ID。
name	string	ポリシー セット定義バージョンの名前。
properties.description	string	ポリシー セット定義の説明。
properties.displayName	string	ポリシー セット定義の表示名。
properties.metadata	object	ポリシー セット定義メタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。
properties.parameters	<string,  ParameterDefinitionsValue>	ポリシー定義参照で使用できるポリシー セット定義パラメーター。
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。
properties.policyDefinitions	PolicyDefinitionReference[]	ポリシー定義参照の配列。
properties.policyType	policyType	ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
properties.version	string	#.#.# 形式のポリシー セット定義のバージョン。
systemData	systemData	このリソースに関連するシステム メタデータ。
type	string	リソースの種類 (Microsoft.Authorization/policySetDefinitions/versions)。

PolicySetDefinitionVersionListResult

Object

ポリシー セット定義のバージョンの一覧。

名前	型	説明
nextLink	string	次の結果セットの取得に使用する URL。
value	PolicySetDefinitionVersion[]	ポリシー セット定義バージョンの配列。

policyType

列挙

ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。

値	説明
NotSpecified
BuiltIn
Custom
Static

systemData

Object

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

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