Component Policy States - List Query Results For Subscription

서비스:

Policy

API 버전:

2022-04-01

구독 scope 구성 요소 정책 상태를 쿼리합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01

선택적 매개 변수:

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	ComponentPolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 구성 요소 정책 상태를 나타냅니다.
subscriptionId	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")으로 제한합니다.
$to	query		string date-time	쿼리할 간격의 종료 시간을 지정하는 ISO 8601 형식 타임스탬프입니다. 지정하지 않으면 서비스는 요청 시간을 사용합니다.
$top	query		integer int32	반환할 최대 레코드 수입니다.

응답

Name	형식	Description
200 OK	ComponentPolicyStatesQueryResults	쿼리 결과
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment.

Query latest component policy states at subscription scope

Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment.

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'&$apply=groupby((componentType,complianceState),aggregate($count as count))

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python component_policy_states_query_subscription_scope_group_by_component_type_with_aggregate.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 = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="e78961ba-36fe-4739-9212-e3031b4c8db7",
    )

    response = client.component_policy_states.list_query_results_for_subscription(
        subscription_id="e78961ba-36fe-4739-9212-e3031b4c8db7",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.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

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Queries component policy states under subscription scope.
 *
 * @summary Queries component policy states under subscription scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json
 */
async function queryLatestComponentPolicyComplianceStateCountGroupedByComponentTypeAtSubscriptionScopeFilteredByGivenAssignment() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const componentPolicyStatesResource = "latest";
  const filter =
    "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'";
  const apply = "groupby((componentType,complianceState),aggregate($count as count))";
  const options = {
    filter,
    apply,
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForSubscription(
    subscriptionId,
    componentPolicyStatesResource,
    options
  );
  console.log(result);
}

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

샘플 응답

상태 코드:

200

{
  "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "componentType": "Certificate",
      "complianceState": "NonCompliant",
      "count": 26
    },
    {
      "componentType": "Certificate",
      "complianceState": "Compliant",
      "count": 10
    }
  ]
}

Query latest component policy states at subscription scope

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python component_policy_states_query_subscription_scope.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 = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="fff10b27-fff3-fff5-fff8-fffbe01e86a5",
    )

    response = client.component_policy_states.list_query_results_for_subscription(
        subscription_id="fff10b27-fff3-fff5-fff8-fffbe01e86a5",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScope.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

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Queries component policy states under subscription scope.
 *
 * @summary Queries component policy states under subscription scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json
 */
async function queryLatestComponentPolicyStatesAtSubscriptionScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForSubscription(
    subscriptionId,
    componentPolicyStatesResource
  );
  console.log(result);
}

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

샘플 응답

상태 코드:

200

{
  "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
      "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
      "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "complianceReasonCode": "tbd",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "cert-RSA-cert-2",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-2",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
      "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
      "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "complianceReasonCode": "tbd",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

정의

Name	Description
ComponentExpressionEvaluationDetails	정책 언어 식의 평가 세부 정보입니다.
ComponentPolicyEvaluationDetails	정책 평가 세부 정보입니다.
ComponentPolicyState	구성 요소 정책 상태 레코드입니다.
ComponentPolicyStatesQueryResults	쿼리 결과
ComponentPolicyStatesResource	ComponentPolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 구성 요소 정책 상태를 나타냅니다.
ErrorDefinition	오류 정의입니다.
ErrorResponse	오류 응답입니다.
TypedErrorInfo	시나리오별 오류 세부 정보입니다.

ComponentExpressionEvaluationDetails

정책 언어 식의 평가 세부 정보입니다.

Name	형식	Description
expression	string	식이 평가되었습니다.
expressionKind	string	평가된 식의 종류입니다.
expressionValue	object	식의 값입니다.
operator	string	식 값과 대상 값을 비교하는 연산자입니다.
path	string	식이 필드 또는 별칭인 경우 속성 경로입니다.
result	string	평가 결과입니다.
targetValue	object	식 값과 비교할 대상 값입니다.

ComponentPolicyEvaluationDetails

정책 평가 세부 정보입니다.

Name	형식	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	평가된 식의 세부 정보입니다.
reason	string	평가 결과에 대한 추가 텍스트 이유입니다.

ComponentPolicyState

구성 요소 정책 상태 레코드입니다.

Name	형식	Description
@odata.context	string	OData 컨텍스트 문자열; OData 클라이언트에서 메타데이터에 따라 형식 정보를 resolve 데 사용됩니다.
@odata.id	string	OData 엔터티 ID; 구성 요소 정책 상태 레코드에 엔터티 ID가 없으므로 항상 null로 설정됩니다.
complianceState	string	리소스의 준수 상태입니다.
componentId	string	구성 요소 ID입니다.
componentName	string	구성 요소 이름입니다.
componentType	string	구성 요소 유형입니다.
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	ComponentPolicyEvaluationDetails	정책 평가 세부 정보입니다. 요청에 $expand=PolicyEvaluationDetails가 포함된 경우에만 응답에 포함됩니다.
policySetDefinitionCategory	string	정책 집합에 대한 정책 할당인 경우 정책 집합 정의 범주입니다.
policySetDefinitionId	string	정책 집합에 대한 정책 할당인 경우 정책 집합 정의 ID입니다.
policySetDefinitionName	string	정책 집합에 대한 정책 할당인 경우 정책 집합 정의 이름입니다.
policySetDefinitionOwner	string	정책 집합에 대한 정책 할당인 경우 정책 집합 정의 소유자입니다.
policySetDefinitionParameters	string	정책 집합에 대한 정책 할당인 경우 정책 집합 정의 매개 변수입니다.
policySetDefinitionVersion	string	평가된 정책 집합 정의 버전입니다.
resourceGroup	string	리소스 그룹 이름
resourceId	string	리소스 ID입니다.
resourceLocation	string	리소스 위치.
resourceType	string	리소스 종류.
subscriptionId	string	구독 ID가 표시됩니다.
timestamp	string	구성 요소 정책 상태 레코드에 대한 타임스탬프입니다.

ComponentPolicyStatesQueryResults

쿼리 결과

Name	형식	Description
@odata.context	string	OData 컨텍스트 문자열; OData 클라이언트에서 메타데이터에 따라 형식 정보를 resolve 데 사용됩니다.
@odata.count	integer	OData 엔터티 수; 는 반환되는 정책 상태 레코드의 수를 나타냅니다.
value	ComponentPolicyState[]	쿼리 결과

ComponentPolicyStatesResource

ComponentPolicyStates 리소스 종류 아래의 가상 리소스입니다. 지정된 시간 범위에서 'latest'는 최신 구성 요소 정책 상태를 나타냅니다.

Name	형식	Description
latest	string

ErrorDefinition

오류 정의입니다.

Name	형식	Description
additionalInfo	TypedErrorInfo[]	추가 시나리오별 오류 세부 정보입니다.
code	string	HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다.
details	ErrorDefinition[]	내부 오류 세부 정보입니다.
message	string	오류 설명입니다.
target	string	오류의 대상입니다.

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	ErrorDefinition	오류 세부 정보입니다.

TypedErrorInfo

시나리오별 오류 세부 정보입니다.

Name	형식	Description
info		시나리오별 오류 세부 정보입니다.
type	string	포함된 오류 세부 정보의 유형입니다.