Policy Set Definition Versions - Get

참조

서비스:: Policy

API 버전:: 2023-04-01

정책 집합 정의 버전을 검색합니다.
이 작업은 지정된 이름 및 버전을 사용하여 지정된 구독에서 정책 집합 정의 버전을 검색합니다.

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

선택적 매개 변수:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
policyDefinitionVersion	path	True	string	정책 집합 정의 버전입니다. x가 주 버전 번호이고, y가 부 버전 번호이고, z가 패치 번호인 x.y.z 형식입니다. regex 패턴: `^\d+\.\d+\.\d+$`
policySetDefinitionName	path	True	string	정책 집합 정의의 이름입니다. regex 패턴: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
subscriptionId	path	True	string uuid	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
$expand	query		string	응답에 포함할 추가 속성의 쉼표로 구분된 목록입니다. 지원되는 값은 'LatestDefinitionVersion, EffectiveDefinitionVersion'입니다.

응답

Name	형식	Description
200 OK	PolicySetDefinitionVersion	확인 - 정책 집합 정의 버전에 대한 정보를 반환합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Retrieve a policy set definition version

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

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.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.get(
        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/getPolicySetDefinitionVersion.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": "/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",
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

정의

Name	Description
CloudError	정책 작업의 오류 응답입니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	오류 응답
Metadata	매개 변수에 대한 일반 메타데이터입니다.
ParameterDefinitionsValue	정책에 제공할 수 있는 매개 변수의 정의입니다.
parameterType	매개 변수의 데이터 형식입니다.
ParameterValuesValue	매개 변수의 값입니다.
PolicyDefinitionGroup	정책 정의 그룹입니다.
PolicyDefinitionReference	정책 정의 참조입니다.
PolicySetDefinitionVersion	정책 집합 정의 버전입니다.
policyType	정책 정의의 형식입니다. 가능한 값은 NotSpecified, BuiltIn, Custom 및 Static입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CloudError

정책 작업의 오류 응답입니다.

Name	형식	Description
error	ErrorResponse	오류 응답 실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

오류 응답

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

Metadata

매개 변수에 대한 일반 메타데이터입니다.

Name	형식	Description
assignPermissions	boolean	정책 할당 중에 Azure Portal에서 이 매개 변수의 리소스 ID 또는 리소스 범위 값에 대한 역할 할당을 만들도록 true로 설정합니다. 이 속성은 할당 범위 외부에서 권한을 할당하려는 경우에 유용합니다.
description	string	매개 변수에 대한 설명입니다.
displayName	string	매개 변수의 표시 이름입니다.
strongType	string	포털을 통해 정책 정의를 할당할 때 사용됩니다. 사용자가 선택할 수 있는 값의 컨텍스트 인식 목록을 제공합니다.

ParameterDefinitionsValue

정책에 제공할 수 있는 매개 변수의 정의입니다.

Name	형식	Description
allowedValues	object[]	매개 변수에 허용되는 값입니다.
defaultValue	object	값이 제공되지 않은 경우 매개 변수의 기본값입니다.
metadata	Metadata	매개 변수에 대한 일반 메타데이터입니다.
schema	object	자체 정의 JSON 스키마를 사용하여 할당하는 동안 매개 변수 입력의 유효성을 검사합니다. 이 속성은 개체 형식 매개 변수에 대해서만 지원되며 Json.NET 스키마 2019-09 구현을 따릅니다. https://json-schema.org/ 스키마를 사용하고 https://www.jsonschemavalidator.net/초안 스키마를 테스트하는 방법에 대해 자세히 알아볼 수 있습니다.
type	parameterType	매개 변수의 데이터 형식입니다.

parameterType

매개 변수의 데이터 형식입니다.

Name	형식	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

매개 변수의 값입니다.

Name	형식	Description
value	object	매개 변수의 값입니다.

PolicyDefinitionGroup

정책 정의 그룹입니다.

Name	형식	Description
additionalMetadataId	string	그룹에 대한 추가 메타데이터를 포함하는 리소스의 리소스 ID입니다.
category	string	그룹의 범주입니다.
description	string	그룹의 설명입니다.
displayName	string	그룹의 표시 이름입니다.
name	string	그룹의 이름입니다.

PolicyDefinitionReference

정책 정의 참조입니다.

Name	형식	Description
definitionVersion	string	사용할 정책 정의의 버전입니다.
effectiveDefinitionVersion	string	사용 중인 정책 정의의 유효 버전입니다. 이는 $expand 쿼리 매개 변수를 통해 요청된 경우에만 존재합니다.
groupNames	string[]	이 정책 정의 참조가 속한 그룹의 이름입니다.
latestDefinitionVersion	string	사용 가능한 정책 정의의 최신 버전입니다. 이는 $expand 쿼리 매개 변수를 통해 요청된 경우에만 존재합니다.
parameters	<string, ParameterValuesValue>	참조된 정책 규칙의 매개 변수 값입니다. 키는 매개 변수 이름입니다.
policyDefinitionId	string	정책 정의 또는 정책 집합 정의의 ID입니다.
policyDefinitionReferenceId	string	이 정책 정의 참조에 대한 고유 ID(정책 집합 정의 내)입니다.