Policy States - List Query Results For Policy Set Definition
구독 수준 정책 집합 정의에 대한 정책 상태를 쿼리합니다.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
authorization
|
path | True |
Microsoft 권한 부여 리소스 공급자의 네임스페이스입니다. "Microsoft.Authorization"만 허용됩니다. |
|
policy
|
path | True |
string |
정책 집합 정의 이름입니다. |
policy
|
path | True |
PolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 정책 상태를 나타내는 반면 , 'default'는 모든 정책 상태를 나타냅니다. |
|
subscription
|
path | True |
string |
Microsoft Azure 구독 ID입니다. |
api-version
|
query | True |
string |
클라이언트 API 버전. |
$apply
|
query |
string |
OData는 집계에 식을 적용합니다. |
|
$filter
|
query |
string |
OData 필터 식입니다. |
|
$from
|
query |
string date-time |
쿼리할 간격의 시작 시간을 지정하는 ISO 8601 형식 타임스탬프입니다. 지정하지 않으면 서비스에서 ($to - 1일)을 사용합니다. |
|
$orderby
|
query |
string |
OData 표기법을 사용하여 식 순서 지정 선택적 "desc"(기본값) 또는 "asc"(예: "$orderby=PolicyAssignmentId, ResourceId asc")가 있는 하나 이상의 쉼표로 구분된 열 이름입니다. |
|
$select
|
query |
string |
OData 표기법을 사용하여 식을 선택합니다. 각 레코드의 열을 요청된 열(예: "$select=PolicyAssignmentId, ResourceId")으로 제한합니다. |
|
$skiptoken
|
query |
string |
Skiptoken은 이전 응답이 nextLink 요소의 일부로 부분 결과를 반환한 경우에만 제공됩니다. |
|
$to
|
query |
string date-time |
쿼리할 간격의 종료 시간을 지정하는 ISO 8601 형식 타임스탬프입니다. 지정하지 않으면 서비스에서 요청 시간을 사용합니다. |
|
$top
|
query |
integer int32 |
반환할 최대 레코드 수입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
쿼리 결과 |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
Query latest at subscription level policy set definition scope |
Query latest at subscription level policy set definition scope with next link |
Query latest at subscription level policy set definition scope
샘플 요청
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01
샘플 응답
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:54:58Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Web/sites",
"resourceLocation": "centralus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "3f3c4330183b4e218fe6fd29",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": "2.0.1",
"policyAssignmentVersion": "1.0.0"
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:54:58Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/LocationAuditDefinition",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Web/sites",
"resourceLocation": "centralus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "3f3c4330183b4e218fe6fd29",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "LocationAuditDefinition",
"policyDefinitionAction": "Audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": "2.0.1",
"policyAssignmentVersion": "1.0.0"
}
]
}
Query latest at subscription level policy set definition scope with next link
샘플 요청
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD
샘플 응답
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:54:58Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Web/sites",
"resourceLocation": "centralus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "3f3c4330183b4e218fe6fd29",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"policyDefinitionGroupNames": [
"myGroup"
]
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:54:58Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/LocationAuditDefinition",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Web/sites",
"resourceLocation": "centralus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "3f3c4330183b4e218fe6fd29",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "LocationAuditDefinition",
"policyDefinitionAction": "Audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
]
}
]
}
정의
Name | Description |
---|---|
Authorization |
Microsoft 권한 부여 리소스 공급자의 네임스페이스입니다. "Microsoft.Authorization"만 허용됩니다. |
Component |
구성 요소 상태 세부 정보입니다. |
Error |
오류 정의. |
Expression |
정책 언어 식의 평가 세부 정보입니다. |
If |
IfNotExists 효과의 평가 세부 정보입니다. |
Policy |
정책 평가 세부 정보입니다. |
Policy |
정책 상태 레코드입니다. |
Policy |
쿼리 결과 |
Policy |
PolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 정책 상태를 나타내는 반면 , 'default'는 모든 정책 상태를 나타냅니다. |
Query |
오류 응답입니다. |
AuthorizationNamespaceType
Microsoft 권한 부여 리소스 공급자의 네임스페이스입니다. "Microsoft.Authorization"만 허용됩니다.
Name | 형식 | Description |
---|---|---|
Microsoft.Authorization |
string |
ComponentStateDetails
구성 요소 상태 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
complianceState |
string |
구성 요소 준수 상태입니다. |
id |
string |
구성 요소 ID입니다. |
name |
string |
구성 요소 이름입니다. |
timestamp |
string |
구성 요소 준수 평가 타임스탬프. |
type |
string |
구성 요소 유형입니다. |
Error
오류 정의.
Name | 형식 | Description |
---|---|---|
code |
string |
HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다. |
message |
string |
오류 설명입니다. |
ExpressionEvaluationDetails
정책 언어 식의 평가 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
expression |
string |
식이 계산되었습니다. |
expressionKind |
string |
계산된 식의 종류입니다. |
expressionValue |
object |
식의 값입니다. |
operator |
string |
식 값과 대상 값을 비교하는 연산자입니다. |
path |
string |
식이 필드 또는 별칭인 경우 속성 경로입니다. |
result |
string |
평가 결과입니다. |
targetValue |
object |
식 값과 비교할 대상 값입니다. |
IfNotExistsEvaluationDetails
IfNotExists 효과의 평가 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
resourceId |
string |
IfNotExists 효과에 대해 마지막으로 평가된 리소스의 ID입니다. |
totalResources |
integer |
존재 조건을 적용할 수 있는 총 리소스 수입니다. |
PolicyEvaluationDetails
정책 평가 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
evaluatedExpressions |
평가된 식의 세부 정보입니다. |
|
ifNotExistsDetails |
IfNotExists 효과의 평가 세부 정보입니다. |
PolicyState
정책 상태 레코드입니다.
Name | 형식 | Description |
---|---|---|
@odata.context |
string |
OData 컨텍스트 문자열; OData 클라이언트에서 메타데이터에 따라 형식 정보를 resolve 데 사용됩니다. |
@odata.id |
string |
OData 엔터티 ID; 정책 상태 레코드에 엔터티 ID가 없으므로 항상 null로 설정합니다. |
complianceState |
string |
리소스의 준수 상태입니다. |
components |
URL에 $expand=components 절이 포함된 경우에만 구성 요소 상태 준수 레코드가 채워집니다. |
|
effectiveParameters |
string |
정책 할당에 대한 유효 매개 변수입니다. |
isCompliant |
boolean |
리소스가 평가된 정책 할당과 호환되는지 여부를 나타내는 플래그입니다. 이 속성은 더 이상 사용되지 않습니다. 대신 ComplianceState를 사용하세요. |
managementGroupIds |
string |
리소스가 있는 관리 그룹의 계층 구조를 나타내는 관리 그룹 ID의 쉼표로 구분된 목록입니다. |
policyAssignmentId |
string |
정책 할당 ID입니다. |
policyAssignmentName |
string |
정책 할당 이름입니다. |
policyAssignmentOwner |
string |
정책 할당 소유자. |
policyAssignmentParameters |
string |
정책 할당 매개 변수. |
policyAssignmentScope |
string |
정책 할당 scope. |
policyAssignmentVersion |
string |
평가된 정책 할당 버전입니다. |
policyDefinitionAction |
string |
정책 정의 작업, 즉 효과입니다. |
policyDefinitionCategory |
string |
정책 정의 범주입니다. |
policyDefinitionGroupNames |
string[] |
정책 정의 그룹 이름입니다. |
policyDefinitionId |
string |
정책 정의 ID입니다. |
policyDefinitionName |
string |
정책 정의 이름입니다. |
policyDefinitionReferenceId |
string |
정책 할당이 정책 집합에 대한 경우 정책 집합 내의 정책 정의에 대한 참조 ID입니다. |
policyDefinitionVersion |
string |
평가된 정책 정의 버전입니다. |
policyEvaluationDetails |
정책 평가 세부 정보입니다. |
|
policySetDefinitionCategory |
string |
정책 집합에 대한 정책 할당인 경우 정책 집합 정의 범주입니다. |
policySetDefinitionId |
string |
정책 집합에 대한 정책 할당인 경우 정책 집합 정의 ID입니다. |
policySetDefinitionName |
string |
정책 집합에 대한 정책 할당인 경우 정책 집합 정의 이름입니다. |
policySetDefinitionOwner |
string |
정책 집합 정의 소유자(정책 할당이 정책 집합에 대한 것인 경우). |
policySetDefinitionParameters |
string |
정책 집합에 대한 정책 할당인 경우 정책 집합 정의 매개 변수입니다. |
policySetDefinitionVersion |
string |
평가된 정책 집합 정의 버전입니다. |
resourceGroup |
string |
리소스 그룹 이름 |
resourceId |
string |
리소스 ID입니다. |
resourceLocation |
string |
리소스 위치. |
resourceTags |
string |
리소스 태그 목록입니다. |
resourceType |
string |
리소스 종류. |
subscriptionId |
string |
구독 ID가 표시됩니다. |
timestamp |
string |
정책 상태 레코드의 타임스탬프입니다. |
PolicyStatesQueryResults
쿼리 결과
Name | 형식 | Description |
---|---|---|
@odata.context |
string |
OData 컨텍스트 문자열; OData 클라이언트에서 메타데이터에 따라 형식 정보를 resolve 데 사용됩니다. |
@odata.count |
integer |
OData 엔터티 수; 는 반환된 정책 상태 레코드의 수를 나타냅니다. |
@odata.nextLink |
string |
Odata 다음 링크; 다음 결과 집합을 가져오는 URL입니다. |
value |
쿼리 결과 |
PolicyStatesResource
PolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 정책 상태를 나타내는 반면 , 'default'는 모든 정책 상태를 나타냅니다.
Name | 형식 | Description |
---|---|---|
default |
string |
|
latest |
string |
QueryFailure
오류 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 정의. |