Policy States - List Query Results For Resource Group Level Policy Assignment
Consulta os estados da política para a atribuição de política ao nível do grupo de recursos.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/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}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
authorization
|
path | True |
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization". |
|
policy
|
path | True |
string |
Nome da atribuição de política. |
policy
|
path | True |
O recurso virtual em PolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes, enquanto "predefinição" representa todos os estados da política. |
|
resource
|
path | True |
string |
Nome do grupo de recursos. |
subscription
|
path | True |
string |
ID da subscrição do Microsoft Azure. |
api-version
|
query | True |
string |
Versão da API do Cliente. |
$apply
|
query |
string |
OData aplica expressão para agregações. |
|
$filter
|
query |
string |
Expressão de filtro OData. |
|
$from
|
query |
string date-time |
IsO 8601 formatado carimbo de data/hora especificando a hora de início do intervalo a consultar. Quando não for especificado, o serviço utiliza ($to - 1 dia). |
|
$orderby
|
query |
string |
Expressão de ordenação com notação OData. Um ou mais nomes de coluna separados por vírgulas com um "desc" opcional (a predefinição) ou "asc", por exemplo, "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Selecione expressão com a notação OData. Limita as colunas em cada registo apenas às pedidas, por exemplo, "$select=PolicyAssignmentId, ResourceId". |
|
$skiptoken
|
query |
string |
O skiptoken só é fornecido se uma resposta anterior devolver um resultado parcial como parte do elemento nextLink. |
|
$to
|
query |
string date-time |
IsO 8601 formatado carimbo de data/hora especificando a hora de fim do intervalo para consulta. Quando não for especificado, o serviço utiliza o tempo de pedido. |
|
$top
|
query |
integer int32 |
Número máximo de registos a devolver. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Resultados da consulta. |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
Query latest at resource group level policy assignment scope |
Query latest at resource group level policy assignment scope with next link |
Query latest at resource group level policy assignment scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/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/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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": null,
"policyAssignmentVersion": "1.0.0"
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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": null,
"policyAssignmentVersion": "1.0.0"
}
]
}
Query latest at resource group level policy assignment scope with next link
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/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/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
]
}
]
}
Definições
Name | Description |
---|---|
Authorization |
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization". |
Component |
Detalhes do estado do componente. |
Error |
Definição de erro. |
Expression |
Detalhes de avaliação das expressões de linguagem de política. |
If |
Detalhes da avaliação do efeito IfNotExists. |
Policy |
Detalhes da avaliação da política. |
Policy |
Registo de estado da política. |
Policy |
Resultados da consulta. |
Policy |
O recurso virtual em PolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes, enquanto "predefinição" representa todos os estados da política. |
Query |
Resposta de erro. |
AuthorizationNamespaceType
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization".
Name | Tipo | Description |
---|---|---|
Microsoft.Authorization |
string |
ComponentStateDetails
Detalhes do estado do componente.
Name | Tipo | Description |
---|---|---|
complianceState |
string |
Estado de conformidade do componente. |
id |
string |
ID do componente. |
name |
string |
Nome do componente. |
timestamp |
string |
Carimbo de data/hora da avaliação de conformidade do componente. |
type |
string |
Tipo de componente. |
Error
Definição de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro específico do serviço que serve como subestado para o código de erro HTTP. |
message |
string |
Descrição do erro. |
ExpressionEvaluationDetails
Detalhes de avaliação das expressões de linguagem de política.
Name | Tipo | Description |
---|---|---|
expression |
string |
Expressão avaliada. |
expressionKind |
string |
O tipo de expressão que foi avaliada. |
expressionValue |
object |
Valor da expressão. |
operator |
string |
Operador para comparar o valor da expressão e o valor de destino. |
path |
string |
Caminho da propriedade se a expressão for um campo ou um alias. |
result |
string |
Resultado da avaliação. |
targetValue |
object |
Valor de destino a ser comparado com o valor da expressão. |
IfNotExistsEvaluationDetails
Detalhes da avaliação do efeito IfNotExists.
Name | Tipo | Description |
---|---|---|
resourceId |
string |
ID do último recurso avaliado para o efeito IfNotExists. |
totalResources |
integer |
Número total de recursos a que a condição de existência é aplicável. |
PolicyEvaluationDetails
Detalhes da avaliação da política.
Name | Tipo | Description |
---|---|---|
evaluatedExpressions |
Detalhes das expressões avaliadas. |
|
ifNotExistsDetails |
Detalhes da avaliação do efeito IfNotExists. |
PolicyState
Registo de estado da política.
Name | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados. |
@odata.id |
string |
ID da entidade OData; sempre definido como nulo, uma vez que os registos de estado de política não têm um ID de entidade. |
complianceState |
string |
Estado de conformidade do recurso. |
components |
Os registos de conformidade de estado dos componentes são preenchidos apenas quando o URL contém a cláusula $expand=components. |
|
effectiveParameters |
string |
Parâmetros eficazes para a atribuição de política. |
isCompliant |
boolean |
Sinalizador que indica se o recurso está em conformidade com a atribuição de política em que foi avaliado. Esta propriedade foi preterida; em alternativa, utilize ComplianceState. |
managementGroupIds |
string |
Lista separada por vírgulas de IDs de grupo de gestão, que representam a hierarquia dos grupos de gestão em que o recurso se encontra. |
policyAssignmentId |
string |
ID de atribuição de política. |
policyAssignmentName |
string |
Nome da atribuição de política. |
policyAssignmentOwner |
string |
Proprietário da atribuição de política. |
policyAssignmentParameters |
string |
Parâmetros de atribuição de políticas. |
policyAssignmentScope |
string |
Âmbito de atribuição de políticas. |
policyAssignmentVersion |
string |
Versão de atribuição de política avaliada. |
policyDefinitionAction |
string |
Ação de definição de política, ou seja, efeito. |
policyDefinitionCategory |
string |
Categoria de definição de política. |
policyDefinitionGroupNames |
string[] |
Nomes de grupos de definição de política. |
policyDefinitionId |
string |
ID de definição de política. |
policyDefinitionName |
string |
Nome da definição de política. |
policyDefinitionReferenceId |
string |
ID de referência para a definição de política dentro do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policyDefinitionVersion |
string |
Versão de definição de política avaliada. |
policyEvaluationDetails |
Detalhes da avaliação da política. |
|
policySetDefinitionCategory |
string |
Categoria de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionId |
string |
ID de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionName |
string |
Nome da definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionOwner |
string |
Proprietário da definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionParameters |
string |
Parâmetros de definição de conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionVersion |
string |
Versão de definição do conjunto de políticas avaliada. |
resourceGroup |
string |
Nome do grupo de recursos. |
resourceId |
string |
ID do Recurso. |
resourceLocation |
string |
Localização do recurso. |
resourceTags |
string |
Lista de etiquetas de recursos. |
resourceType |
string |
Tipo de recurso. |
subscriptionId |
string |
ID da Subscrição. |
timestamp |
string |
Carimbo de data/hora do registo de estado da política. |
PolicyStatesQueryResults
Resultados da consulta.
Name | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados. |
@odata.count |
integer |
Contagem de entidades OData; representa o número de registos de estado de política devolvidos. |
@odata.nextLink |
string |
Ligação seguinte de Odata; URL para obter o próximo conjunto de resultados. |
value |
Resultados da consulta. |
PolicyStatesResource
O recurso virtual em PolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes, enquanto "predefinição" representa todos os estados da política.
Name | Tipo | Description |
---|---|---|
default |
string |
|
latest |
string |
QueryFailure
Resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
Definição de erro. |