Policy Assignments - Get

참조

서비스:: Policy

API 버전:: 2023-04-01

정책 할당을 검색합니다.
이 작업은 이름 및 생성된 범위가 지정된 단일 정책 할당을 검색합니다.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01

선택적 매개 변수:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?$expand={$expand}&api-version=2023-04-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
policyAssignmentName	path	True	string	가져올 정책 할당의 이름입니다. regex 패턴: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
scope	path	True	string	정책 할당의 범위입니다. 유효한 범위는 관리 그룹(형식: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), 구독(형식: '/subscriptions/{subscriptionId}'), 리소스 그룹(형식: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', 또는 리소스(형식: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
$expand	query		string	응답에 포함할 추가 속성의 쉼표로 구분된 목록입니다. 지원되는 값은 'LatestDefinitionVersion, EffectiveDefinitionVersion'입니다.

응답

Name	형식	Description
200 OK	PolicyAssignment	확인 - 정책 할당에 대한 정보를 반환합니다.
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 assignment

Retrieve a policy assignment with a system assigned identity

Retrieve a policy assignment with a user assigned identity

Retrieve a policy assignment with overrides

Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a system assigned identity

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a user assigned identity

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with overrides

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Retrieve a policy assignment with resource selectors

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

정의

Name	Description
CloudError	정책 작업의 오류 응답입니다.
createdByType	리소스를 만든 ID의 형식입니다.
enforcementMode	정책 할당 적용 모드입니다. 가능한 값은 Default 및 DoNotEnforce입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	오류 응답
Identity	리소스의 ID입니다. 정책 할당은 최대 하나의 ID를 지원합니다. 시스템 할당 ID 또는 단일 사용자 할당 ID입니다.
NonComplianceMessage	리소스가 정책을 준수하지 않는 이유를 설명하는 메시지입니다. 이는 '거부' 오류 메시지와 리소스의 비준수 준수 결과에 표시됩니다.
Override	정책 속성 값이 재정의됩니다.
OverrideKind	재정의 종류입니다.
ParameterValuesValue	매개 변수의 값입니다.
PolicyAssignment	정책 할당입니다.
ResourceIdentityType	ID 형식입니다. 이 필드는 리소스에 시스템 또는 사용자 할당 ID를 추가할 때 유일한 필수 필드입니다.
ResourceSelector	리소스 속성을 사용하여 정책을 필터링할 리소스 선택기입니다.
Selector	선택기 식입니다.
SelectorKind	선택기 종류입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UserAssignedIdentities	정책과 연결된 사용자 ID입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

CloudError

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

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

createdByType

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

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

enforcementMode

정책 할당 적용 모드입니다. 가능한 값은 Default 및 DoNotEnforce입니다.

Name	형식	Description
Default	string	정책 효과는 리소스를 만들거나 업데이트하는 동안 적용됩니다.
DoNotEnforce	string	정책 효과는 리소스를 만들거나 업데이트하는 동안 적용되지 않습니다.

ErrorAdditionalInfo

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

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

ErrorResponse

오류 응답

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

Identity

리소스의 ID입니다. 정책 할당은 최대 하나의 ID를 지원합니다. 시스템 할당 ID 또는 단일 사용자 할당 ID입니다.

Name	형식	Description
principalId	string	리소스 ID의 보안 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
tenantId	string	리소스 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
type	ResourceIdentityType	ID 형식입니다. 이 필드는 리소스에 시스템 또는 사용자 할당 ID를 추가할 때 유일한 필수 필드입니다.
userAssignedIdentities	UserAssignedIdentities	정책과 연결된 사용자 ID입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

NonComplianceMessage

리소스가 정책을 준수하지 않는 이유를 설명하는 메시지입니다. 이는 '거부' 오류 메시지와 리소스의 비준수 준수 결과에 표시됩니다.

Name	형식	Description
message	string	리소스가 정책을 준수하지 않는 이유를 설명하는 메시지입니다. 이는 '거부' 오류 메시지와 리소스의 비준수 준수 결과에 표시됩니다.
policyDefinitionReferenceId	string	메시지가 의도된 정책 집합 정의 내의 정책 정의 참조 ID입니다. 정책 할당이 정책 집합 정의를 할당하는 경우에만 적용됩니다. 이 메시지가 제공되지 않으면 이 정책 할당에 의해 할당된 모든 정책에 메시지가 적용됩니다.

Override

정책 속성 값이 재정의됩니다.

Name	형식	Description
kind	OverrideKind	재정의 종류입니다.
selectors	Selector[]	선택기 식의 목록입니다.
value	string	정책 속성을 재정의할 값입니다.

OverrideKind

재정의 종류입니다.

Name	형식	Description
policyEffect	string	정책 효과 유형을 재정의합니다.

ParameterValuesValue

매개 변수의 값입니다.

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

PolicyAssignment

정책 할당입니다.

Name	형식	Default value	Description
id	string		정책 할당의 ID입니다.
identity	Identity		정책 할당과 연결된 관리 ID입니다.
location	string		정책 할당의 위치입니다. 관리 ID를 활용하는 경우에만 필요합니다.
name	string		정책 할당의 이름입니다.
properties.definitionVersion	string		사용할 정책 정의의 버전입니다.
properties.description	string		이 메시지는 정책 위반의 경우 응답의 일부가 됩니다.
properties.displayName	string		정책 할당의 표시 이름입니다.
properties.effectiveDefinitionVersion	string		사용 중인 정책 정의의 유효 버전입니다. 이는 $expand 쿼리 매개 변수를 통해 요청된 경우에만 존재합니다.
properties.enforcementMode	enforcementMode	Default	정책 할당 적용 모드입니다. 가능한 값은 Default 및 DoNotEnforce입니다.
properties.latestDefinitionVersion	string		사용 가능한 정책 정의의 최신 버전입니다. 이는 $expand 쿼리 매개 변수를 통해 요청된 경우에만 존재합니다.
properties.metadata	object		정책 할당 메타데이터입니다. 메타데이터는 열려 있는 종료된 개체이며 일반적으로 키 값 쌍의 컬렉션입니다.
properties.nonComplianceMessages	NonComplianceMessage[]		리소스가 정책을 준수하지 않는 이유를 설명하는 메시지입니다.
properties.notScopes	string[]		정책의 제외된 범위입니다.
properties.overrides	Override[]		정책 속성 값이 재정의됩니다.
properties.parameters	<string, ParameterValuesValue>		할당된 정책 규칙의 매개 변수 값입니다. 키는 매개 변수 이름입니다.
properties.policyDefinitionId	string		할당되는 정책 정의 또는 정책 집합 정의의 ID입니다.
properties.resourceSelectors	ResourceSelector[]		리소스 속성별로 정책을 필터링할 리소스 선택기 목록입니다.
properties.scope	string		정책 할당의 범위입니다.
systemData	systemData		이 리소스와 관련된 시스템 메타데이터입니다.
type	string		정책 할당의 형식입니다.

ResourceIdentityType

ID 형식입니다. 이 필드는 리소스에 시스템 또는 사용자 할당 ID를 추가할 때 유일한 필수 필드입니다.

Name	형식	Description
None	string	리소스와 연결된 ID가 없거나 기존 ID를 제거해야 했음을 나타냅니다.
SystemAssigned	string	시스템 할당 ID가 리소스와 연결되어 있음을 나타냅니다.
UserAssigned	string	시스템 할당 ID가 리소스와 연결되어 있음을 나타냅니다.

ResourceSelector

리소스 속성을 사용하여 정책을 필터링할 리소스 선택기입니다.

Name	형식	Description
name	string	리소스 선택기의 이름입니다.
selectors	Selector[]	선택기 식의 목록입니다.

Selector

선택기 식입니다.

Name	형식	Description
in	string[]	필터링할 값 목록입니다.
kind	SelectorKind	선택기 종류입니다.
notIn	string[]	필터링할 값 목록입니다.

SelectorKind

선택기 종류입니다.

Name	형식	Description
policyDefinitionReferenceId	string	정책 정의 참조 ID를 기준으로 정책을 필터링할 선택기 종류입니다.
resourceLocation	string	리소스 위치별로 정책을 필터링할 선택기 종류입니다.
resourceType	string	리소스 종류별로 정책을 필터링할 선택기 종류입니다.
resourceWithoutLocation	string	위치가 없는 리소스별로 정책을 필터링할 선택기 종류입니다.

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

UserAssignedIdentities

정책과 연결된 사용자 ID입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

Name	형식	Description

다음을 통해 공유

Policy Assignments - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

Retrieve a policy assignment

샘플 요청

샘플 응답

Retrieve a policy assignment with a system assigned identity

샘플 요청

샘플 응답

Retrieve a policy assignment with a user assigned identity

샘플 요청

샘플 응답

Retrieve a policy assignment with overrides

샘플 요청

샘플 응답

Retrieve a policy assignment with resource selectors

샘플 요청

샘플 응답

정의

CloudError

createdByType

enforcementMode

ErrorAdditionalInfo

ErrorResponse

Identity

NonComplianceMessage

Override

OverrideKind

ParameterValuesValue

PolicyAssignment

ResourceIdentityType

ResourceSelector

Selector

SelectorKind

systemData

UserAssignedIdentities

추가 리소스