Policy Set Definition Versions - Get At Management Group

サービス:

Policy

API バージョン:

2023-04-01

ポリシー セット定義のバージョンを取得します。
この操作では、指定された名前とバージョンを持つ特定の管理グループ内のポリシー セット定義のバージョンを取得します。

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

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

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?$expand={$expand}&api-version=2023-04-01

URI パラメーター

名前	/	必須	型	説明
managementGroupName	path	True	string	管理グループの名前。 名前では大文字と小文字が区別されません。
policyDefinitionVersion	path	True	string	ポリシー セット定義のバージョン。 形式は x.y.z で、x はメジャー バージョン番号、y はマイナー バージョン番号、z はパッチ番号です 正規表現パターン: ^\d+\.\d+\.\d+$
policySetDefinitionName	path	True	string	ポリシー セット定義の名前。 正規表現パターン: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
api-version	query	True	string	この操作に使用する API バージョン。
$expand	query		string	応答に含める追加プロパティのコンマ区切りの一覧。 サポートされている値は 'LatestDefinitionVersion, EffectiveDefinitionVersion' です。

応答

名前	型	説明
200 OK	PolicySetDefinitionVersion	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	ユーザー アカウントを偽装する

例

Retrieve a policy set definition version at management group level

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2023-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_policy_set_definition_version_at_management_group.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="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definition_versions.get_at_management_group(
        management_group_name="MyManagementGroup",
        policy_set_definition_name="CostManagement",
        policy_definition_version="1.2.1",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersionAtManagementGroup.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

応答のサンプル

状態コード:

200

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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	ポリシー セット定義のバージョン。
policyType	ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
systemData	リソースの作成と最後の変更に関連するメタデータ。

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	エラーターゲット。

Metadata

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

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

ParameterDefinitionsValue

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

名前	型	説明
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

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

名前	型	説明
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

パラメーターの値。

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

PolicyDefinitionGroup

ポリシー定義グループ。

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

PolicyDefinitionReference

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

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

PolicySetDefinitionVersion

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

名前	型	説明
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)。

policyType

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

名前	型	説明
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

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

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