Policy Assignments - Get

Referência

Serviço:: Policy

Versão da API:: 2023-04-01

Recupera uma atribuição de política.
Essa operação recupera uma única atribuição de política, dado seu nome e o escopo em que foi criada.

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

Com parâmetros opcionais:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?$expand={$expand}&api-version=2023-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policyAssignmentName	path	True	string	O nome da atribuição de política a ser obtido. Padrão Regex: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
scope	path	True	string	O escopo da atribuição de política. Os escopos válidos são: grupo de gerenciamento (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), assinatura (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', ou recurso (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	A versão da API a ser usada para esta operação.
$expand	query		string	Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta. Os valores com suporte são 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

Respostas

Nome	Tipo	Description
200 OK	PolicyAssignment	OK - Retorna informações sobre a atribuição de política.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Retrieve a policy assignment

Retrieve a policy assignment with a system assigned identity

Retrieve a policy assignment with a user assigned identity

Retrieve a policy assignment with overrides

Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a system assigned identity

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a user assigned identity

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with overrides

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Retrieve a policy assignment with resource selectors

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Definições

Nome	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 da atribuição de política. Os valores possíveis são Default e DoNotEnforce.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso. As atribuições de política dão suporte a no máximo uma identidade. Essa é uma identidade atribuída pelo sistema ou uma única identidade atribuída pelo usuário.
NonComplianceMessage	Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro 'deny' e nos resultados de conformidade não compatíveis 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.
ResourceIdentityType	O tipo de identidade. Esse é o único campo necessário ao adicionar uma identidade atribuída pelo sistema ou ao usuário a um recurso.
ResourceSelector	O seletor de recursos para filtrar políticas por propriedades de recurso.
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 do usuário associada à política. As referências de chave do dicionário de identidade do usuário serão IDs de recurso 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.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

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

Nome	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

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorResponse

Resposta de erro

Nome	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 dão suporte a no máximo uma identidade. Essa é uma identidade atribuída pelo sistema ou uma única identidade atribuída pelo usuário.

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

NonComplianceMessage

Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro 'deny' e nos resultados de conformidade não compatíveis do recurso.

Nome	Tipo	Description
message	string	Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro 'deny' e nos resultados de conformidade não compatíveis do recurso.
policyDefinitionReferenceId	string	A 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. Isso só será aplicável se a atribuição de política atribuir uma definição de conjunto de políticas. Se isso não for fornecido, a mensagem se aplicará a todas as políticas atribuídas por essa atribuição de política.

Override

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

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

OverrideKind

O tipo de substituição.

Nome	Tipo	Description
policyEffect	string	Ele substituirá o tipo de efeito de política.

ParameterValuesValue

O valor de um parâmetro.

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