Policy Assignments - List For Management Group

Referência

Service:: Policy

API Version:: 2023-04-01

Obtém todas as atribuições de política que se aplicam a um grupo de gestão.
Esta operação obtém a lista de todas as atribuições de política aplicáveis ao grupo de gestão que correspondem ao $filter especificado. Os valores válidos para $filter são: "atScope()", "atExactScope()" ou "policyDefinitionId eq '{value}'". Se $filter=atScope() for fornecida, a lista devolvida inclui todas as atribuições de política atribuídas ao grupo de gestão ou aos predecessores do grupo de gestão. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as atribuições de política que estejam no grupo de gestão. Se $filter=policyDefinitionId eq '{value}' for fornecido, a lista devolvida inclui todas as atribuições de política da definição de política cujo ID é {value} que se aplicam ao grupo de gestão.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$top={$top}&api-version=2023-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
managementGroupId	path	True	string	O ID do grupo de gestão.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$filter	query		string	O filtro a aplicar na operação. Os valores válidos para $filter são: "atScope()", "atExactScope()" ou "policyDefinitionId eq '{value}'". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se $filter=atScope() for fornecido, a lista devolvida inclui apenas todas as atribuições de política que se aplicam ao âmbito, que é tudo na lista não filtrada, exceto as aplicadas a sub-âmbitos contidos no âmbito especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as atribuições de política que estejam no âmbito especificado. Se $filter=policyDefinitionId eq '{value}' for fornecido, a lista devolvida inclui todas as atribuições de política da definição de política cujo ID é {value}.
$top	query		integer int32	Número máximo de registos a devolver. Quando o filtro $top não for fornecido, irá devolver 500 registos.

Respostas

Name	Tipo	Description
200 OK	PolicyAssignmentListResult	OK - Devolve uma matriz de atribuições de políticas.
Other Status Codes	CloudError	Resposta de erro que descreve a razão 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

List policy assignments that apply to a management group

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestCostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup",
        "notScopes": []
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestTagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup",
        "notScopes": []
      }
    }
  ]
}

Definições

Name	Description
CloudError	Uma resposta de erro de uma operação de política.
createdByType	O tipo de identidade que criou o recurso.
enforcementMode	O modo de imposição de atribuição de políticas. Os valores possíveis são Default e DoNotEnforce.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
Identity	Identidade do recurso. As atribuições de política suportam um máximo de uma identidade. Trata-se de uma identidade atribuída pelo sistema ou de um único utilizador atribuído.
NonComplianceMessage	Uma mensagem que descreve o motivo pelo qual um recurso não está em conformidade com a política. Isto é mostrado nas mensagens de erro "negar" e nos resultados de conformidade não conformes do recurso.
Override	A substituição do valor da propriedade da política.
OverrideKind	O tipo de substituição.
ParameterValuesValue	O valor de um parâmetro.
PolicyAssignment	A atribuição de política.
PolicyAssignmentListResult	Lista de atribuições de políticas.
ResourceIdentityType	O tipo de identidade. Este é o único campo necessário ao adicionar um sistema ou identidade atribuída pelo utilizador a um recurso.
ResourceSelector	O seletor de recursos para filtrar políticas por propriedades de recursos.
Selector	A expressão do seletor.
SelectorKind	O tipo de seletor.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentities	A identidade de utilizador associada à política. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Uma resposta de erro de uma operação de política.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

O modo de imposição de atribuição de políticas. Os valores possíveis são Default e DoNotEnforce.

Name	Tipo	Description
Default	string	O efeito da política é imposto durante a criação ou atualização de recursos.
DoNotEnforce	string	O efeito de política não é imposto durante a criação ou atualização de recursos.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

Identity

Identidade do recurso. As atribuições de política suportam um máximo de uma identidade. Trata-se de uma identidade atribuída pelo sistema ou de um único utilizador atribuído.

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema
tenantId	string	O ID do inquilino da identidade do recurso. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema
type	ResourceIdentityType	O tipo de identidade. Este é o único campo necessário ao adicionar um sistema ou identidade atribuída pelo utilizador a um recurso.
userAssignedIdentities	UserAssignedIdentities	A identidade de utilizador associada à política. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Uma mensagem que descreve o motivo pelo qual um recurso não está em conformidade com a política. Isto é mostrado nas mensagens de erro "negar" e nos resultados de conformidade não conformes do recurso.

Name	Tipo	Description
message	string	Uma mensagem que descreve o motivo pelo qual um recurso não está em conformidade com a política. Isto é mostrado nas mensagens de erro "negar" e nos resultados de conformidade não conformes do recurso.
policyDefinitionReferenceId	string	O ID de referência de definição de política dentro de uma definição de conjunto de políticas para a qual a mensagem se destina. Isto só é aplicável se a atribuição de política atribuir uma definição de conjunto de políticas. Se não for fornecida, a mensagem aplica-se a todas as políticas atribuídas por esta atribuição de política.

Override

A substituição do valor da propriedade da política.

Name	Tipo	Description
kind	OverrideKind	O tipo de substituição.
selectors	Selector[]	A lista das expressões do seletor.
value	string	O valor para substituir a propriedade de política.

OverrideKind

O tipo de substituição.

Name	Tipo	Description
policyEffect	string	Irá substituir o tipo de efeito de política.

ParameterValuesValue

O valor de um parâmetro.

Name	Tipo	Description
value	object	O valor do parâmetro.