Policy States - List Query Results For Subscription Level Policy Assignment
Consulta los estados de directiva para la asignación de directiva de nivel de suscripción.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/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 de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
authorization
|
path | True |
Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization". |
|
policy
|
path | True |
string |
Nombre de asignación de directiva. |
policy
|
path | True |
Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva. |
|
subscription
|
path | True |
string |
Identificador de suscripción de Microsoft Azure. |
api-version
|
query | True |
string |
Versión de api de cliente. |
$apply
|
query |
string |
OData aplica expresión para agregaciones. |
|
$filter
|
query |
string |
Expresión de filtro de OData. |
|
$from
|
query |
string date-time |
Marca de tiempo con formato ISO 8601 que especifica la hora de inicio del intervalo que se va a consultar. Cuando no se especifica, el servicio usa ($to - 1 día). |
|
$orderby
|
query |
string |
Expresión de ordenación mediante notación de OData. Uno o varios nombres de columna separados por comas con un "desc" opcional (el valor predeterminado) o "asc", por ejemplo, "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Seleccione la expresión mediante la notación OData. Limita las columnas de cada registro solo a las solicitadas, por ejemplo, "$select=PolicyAssignmentId, ResourceId". |
|
$skiptoken
|
query |
string |
Skiptoken solo se proporciona si una respuesta anterior devolvió un resultado parcial como parte del elemento nextLink. |
|
$to
|
query |
string date-time |
Marca de tiempo con formato ISO 8601 que especifica la hora de finalización del intervalo que se va a consultar. Cuando no se especifica, el servicio usa el tiempo de solicitud. |
|
$top
|
query |
integer int32 |
Número máximo de registros que se van a devolver. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Resultados de la consulta. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Query latest at subscription level policy assignment scope |
Query latest at subscription level policy assignment scope with next link |
Query latest at subscription level policy assignment scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:45:19Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Network/publicIPAddresses",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": "2124621540977569058",
"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/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:45:19Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Network/publicIPAddresses",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}",
"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/12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": "14799174781370023846",
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": "2.0.1",
"policyAssignmentVersion": "1.0.0"
}
]
}
Query latest at subscription level policy assignment scope with next link
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:45:19Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Network/publicIPAddresses",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
"policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": "2124621540977569058",
"complianceState": "NonCompliant",
"policyDefinitionGroupNames": [
"myGroup"
]
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:45:19Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Network/publicIPAddresses",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}",
"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/12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697",
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": "14799174781370023846",
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
]
}
]
}
Definiciones
Nombre | Description |
---|---|
Authorization |
Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization". |
Component |
Detalles del estado del componente. |
Error |
Definición de error. |
Expression |
Detalles de evaluación de expresiones de lenguaje de directiva. |
If |
Detalles de evaluación del efecto IfNotExists. |
Policy |
Detalles de evaluación de directivas. |
Policy |
Registro de estado de la directiva. |
Policy |
Resultados de la consulta. |
Policy |
Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva. |
Query |
Respuesta de error. |
AuthorizationNamespaceType
Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization".
Nombre | Tipo | Description |
---|---|---|
Microsoft.Authorization |
string |
ComponentStateDetails
Detalles del estado del componente.
Nombre | Tipo | Description |
---|---|---|
complianceState |
string |
Estado de cumplimiento de componentes. |
id |
string |
Id. de componente. |
name |
string |
component_name |
timestamp |
string |
Marca de tiempo de evaluación de cumplimiento de componentes. |
type |
string |
Tipo de componente. |
Error
Definición de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error específico del servicio que actúa como subestado para el código de error HTTP. |
message |
string |
Descripción del error. |
ExpressionEvaluationDetails
Detalles de evaluación de expresiones de lenguaje de directiva.
Nombre | Tipo | Description |
---|---|---|
expression |
string |
Expresión evaluada. |
expressionKind |
string |
Tipo de expresión que se evaluó. |
expressionValue |
object |
Valor de la expresión. |
operator |
string |
Operador para comparar el valor de expresión y el valor de destino. |
path |
string |
Ruta de acceso de propiedad si la expresión es un campo o un alias. |
result |
string |
Resultado de la evaluación. |
targetValue |
object |
Valor de destino que se va a comparar con el valor de expresión. |
IfNotExistsEvaluationDetails
Detalles de evaluación del efecto IfNotExists.
Nombre | Tipo | Description |
---|---|---|
resourceId |
string |
Identificador del último recurso evaluado para el efecto IfNotExists. |
totalResources |
integer |
Número total de recursos a los que se aplica la condición de existencia. |
PolicyEvaluationDetails
Detalles de evaluación de directivas.
Nombre | Tipo | Description |
---|---|---|
evaluatedExpressions |
Detalles de las expresiones evaluadas. |
|
ifNotExistsDetails |
Detalles de evaluación del efecto IfNotExists. |
PolicyState
Registro de estado de la directiva.
Nombre | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadena de contexto de OData; usado por los clientes de OData para resolver la información de tipos en función de los metadatos. |
@odata.id |
string |
Identificador de entidad de OData; siempre se establece en NULL, ya que los registros de estado de la directiva no tienen un identificador de entidad. |
complianceState |
string |
Estado de cumplimiento del recurso. |
components |
Los registros de cumplimiento de estado de los componentes se rellenan solo cuando la dirección URL contiene $expand=cláusula components. |
|
effectiveParameters |
string |
Parámetros efectivos para la asignación de directivas. |
isCompliant |
boolean |
Marca que indica si el recurso es compatible con la asignación de directiva con la que se evaluó. Esta propiedad está en desuso; Use ComplianceState en su lugar. |
managementGroupIds |
string |
Lista separada por comas de identificadores de grupo de administración, que representan la jerarquía de los grupos de administración en los que se encuentra el recurso. |
policyAssignmentId |
string |
Id. de asignación de directiva. |
policyAssignmentName |
string |
Nombre de asignación de directiva. |
policyAssignmentOwner |
string |
Propietario de la asignación de directiva. |
policyAssignmentParameters |
string |
Parámetros de asignación de directivas. |
policyAssignmentScope |
string |
Ámbito de asignación de directiva. |
policyAssignmentVersion |
string |
Versión de asignación de directiva evaluada. |
policyDefinitionAction |
string |
Acción de definición de directiva, es decir, efecto. |
policyDefinitionCategory |
string |
Categoría de definición de directiva. |
policyDefinitionGroupNames |
string[] |
Nombres de grupo de definición de directiva. |
policyDefinitionId |
string |
Identificador de definición de directiva. |
policyDefinitionName |
string |
Nombre de definición de directiva. |
policyDefinitionReferenceId |
string |
Identificador de referencia para la definición de directiva dentro del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policyDefinitionVersion |
string |
Versión de definición de directiva evaluada. |
policyEvaluationDetails |
Detalles de evaluación de directivas. |
|
policySetDefinitionCategory |
string |
Categoría de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policySetDefinitionId |
string |
Identificador de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policySetDefinitionName |
string |
Nombre de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policySetDefinitionOwner |
string |
Propietario de la definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policySetDefinitionParameters |
string |
Parámetros de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas. |
policySetDefinitionVersion |
string |
Versión de definición del conjunto de directivas evaluada. |
resourceGroup |
string |
Nombre del grupo de recursos. |
resourceId |
string |
Identificador del recurso. |
resourceLocation |
string |
Ubicación del recurso |
resourceTags |
string |
Lista de etiquetas de recursos. |
resourceType |
string |
Tipo de recurso. |
subscriptionId |
string |
Id. de suscripción. |
timestamp |
string |
Marca de tiempo para el registro de estado de la directiva. |
PolicyStatesQueryResults
Resultados de la consulta.
Nombre | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadena de contexto de OData; usado por los clientes de OData para resolver la información de tipos en función de los metadatos. |
@odata.count |
integer |
Recuento de entidades de OData; representa el número de registros de estado de directiva devueltos. |
@odata.nextLink |
string |
Vínculo siguiente de Odata; Dirección URL para obtener el siguiente conjunto de resultados. |
value |
Resultados de la consulta. |
PolicyStatesResource
Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva.
Nombre | Tipo | Description |
---|---|---|
default |
string |
|
latest |
string |
QueryFailure
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Definición de error. |