Get-AzPolicyState

  • Referência
Módulo:
Az.PolicyInsights

Obtém estados de conformidade de política para recursos.

Syntax

Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   -ManagementGroupName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   -ResourceGroupName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   -ResourceId <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-Expand <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   -PolicySetDefinitionName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   -PolicyDefinitionName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   -PolicyAssignmentName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyState
   [-All]
   [-SubscriptionId <String>]
   -ResourceGroupName <String>
   -PolicyAssignmentName <String>
   [-Top <Int32>]
   [-OrderBy <String>]
   [-Select <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Filter <String>]
   [-Apply <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Obtém estados de conformidade de política para recursos. Os registros de estado da política podem ser consultados em vários escopos. Com base no intervalo de tempo especificado (os padrões são até o último dia), os estados de diretiva mais recentes ou todas as transições de estado de diretiva podem ser consultados. Os resultados podem ser filtrados, agrupados e as agregações de grupo podem ser computadas.

Exemplos

Exemplo 1: Obter os estados de política mais recentes no escopo de assinatura atual

Get-AzPolicyState

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual.

Exemplo 2: Obter os estados de política mais recentes no escopo de assinatura especificado

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura especificada.

Exemplo 3: Obter todos os estados de política no escopo de assinatura atual

Get-AzPolicyState -All

Obtém todos os registros de estado de política histórica (incluindo os mais recentes) gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual.

Exemplo 4: Obter os estados de política mais recentes no escopo do grupo de gerenciamento

Get-AzPolicyState -ManagementGroupName "myManagementGroup"

Obtém os registros de estado de diretiva mais recentes gerados no último dia para todos os recursos dentro do grupo de gerenciamento especificado.

Exemplo 5: Obter os estados de política mais recentes no escopo do grupo de recursos na assinatura atual

Get-AzPolicyState -ResourceGroupName "myResourceGroup"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro do grupo de recursos especificado (na assinatura no contexto da sessão atual).

Exemplo 6: Obter os estados de política mais recentes no escopo do grupo de recursos na assinatura especificada

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup"

Obtém os registros de estado de diretiva mais recentes gerados no último dia para todos os recursos dentro do grupo de recursos especificado (na assinatura especificada).

Exemplo 7: Obter os estados de política mais recentes para um recurso

Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1"

Obtém os registros de estado de política mais recentes gerados no último dia para o recurso especificado.

Exemplo 8: Obter os estados de política mais recentes para uma definição de conjunto de políticas na assinatura atual

Get-AzPolicyState -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto de sessão atual) afetados pela definição de conjunto de políticas especificada (que existe na assinatura no contexto de sessão atual).

Exemplo 9: Obter os estados de política mais recentes para uma definição de conjunto de políticas na assinatura especificada

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto da sessão atual) afetados pela definição do conjunto de políticas especificado (que existe na assinatura especificada).

Exemplo 10: Obter os estados de política mais recentes para uma definição de política na assinatura atual

Get-AzPolicyState -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto de sessão atual) afetados pela definição de política especificada (que existe na assinatura no contexto de sessão atual).

Exemplo 11: Obter os estados de política mais recentes para uma definição de política na assinatura especificada

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto de sessão atual) afetados pela definição de política especificada (que existe na assinatura especificada).

Exemplo 12: Obter os estados de política mais recentes para uma atribuição de política na assinatura atual

Get-AzPolicyState -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto da sessão atual) afetados pela atribuição de política especificada (que existe no escopo da assinatura no contexto da assinatura no contexto da sessão atual).

Exemplo 13: Obter os estados de política mais recentes para uma atribuição de política com o mesmo escopo da assinatura especificada

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto da sessão atual) afetados pela atribuição de política especificada (que existe no escopo da assinatura na assinatura especificada).

Exemplo 14: Obter os estados de política mais recentes para uma atribuição de política no grupo de recursos especificado na assinatura atual

Get-AzPolicyState -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto da sessão atual) afetados pela atribuição de política especificada (que existe no grupo de recursos na assinatura no contexto da sessão atual).

Exemplo 15: Obter os estados de política mais recentes no escopo de assinatura atual, com as opções de consulta OrderBy, Top e Select

Get-AzPolicyState -OrderBy "Timestamp desc, PolicyAssignmentName asc" -Top 5 -Select "Timestamp, ResourceId, PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, IsCompliant"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando ordena os resultados por propriedades de carimbo de data/hora e nome de atribuição de política e obtém apenas os 5 primeiros colocados listados nessa ordem. Ele também seleciona para listar apenas um subconjunto das colunas para cada registro.

Exemplo 16: Obter os estados de política mais recentes no escopo de assinatura atual, com as opções de consulta De e Para

Get-AzPolicyState -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z"

Obtém os registros de estado de política mais recentes gerados dentro do intervalo de datas especificado para todos os recursos dentro da assinatura no contexto de sessão atual.

Exemplo 17: Obter os estados de política mais recentes no escopo de assinatura atual, com a opção de consulta Filtrar

Get-AzPolicyState -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ComplianceState eq 'NonCompliant' and ResourceLocation ne 'eastus'"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando limita os resultados retornados filtrando com base na ação de definição de política (inclui ações de negação ou auditoria), status de conformidade (inclui apenas status não compatível) e localização do recurso (exclui o local eastus).

Exemplo 18: Obter os estados de política mais recentes no escopo de assinatura atual, com Aplicar especificando agregação de contagem de linhas

Get-AzPolicyState -Apply "aggregate(`$count as NumberOfRecords)"

Obtém o número de registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando retorna a contagem somente dos registros de estado da política, que é retornada dentro da propriedade AdditionalProperties.

Exemplo 19: Obter os estados de política mais recentes no escopo de assinatura atual, com Aplicar especificando agrupamento com agregação

Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumStates))" -OrderBy "NumStates desc" -Top 5

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando limita os resultados retornados pela filtragem com base no status de conformidade (inclui apenas o status de não conformidade). Ele agrupa os resultados com base na atribuição de diretiva, na definição do conjunto de políticas e na definição da política e calcula o número de registros em cada grupo, que é retornado dentro da propriedade AdditionalProperties. Ele ordena os resultados pela agregação de contagem em ordem decrescente e pega apenas os 5 primeiros dos listados nessa ordem.

Exemplo 20: Obter os estados de política mais recentes no escopo de assinatura atual, com Aplicar especificando agrupamento sem agregação

Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((ResourceId))"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando limita os resultados retornados pela filtragem com base no status de conformidade (inclui apenas o status de não conformidade). Ele agrupa os resultados com base na id do recurso. Isso gera a lista de todos os recursos dentro da assinatura que não são compatíveis para pelo menos uma política.

Exemplo 21: Obter os estados de política mais recentes no escopo de assinatura atual, com Aplicar especificando vários agrupamentos

Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumNonCompliantResources))" -OrderBy "NumNonCompliantResources desc" -Top 5

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos dentro da assinatura no contexto de sessão atual. O comando limita os resultados retornados pela filtragem com base no status de conformidade (inclui apenas o status de não conformidade). Ele agrupa os resultados primeiro com base na atribuição de diretiva, definição de conjunto de políticas, definição de política e ID de recurso. Em seguida, ele agrupa ainda mais os resultados desse agrupamento com as mesmas propriedades, exceto a id do recurso, e calcula o número de registros em cada um desses grupos, que é retornado dentro da propriedade AdditionalProperties. Ele ordena os resultados pela agregação de contagem em ordem decrescente e pega apenas os 5 primeiros dos listados nessa ordem. Isso gera as 5 principais políticas com o maior número de recursos não compatíveis.

Exemplo 22: Obter os estados de política mais recentes, incluindo detalhes de avaliação de política para um recurso

Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" -Expand "PolicyEvaluationDetails"

Obtém os registros de estado de política mais recentes gerados no último dia para o recurso especificado e expande policyEvaluationDetails.

Exemplo 23: Obter os estados de política de componente mais recentes para um recurso (por exemplo, cofre) dada uma atribuição de política de modo de provedor de recursos

Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant')"

Obtém os registros de estado de diretiva de componente mais recentes gerados no último dia para o recurso especificado, dada uma atribuição de diretiva de modo de provedor de recursos que faz referência a uma definição de diretiva de modo de provedor de recursos.

Exemplo 24: Obter os estados de política de componente mais recentes para um recurso (por exemplo, cofre) dada uma atribuição de iniciativa de política que contém uma definição de política de modo de provedor de recursos

Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1' and policyDefinitionReferenceId eq 'myResourceProviderModeDefinitionReferenceId'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant')"

Obtém os registros de estado de diretiva de componente mais recentes gerados no último dia para o recurso especificado, dada uma atribuição de diretiva de modo de provedor de recursos que faz referência a uma iniciativa que contém uma definição de política de modo de provedor de recursos.

Exemplo 25: Obter as contagens de componentes mais recentes por estado de conformidade para um recurso (por exemplo, cofre) dada uma atribuição de política de modo de provedor de recursos

Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant' or ComplianceState eq 'Conflict';`$apply=groupby((complianceState),aggregate(`$count as count)))"

Obtém as contagens de componentes mais recentes geradas no último dia agrupadas por estado de conformidade para o recurso especificado, dada uma atribuição de diretiva de modo de provedor de recursos.

Exemplo 26: Obter estados de política para uma atribuição de diretiva de escopo de grupo de gerenciamento

Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -Filter "policyAssignmentId eq '/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'"

Obtém os registros de estado de política mais recentes gerados no último dia para todos os recursos (dentro do locatário no contexto de sessão atual) na assinatura especificada afetada pela atribuição de política especificada (que é atribuída a um grupo de gerenciamento que é um ancestral da assinatura especificada).

Parâmetros

-All

Dentro do intervalo de tempo especificado, obtenha todos os estados de diretiva em vez do mais recente apenas.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Apply

Aplicar expressão para agregações usando a notação OData.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

Expanda a expressão usando a notação OData.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Expressão de filtro usando notação OData.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-From

Carimbo de data/hora formatado ISO 8601 especificando a hora de início do intervalo para consulta. Quando não especificado, o padrão é o valor do parâmetro 'Para' menos 1 dia.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagementGroupName

Nome do grupo de gerenciamento.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OrderBy

Ordenando a expressão usando a notação OData. Um ou mais nomes de coluna separados por vírgulas com um opcional 'desc' (o padrão) ou 'asc'.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PolicyAssignmentName

O nome de uma atribuição de política. Essa atribuição de política deve ter exatamente o mesmo escopo que o conjunto de parâmetros. Não pode ser uma atribuição de diretiva de escopo de grupo de gerenciamento. Por exemplo: se -SubscriptionId e ResourceGroupName forem especificados, a atribuição de política deve ser atribuída a esse grupo de recursos. Se apenas -SubscriptionId for especificado, a atribuição de política deverá ser atribuída a essa assinatura.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PolicyDefinitionName

O nome de uma definição de política. Essa definição de política deve existir na assinatura que está sendo consultada. Não pode ser uma definição de diretiva de escopo de grupo de gerenciamento.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PolicySetDefinitionName

O nome de uma definição de conjunto de políticas. Essa definição de conjunto de políticas deve existir na assinatura que está sendo consultada. Não pode ser uma definição de conjunto de diretivas de escopo de grupo de gerenciamento.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Nome do grupo de recursos.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

ID do recurso.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Select

Selecione a expressão usando a notação OData. Um ou mais nomes de coluna separados por vírgula. Limita as colunas em cada registro apenas às solicitadas.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

ID da assinatura.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-To

Carimbo de data/hora formatado ISO 8601 especificando a hora de término do intervalo a ser consultado. Quando não especificado, o padrão é o tempo de solicitação.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

Número máximo de registros a serem retornados.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Saídas

PolicyState