Unable to iterate over the entire results of policy_states.list_query_results_for_subscription.

[ietashish]

• Package Name: azure.mgmt.policyinsights
• Package Version: 1.0.0
• Operating System: MacOS
• Python Version: 3.7

Describe the bug
The issue happens when trying to list the policy state of entire subscription.

After instantiating PolicyInsightsClient and iterating over the results returned by client.policy_states.list_query_results_for_subscription(...), the following exception is thrown

 File "/Users/ashishg/****/venv/lib/python3.7/site-packages/azure/mgmt/policyinsights/operations/_policy_states_operations.py", line 352, in get_next
    raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
azure.core.exceptions.HttpResponseError: (HttpMethodNotSupported) The http method 'GET' is not supported for 'queryResults'.

Only the first 1000 policy state results are listed and when the client goes on to fetch the next 1000 results it errors out with the above exception.

The issue is happening because the Policy States List API (https://docs.microsoft.com/en-us/rest/api/policy/policystates/listqueryresultsforsubscription) expects the URL returned by @odata.nextLink attribute to be called over POST and not GET.

The problem seems to in line,

azure-sdk-for-python/sdk/policyinsights/azure-mgmt-policyinsights/azure/mgmt/policyinsights/operations/_policy_states_operations.py

Line 139 in 447e6f7

request = self._client.get(url, query_parameters, header_parameters)

Things start to work, on changing the line from request = self._client.get(url, query_parameters, header_parameters)
to
request = self._client.post(url, query_parameters, header_parameters)

To Reproduce
Steps to reproduce the behavior:

1. pip install azure-mgmt-policyinsights (latest version which is 1.0.0)
2. Run the following simple snippet to reproduce the issue.
   NOTE: Make sure that the subscription this is tried upon has more than 1000 policy state results.

from azure.mgmt.policyinsights._policy_insights_client import PolicyInsightsClient

#credential = <Create the credential object here>
#sub_id = <some subscription id>

client = PolicyInsightsClient(cred, base_url=mavlink_helpers.get_arm_base_url(tenant_region), subscription_id=sub_id)
policy_states = client.policy_states.list_query_results_for_subscription(policy_states_resource="latest",
                                                                             subscription_id=sub_id)
for policy_state in policy_states:
    policy_state = policy_state.as_dict()
    print(policy_state['policy_definition_id'], policy_state['resource_id'])

Expected behavior
One should be able to iterate over the entire list of policy states.

[yunhaoling]

thanks for the feedback! we'll investigate this asap.
looping in @msyyc who could provide further help on mgmt libraries.

[msyyc]

@00Kai0 please provide help on the issue

[00Kai0]

This issue happened because next link using wrong method.
Normally, next_link will use get to get next page. But this API uses an unusual post request to get data.
https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/policyinsights/azure-mgmt-policyinsights/azure/mgmt/policyinsights/operations/_policy_states_operations.py#L139

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @kenieva.

Issue Details

---

• Package Name: azure.mgmt.policyinsights
• Package Version: 1.0.0
• Operating System: MacOS
• Python Version: 3.7

Describe the bug
The issue happens when trying to list the policy state of entire subscription.

After instantiating PolicyInsightsClient and iterating over the results returned by client.policy_states.list_query_results_for_subscription(...), the following exception is thrown

 File "/Users/ashishg/****/venv/lib/python3.7/site-packages/azure/mgmt/policyinsights/operations/_policy_states_operations.py", line 352, in get_next
    raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
azure.core.exceptions.HttpResponseError: (HttpMethodNotSupported) The http method 'GET' is not supported for 'queryResults'.

Only the first 1000 policy state results are listed and when the client goes on to fetch the next 1000 results it errors out with the above exception.

The issue is happening because the Policy States List API (https://docs.microsoft.com/en-us/rest/api/policy/policystates/listqueryresultsforsubscription) expects the URL returned by @odata.nextLink attribute to be called over POST and not GET.

The problem seems to in line,

azure-sdk-for-python/sdk/policyinsights/azure-mgmt-policyinsights/azure/mgmt/policyinsights/operations/_policy_states_operations.py

Line 139 in 447e6f7

request = self._client.get(url, query_parameters, header_parameters)

Things start to work, on changing the line from request = self._client.get(url, query_parameters, header_parameters)
to
request = self._client.post(url, query_parameters, header_parameters)

To Reproduce
Steps to reproduce the behavior:

1. pip install azure-mgmt-policyinsights (latest version which is 1.0.0)
2. Run the following simple snippet to reproduce the issue.
   NOTE: Make sure that the subscription this is tried upon has more than 1000 policy state results.

from azure.mgmt.policyinsights._policy_insights_client import PolicyInsightsClient

#credential = <Create the credential object here>
#sub_id = <some subscription id>

client = PolicyInsightsClient(cred, base_url=mavlink_helpers.get_arm_base_url(tenant_region), subscription_id=sub_id)
policy_states = client.policy_states.list_query_results_for_subscription(policy_states_resource="latest",
                                                                             subscription_id=sub_id)
for policy_state in policy_states:
    policy_state = policy_state.as_dict()
    print(policy_state['policy_definition_id'], policy_state['resource_id'])

Expected behavior
One should be able to iterate over the entire list of policy states.

Author:	ietashish
Assignees:	00Kai0, zhangyan133
Labels:	Mgmt, Policy Insights, Service Attention, bug, customer-reported
Milestone:	-

[msyyc]

Fix swagger PR :Azure/azure-rest-api-specs#14035

[SaurabhSharma-MSFT]

@ietashish I am following to know if your issue is resolved ? Please let us know.

[ghost]

Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next 7 days. If we don't hear back from you within 14 days of this comment the issue will be automatically closed. Thank you!