Policy Assignments - Get By Id
A operação obtém a atribuição de política com o ID especificado. Os IDs de atribuição de políticas têm este formato: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Os âmbitos válidos são: grupo de gestão (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscrição (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', ou recurso (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
GET https://management.azure.com/{policyAssignmentId}?api-version=2023-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
policy
|
path | True |
string |
O ID da atribuição de política a obter. Utilize o formato "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK - Devolve informações sobre a atribuição de política. |
|
Other Status Codes |
Resposta de erro que descreve o motivo 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
Retrieve a policy assignment by ID |
Retrieve a policy assignment with a managed identity by ID |
Retrieve a policy assignment by ID
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01
Sample Response
{
"properties": {
"displayName": "Enforce storage account SKU",
"description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
"metadata": {
"assignedBy": "Cheapskate Boss"
},
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"notScopes": [],
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
},
"enforcementMode": "Default"
},
"id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
"type": "Microsoft.Authorization/policyAssignments",
"name": "LowCostStorage"
}
Retrieve a policy assignment with a managed identity by ID
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01
Sample Response
{
"properties": {
"displayName": "Enforce storage account SKU",
"description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
"metadata": {
"assignedBy": "Cheapskate Boss"
},
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"notScopes": [],
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
},
"enforcementMode": "Default"
},
"identity": {
"type": "SystemAssigned",
"principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
"tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
},
"location": "westus",
"id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
"type": "Microsoft.Authorization/policyAssignments",
"name": "LowCostStorage"
}
Definições
Name | Description |
---|---|
Cloud |
Uma resposta de erro de uma operação de política. |
created |
O tipo de identidade que criou o recurso. |
enforcement |
O modo de imposição de atribuição de política. Os valores possíveis são Default e DoNotEnforce. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
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 uma única identidade atribuída pelo utilizador. |
Non |
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. |
Override |
O tipo de substituição. |
Parameter |
O valor de um parâmetro. |
Policy |
A atribuição de política. |
Resource |
O tipo de identidade. Este é o único campo necessário ao adicionar um sistema ou identidade atribuída pelo utilizador a um recurso. |
Resource |
O seletor de recursos para filtrar políticas por propriedades de recursos. |
Selector |
A expressão do seletor. |
Selector |
O tipo de seletor. |
system |
Metadados relativos à criação e última modificação do recurso. |
User |
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 |
Resposta a Erros |
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ítica. 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ções adicionais. |
ErrorResponse
Resposta a Erros
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
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 uma única identidade atribuída pelo utilizador.
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 de inquilino da identidade do recurso. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema |
type |
O tipo de identidade. Este é o único campo necessário ao adicionar um sistema ou identidade atribuída pelo utilizador a um 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}". |
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 da definição de política numa 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 |
O tipo de substituição. |
|
selectors |
Selector[] |
A lista das expressões do seletor. |
value |
string |
O valor a substituir a propriedade de política. |
OverrideKind
O tipo de substituição.
Name | Tipo | Description |
---|---|---|
policyEffect |
string |
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 . |
PolicyAssignment
A atribuição de política.
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
id |
string |
O ID da atribuição de política. |
|
identity |
A identidade gerida associada à atribuição de política. |
||
location |
string |
A localização da atribuição de política. Só é necessário ao utilizar a identidade gerida. |
|
name |
string |
O nome da atribuição de política. |
|
properties.description |
string |
Esta mensagem fará parte da resposta em caso de violação de política. |
|
properties.displayName |
string |
O nome a apresentar da atribuição de política. |
|
properties.enforcementMode | Default |
O modo de imposição de atribuição de política. Os valores possíveis são Default e DoNotEnforce. |
|
properties.metadata |
object |
Os metadados de atribuição de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave. |
|
properties.nonComplianceMessages |
As mensagens que descrevem o motivo pelo qual um recurso não está em conformidade com a política. |
||
properties.notScopes |
string[] |
Os âmbitos excluídos da política. |
|
properties.overrides |
Override[] |
A substituição do valor da propriedade da política. |
|
properties.parameters |
<string,
Parameter |
Os valores dos parâmetros da regra de política atribuída. As chaves são os nomes dos parâmetros. |
|
properties.policyDefinitionId |
string |
O ID da definição de política ou definição do conjunto de políticas que está a ser atribuída. |
|
properties.resourceSelectors |
A lista de seletores de recursos para filtrar políticas por propriedades de recursos. |
||
properties.scope |
string |
O âmbito da atribuição de política. |
|
systemData |
Os metadados do sistema relacionados com este recurso. |
||
type |
string |
O tipo de atribuição de política. |
ResourceIdentityType
O tipo de identidade. Este é o único campo necessário ao adicionar um sistema ou identidade atribuída pelo utilizador a um recurso.
Name | Tipo | Description |
---|---|---|
None |
string |
Indica que nenhuma identidade está associada ao recurso ou que a identidade existente deve ser removida. |
SystemAssigned |
string |
Indica que uma identidade atribuída pelo sistema está associada ao recurso. |
UserAssigned |
string |
Indica que uma identidade atribuída pelo sistema está associada ao recurso. |
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 |
O tipo de seletor. |
|
notIn |
string[] |
A lista de valores a filtrar. |
SelectorKind
O tipo de seletor.
Name | Tipo | Description |
---|---|---|
policyDefinitionReferenceId |
string |
O tipo de seletor para filtrar políticas pelo ID de referência da definição de política. |
resourceLocation |
string |
O tipo de seletor para filtrar políticas pela localização do recurso. |
resourceType |
string |
O tipo de seletor para filtrar políticas pelo tipo de recurso. |
resourceWithoutLocation |
string |
O tipo de seletor para filtrar políticas pelo recurso sem localização. |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
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}".
Name | Tipo | Description |
---|---|---|
|