Partilhar via


Policy Enrollments - List For Resource

Recupera todas as inscrições de apólices que se aplicam a um recurso.
Esta operação recupera a lista de todas as inscrições de políticas associadas ao recurso especificado no grupo de recursos e subscrição dados que correspondem à $filter opcional dada. Os valores válidos para $filter são: 'atScope()' ou 'atExactScope()'. Se $filter não for fornecida, a lista não filtrada inclui todas as inscrições de políticas associadas ao recurso, incluindo aquelas que se aplicam diretamente ou de todos os âmbimos que contêm, bem como quaisquer aplicadas a recursos contidos no recurso. Três parâmetros mais o nome do recurso são usados para identificar um recurso específico. Se o recurso não fizer parte de um recurso pai (o caso mais comum), o caminho do recurso pai não deve ser fornecido (ou fornecido como ''). Por exemplo, um aplicativo Web pode ser especificado como ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Se o recurso fizer parte de um recurso pai, todos os parâmetros devem ser fornecidos. Por exemplo, um nome DNS de máquina virtual pode ser especificado como ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Uma alternativa conveniente para fornecer o namespace e o nome do tipo separadamente é fornecer ambos no parâmetro {resourceType}, formato: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview&$filter={$filter}

Parâmetros do URI

Name Em Necessário Tipo Description
parentResourcePath
path True

string

O caminho do recurso pai. Use string vazia se não houver nenhuma.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName
path True

string

pattern: ^.+$

O nome do recurso.

resourceProviderNamespace
path True

string

O namespace do provedor de recursos. Por exemplo, o namespace de uma máquina virtual é Microsoft.Compute (de Microsoft.Compute/virtualMachines)

resourceType
path True

string

O nome do tipo de recurso. Por exemplo, o nome do tipo de um aplicativo Web é 'sites' (de Microsoft.Web/sites).

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

$filter
query

string

O filtro a ser aplicado na operação. Os valores válidos para $filter são: 'atScope()' ou 'atExactScope()'. Se $filter não for fornecida, nenhuma filtragem será executada. Se $filter não for fornecida, a lista não filtrada inclui todas as inscrições de políticas associadas ao âmbito, incluindo aquelas que se aplicam diretamente ou a partir de âmbimos que contêm. Se for fornecido $filter=atScope(), a lista devolvida inclui todas as inscrições de políticas que se aplicam ao âmbito, que é tudo o que está na lista não filtrada, exceto aquelas aplicadas a sub-escopos contidos no âmbito dado. Se for fornecida $filter=atExactScope(), a lista devolvida inclui apenas todas as inscrições de políticas que se aplicam ao âmbito indicado.

Respostas

Name Tipo Description
200 OK

PolicyEnrollmentListResult

Operação do Azure concluída com sucesso.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

List policy enrollments for resource

Pedido de amostra

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/domainNames/MyTestComputer.cloudapp.net/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview

Resposta da amostra

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
        "policyDefinitionReferenceIds": [
          "Limit_Skus"
        ],
        "policyAssignmentInstanceId": "00000000-0000-0000-0000-000000000000",
        "displayName": "Enroll demo cluster",
        "description": "Enroll demo cluster from limit sku",
        "metadata": {
          "reason": "Enrollment for a expensive VM demo"
        }
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2020-07-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyEnrollments/DemoExpensiveVMGroup",
      "type": "Microsoft.Authorization/policyEnrollments",
      "eTag": "00000000-0000-0000-0000-000000000000",
      "name": "DemoExpensiveVMGroup"
    },
    {
      "properties": {
        "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/LimitPorts",
        "policyAssignmentInstanceId": "00000000-0000-0000-0000-000000000000",
        "displayName": "Enroll jump box open ports",
        "description": "Enroll jump box open ports from limit ports policy",
        "metadata": {
          "reason": "Need to open RDP port to corp net"
        }
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2020-07-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/providers/Microsoft.Authorization/policyEnrollments/jumpBoxEnrollment",
      "type": "Microsoft.Authorization/policyEnrollments",
      "eTag": "00000000-0000-0000-0000-000000000000",
      "name": "jumpBoxEnrollment"
    }
  ]
}

Definições

Name Description
AssignmentScopeValidation

A opção de validar se a isenção ou inscrição está dentro ou dentro do âmbito da atribuição.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

PolicyEnrollment

A inscrição na apólice.

PolicyEnrollmentListResult

A resposta de uma operação de lista de Inscrição em Políticas.

ResourceSelector

O seletor de recursos para filtrar políticas por propriedades de recursos.

Selector

A expressão do seletor.

SelectorKind

O tipo seletor.

systemData

Metadados referentes à criação e última modificação do recurso.

AssignmentScopeValidation

A opção de validar se a isenção ou inscrição está dentro ou dentro do âmbito da atribuição.

Valor Description
Default

Esta opção validará que a isenção está no âmbito ou sob o âmbito da atribuição.

DoNotValidate

Essa opção ignorará a validação em que o escopo da isenção está no escopo de atribuição de política ou sob ele.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O alvo do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

PolicyEnrollment

A inscrição na apólice.

Name Tipo Description
eTag

string

O ETag para a inscrição da apólice.

id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties.assignmentScopeValidation

AssignmentScopeValidation

A opção de validar a inscrição está dentro ou dentro do âmbito da tarefa.

properties.description

string

A descrição da inscrição na apólice.

properties.displayName

string

O nome de exibição da apólice de inscrição.

properties.metadata

Os metadados de inscrição na política. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave.

properties.policyAssignmentId

string (arm-id)

O ID da atribuição de apólices que está a ser inscrita.

properties.policyAssignmentInstanceId

string (uuid)

O ID da instância de atribuição de políticas associado a esta inscrição. O valor é definido para o ID de instância da atribuição de política que o policyAssignmentId refere quando a inscrição é criada ou atualizada. O formato é uma cadeia GUID.

properties.policyDefinitionReferenceIds

string[]

Os IDs de referência da definição de política para definições de políticas numa definição de conjunto de políticas atribuída. Estes IDs correspondem a um subconjunto de policyDefinitions[*].policyDefinitionReferenceId na definição do conjunto de políticas. Quando especificados e não vazios, apenas as definições de apólices referenciadas serão inscritas. Caso contrário, todo o conjunto de políticas é inscrito em

properties.resourceSelectors

ResourceSelector[]

A lista de seletores de recursos para filtrar políticas por propriedades de recursos.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PolicyEnrollmentListResult

A resposta de uma operação de lista de Inscrição em Políticas.

Name Tipo Description
nextLink

string (uri)

O link para a próxima página de itens

value

PolicyEnrollment[]

Os itens de Inscrição em Política nesta página

ResourceSelector

O seletor de recursos para filtrar políticas por propriedades de recursos.

Name Tipo Description
name

string

O nome do seletor de recursos.

selectors

Selector[]

A lista das expressões do seletor.

Selector

A expressão do seletor.

Name Tipo Description
in

string[]

A lista de valores a filtrar.

kind

SelectorKind

O tipo seletor.

notIn

string[]

A lista de valores a filtrar.

SelectorKind

O tipo seletor.

Valor Description
resourceLocation

O tipo de seletor para filtrar políticas pelo local do recurso.

resourceType

O tipo de seletor para filtrar políticas pelo tipo de recurso.

resourceWithoutLocation

O tipo de seletor para filtrar políticas pelo recurso sem localização.

policyDefinitionReferenceId

O tipo de seletor para filtrar políticas pela ID de referência de definição de política.

userPrincipalId

O seletor para filtrar políticas pelo ID do principal de utilizador.

groupPrincipalId

O seletor filtra políticas pelo ID de pertença ao grupo de segurança.

systemData

Metadados referentes à criação e última modificação do recurso.

Name Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.