Policy Restrictions - Check At Subscription Scope

Başvuru

Service:: Policy

API Version:: 2023-03-01

Azure İlkesi abonelik içindeki bir kaynağa hangi kısıtlamaların uygulanacağını denetler.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
resourceDetails	True	CheckRestrictionsResourceDetails	Değerlendirilecek kaynak hakkındaki bilgiler.
includeAuditEffect		boolean	Sonuçlara 'denetim' etkisi olan ilkelerin eklenip eklenmeyeceği. Varsayılan değer false şeklindedir.
pendingFields		PendingField[]	Olası kısıtlamalar için değerlendirilmesi gereken alanların ve değerlerin listesi.

Yanıtlar

Name	Tür	Description
200 OK	CheckRestrictionsResult	Azure İlkesi tarafından kaynağa yerleştirilecek kısıtlamalar.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Check policy restrictions at subscription scope

Check policy restrictions at subscription scope including audit effect

Check policy restrictions at subscription scope

Sample Request

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

{
  "resourceDetails": {
    "resourceContent": {
      "type": "Microsoft.Compute/virtualMachines",
      "properties": {
        "priority": "Spot"
      }
    },
    "apiVersion": "2019-12-01"
  },
  "pendingFields": [
    {
      "field": "name",
      "values": [
        "myVMName"
      ]
    },
    {
      "field": "location",
      "values": [
        "eastus",
        "westus",
        "westus2",
        "westeurope"
      ]
    },
    {
      "field": "tags"
    }
  ]
}

Sample Response

Status code:: 200

{
  "fieldRestrictions": [
    {
      "field": "tags.newtag",
      "restrictions": [
        {
          "result": "Required",
          "defaultValue": "defaultVal",
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "tags.newtag is required"
        }
      ]
    },
    {
      "field": "tags.environment",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Prod",
            "Int",
            "Test"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "tags.environment is required"
        }
      ]
    },
    {
      "field": "location",
      "restrictions": [
        {
          "result": "Deny",
          "values": [
            "west europe"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "location must be one of the following: eastus, westus, westus2"
        },
        {
          "result": "Deny",
          "values": [
            "eastus",
            "westus"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "location must be one of the following: westus2"
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": [
      {
        "policyInfo": {
          "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
          "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
          "policyDefinitionReferenceId": "defref222",
          "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
        },
        "evaluationResult": "NonCompliant",
        "evaluationDetails": {
          "evaluatedExpressions": [
            {
              "result": "True",
              "expressionKind": "field",
              "expression": "type",
              "path": "type",
              "expressionValue": "microsoft.compute/virtualmachines",
              "targetValue": "microsoft.compute/virtualmachines",
              "operator": "equals"
            }
          ]
        },
        "effectDetails": {
          "policyEffect": "Deny"
        }
      }
    ]
  }
}

Check policy restrictions at subscription scope including audit effect

Sample Request

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

{
  "resourceDetails": {
    "resourceContent": {
      "type": "Microsoft.Compute/virtualMachines",
      "properties": {
        "priority": "Spot"
      }
    },
    "apiVersion": "2019-12-01"
  },
  "pendingFields": [
    {
      "field": "name",
      "values": [
        "myVMName"
      ]
    },
    {
      "field": "location",
      "values": [
        "eastus",
        "westus",
        "westus2",
        "westeurope"
      ]
    },
    {
      "field": "tags"
    }
  ],
  "includeAuditEffect": true
}

Sample Response

Status code:: 200

{
  "fieldRestrictions": [
    {
      "field": "tags.newtag",
      "restrictions": [
        {
          "result": "Required",
          "defaultValue": "defaultVal",
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "tags.newtag is required"
        }
      ]
    },
    {
      "field": "tags.environment",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Prod",
            "Int",
            "Test"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Audit",
          "reason": "tags.environment is required"
        }
      ]
    },
    {
      "field": "location",
      "restrictions": [
        {
          "result": "Deny",
          "values": [
            "west europe"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "The selected location is not allowed"
        },
        {
          "result": "Audit",
          "values": [
            "eastus",
            "westus"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Audit",
          "reason": "The selected location is not allowed"
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": [
      {
        "policyInfo": {
          "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
          "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
          "policyDefinitionReferenceId": "defref222",
          "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
        },
        "evaluationResult": "NonCompliant",
        "evaluationDetails": {
          "evaluatedExpressions": [
            {
              "result": "True",
              "expressionKind": "field",
              "expression": "type",
              "path": "type",
              "expressionValue": "microsoft.compute/virtualmachines",
              "targetValue": "microsoft.compute/virtualmachines",
              "operator": "equals"
            }
          ],
          "reason": "Resource creation of the selected type is not allowed"
        },
        "effectDetails": {
          "policyEffect": "Audit"
        }
      }
    ]
  }
}

Tanımlar

Name	Description
CheckRestrictionEvaluationDetails	İlke değerlendirme ayrıntıları.
CheckRestrictionsRequest	Denetlenen ilke kısıtlamaları, değerlendirilen kaynağı açıklayan parametrelerdir.
CheckRestrictionsResourceDetails	Değerlendirilecek kaynak hakkındaki bilgiler.
CheckRestrictionsResult	Denetim ilkesi kısıtlamalarının sonucu, bir kaynakta değerlendirmeyi kısıtlar.
ContentEvaluationResult	Sağlanan kısmi kaynak içeriği için değerlendirme sonuçları.
ErrorDefinition	Hata tanımı.
ErrorResponse	Hata yanıtı.
ExpressionEvaluationDetails	İlke dili ifadelerinin değerlendirme ayrıntıları.
FieldRestriction	Belirli bir ilke tarafından uygulanan alandaki kısıtlamalar.
FieldRestrictionResult	Alana uygulanan kısıtlama türü.
FieldRestrictions	İlkeye göre kaynaktaki bir alana yerleştirilecek kısıtlamalar.
IfNotExistsEvaluationDetails	IfNotExists etkisinin değerlendirme ayrıntıları.
PendingField	Kısıtlamaları belirlemek için Azure İlkesi karşı değerlendirilmesi gereken bir alan.
PolicyEffectDetails	Kaynağa uygulanan efektin ayrıntıları.
PolicyEvaluationResult	Belirtilen kaynak içeriğine karşı uyumlu olmayan bir ilke değerlendirmesinin sonucu.
PolicyReference	İlkenin kaynak tanımlayıcıları.
TypedErrorInfo	Senaryoya özgü hata ayrıntıları.

CheckRestrictionEvaluationDetails

İlke değerlendirme ayrıntıları.

Name	Tür	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Değerlendirilen ifadelerin ayrıntıları.
ifNotExistsDetails	IfNotExistsEvaluationDetails	IfNotExists etkisinin değerlendirme ayrıntıları.
reason	string	Değerlendirme sonucunun nedeni.

CheckRestrictionsRequest

Denetlenen ilke kısıtlamaları, değerlendirilen kaynağı açıklayan parametrelerdir.

Name	Tür	Varsayılan değer	Description
includeAuditEffect	boolean	False	Sonuçlara 'denetim' etkisi olan ilkelerin eklenip eklenmeyeceği. Varsayılan değer false şeklindedir.
pendingFields	PendingField[]		Olası kısıtlamalar için değerlendirilmesi gereken alanların ve değerlerin listesi.
resourceDetails	CheckRestrictionsResourceDetails		Değerlendirilecek kaynak hakkındaki bilgiler.

CheckRestrictionsResourceDetails

Değerlendirilecek kaynak hakkındaki bilgiler.

Name	Tür	Description
apiVersion	string	Kaynak içeriğinin api sürümü.
resourceContent	object	Kaynak içeriği. Bu, zaten bilinen özellikleri içermelidir ve tüm kaynak özelliklerinin kısmi bir kümesi olabilir.
scope	string	Kaynağın oluşturulduğu kapsam. Örneğin, kaynak bir alt kaynaksa bu, üst kaynağın kaynak kimliği olacaktır.

CheckRestrictionsResult

Denetim ilkesi kısıtlamalarının sonucu, bir kaynakta değerlendirmeyi kısıtlar.

Name	Tür	Description
contentEvaluationResult	ContentEvaluationResult	Sağlanan kısmi kaynak içeriği için değerlendirme sonuçları.
fieldRestrictions	FieldRestrictions[]	İlkeye göre kaynaktaki çeşitli alanlara yerleştirilecek kısıtlamalar.

ContentEvaluationResult

Sağlanan kısmi kaynak içeriği için değerlendirme sonuçları.

Name	Tür	Description
policyEvaluations	PolicyEvaluationResult[]	Verilen kaynak içeriğine göre ilke değerlendirme sonuçları. Bu, sağlanan kısmi içeriğin olduğu gibi reddedilip reddedilmediğini gösterir.

ErrorDefinition

Hata tanımı.

Name	Tür	Description
additionalInfo	TypedErrorInfo[]	Senaryoya özgü ek hata ayrıntıları.
code	string	HTTP hata kodu için alt durum görevi gören hizmete özgü hata kodu.
details	ErrorDefinition[]	İç hata ayrıntıları.
message	string	Hatanın açıklaması.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	ErrorDefinition	Hata ayrıntıları.

ExpressionEvaluationDetails

İlke dili ifadelerinin değerlendirme ayrıntıları.

Name	Tür	Description
expression	string	İfade değerlendirildi.
expressionKind	string	Değerlendirilen ifade türü.
expressionValue	object	İfadenin değeri.
operator	string	İfade değeriyle hedef değeri karşılaştırmak için işleç.
path	string	İfade bir alan veya diğer adsa özellik yolu.
result	string	Değerlendirme sonucu.
targetValue	object	İfade değeriyle karşılaştırılacak hedef değer.

FieldRestriction

Belirli bir ilke tarafından uygulanan alandaki kısıtlamalar.

Name	Tür	Description
defaultValue	string	Kullanıcı bir değer sağlamazsa, ilkenin alan için ayarlanacağı değer.
policy	PolicyReference	Alan kısıtlamasına neden olan ilkenin ayrıntıları.
policyEffect	string	Alan kısıtlamasına neden olan ilkenin etkisi. http://aka.ms/policyeffects
reason	string	Kısıtlamanın nedeni.
result	FieldRestrictionResult	Alana uygulanan kısıtlama türü.
values	string[]	İlkenin alan için gerektirdiği veya reddetti olduğu değerler.

FieldRestrictionResult

Alana uygulanan kısıtlama türü.

Name	Tür	Description
Audit	string	Alan ve/veya değerler ilke tarafından denetlenecektir.
Deny	string	Alan ve/veya değerler ilke tarafından reddedilir.
Removed	string	Alan ilke tarafından kaldırılır.
Required	string	alan ve/veya değerleri ilke tarafından gereklidir.

FieldRestrictions

İlkeye göre kaynaktaki bir alana yerleştirilecek kısıtlamalar.

Name	Tür	Description
field	string	Alanın adı. Bu, 'name' veya 'type' gibi üst düzey bir özellik veya Azure İlkesi alan diğer adı olabilir.
restrictions	FieldRestriction[]	İlkeye göre bu alana getirilen kısıtlamalar.

IfNotExistsEvaluationDetails

IfNotExists etkisinin değerlendirme ayrıntıları.

Name	Tür	Description
resourceId	string	IfNotExists etkisi için son değerlendirilen kaynağın kimliği.
totalResources	integer	Varoluş koşulunun geçerli olduğu toplam kaynak sayısı.

PendingField

Kısıtlamaları belirlemek için Azure İlkesi karşı değerlendirilmesi gereken bir alan.

Name	Tür	Description
field	string	Alanın adı. Bu, 'name' veya 'type' gibi üst düzey bir özellik veya Azure İlkesi alan diğer adı olabilir.
values	string[]	Azure İlkesi karşı değerlendirilmesi gereken alan için olası değerlerin listesi.

PolicyEffectDetails

Kaynağa uygulanan efektin ayrıntıları.

Name	Tür	Description
policyEffect	string	Kaynağa uygulanan etki. http://aka.ms/policyeffects

PolicyEvaluationResult

Belirtilen kaynak içeriğine karşı uyumlu olmayan bir ilke değerlendirmesinin sonucu.

Name	Tür	Description
effectDetails	PolicyEffectDetails	Kaynağa uygulanan efektin ayrıntıları.
evaluationDetails	CheckRestrictionEvaluationDetails	değerlendirilen ilke ifadelerinin ve değerlerinin ayrıntılı sonuçları.
evaluationResult	string	Kaynakta ilke değerlendirmesinin sonucu. Bu genellikle 'Uyumsuz' olur, ancak hatalarla karşılaşılırsa başka değerler içerebilir.
policyInfo	PolicyReference	Değerlendirilen ilkenin ayrıntıları.

PolicyReference

İlkenin kaynak tanımlayıcıları.

Name	Tür	Description
policyAssignmentId	string	İlke atamasının kaynak tanımlayıcısı.
policyDefinitionId	string	İlke tanımının kaynak tanımlayıcısı.
policyDefinitionReferenceId	string	İlke kümesi tanımı içindeki belirli bir ilke tanımının başvuru tanımlayıcısı.
policySetDefinitionId	string	İlke kümesi tanımının kaynak tanımlayıcısı.

TypedErrorInfo

Senaryoya özgü hata ayrıntıları.

Name	Tür	Description
info		Senaryoya özgü hata ayrıntıları.
type	string	Eklenen hata ayrıntılarının türü.

Aracılığıyla paylaş

Policy Restrictions - Check At Subscription Scope

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Check policy restrictions at subscription scope

Sample Request

Sample Response

Check policy restrictions at subscription scope including audit effect

Sample Request

Sample Response

Tanımlar

CheckRestrictionEvaluationDetails

CheckRestrictionsRequest

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo

Ek kaynaklar