{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-policyinsights-policystates","description":"PolicyStatesClient","version":"2018-07-01-preview","base_url":"https://management.azure.com","endpoints":18,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api PolicyStatesClient\n@base https://management.azure.com\n@version 2018-07-01-preview\n@auth OAuth2\n@common_fields {api-version: any # Client Api Version.}\n@endpoints 18\n@toc providers(3), subscriptions(12), {resourceId}(2), {scope}(1)\n\n@group providers\n@endpoint POST /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the resources under the management group.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., managementGroupsNamespace: any # The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed., managementGroupName: any # Management group name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the resources under the management group.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., managementGroupsNamespace: any # The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed., managementGroupName: any # Management group name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the resources under the subscription.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the resources under the subscription.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the resources under the resource group.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the resources under the resource group.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endgroup\n\n@group {resourceId}\n@endpoint POST /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the resource.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., resourceId: any # Resource ID.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $expand: any # The $expand query parameter. For example, to expand policyEvaluationDetails, use $expand=policyEvaluationDetails, $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the resource.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., resourceId: any # Resource ID.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the subscription level policy set definition.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policySetDefinitionName: any # Policy set definition name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the subscription level policy set definition.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policySetDefinitionName: any # Policy set definition name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the subscription level policy definition.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyDefinitionName: any # Policy definition name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the subscription level policy definition.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyDefinitionName: any # Policy definition name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the subscription level policy assignment.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyAssignmentName: any # Policy assignment name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the subscription level policy assignment.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyAssignmentName: any # Policy assignment name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults\n@desc Queries policy states for the resource group level policy assignment.\n@required {policyStatesResource: any # The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s)., subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyAssignmentName: any # Policy assignment name.}\n@optional {$top: any # Maximum number of records to return., $orderby: any # Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\"., $select: any # Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\"., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression., $apply: any # OData apply expression for aggregations., $skiptoken: any # Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.}\n@returns(200) Query results.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize\n@desc Summarizes policy states for the resource group level policy assignment.\n@required {policyStatesSummaryResource: any # The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value., subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., authorizationNamespace: any # The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed., policyAssignmentName: any # Policy assignment name.}\n@optional {$top: any # Maximum number of records to return., $from: any # ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day)., $to: any # ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time., $filter: any # OData filter expression.}\n@returns(200) Summarize results.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.PolicyInsights/operations\n@desc Lists available operations.\n@returns(200) List of available operations.\n\n@endgroup\n\n@group {scope}\n@endpoint GET /{scope}/providers/Microsoft.PolicyInsights/policyStates/$metadata\n@desc Gets OData metadata XML document.\n@required {scope: any # A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.}\n@returns(200) OData metadata XML document.\n\n@endgroup\n\n@end\n"}