Policy Restrictions - Check At Subscription Scope

Layanan:: Policy

Versi API:: 2024-10-01

Memeriksa batasan apa yang akan ditempatkan Azure Policy pada sumber daya dalam langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
resourceDetails	True	CheckRestrictionsResourceDetails	Informasi tentang sumber daya yang akan dievaluasi.
includeAuditEffect		boolean	Apakah akan menyertakan kebijakan dengan efek 'audit' dalam hasil. Secara default diatur ke false.
pendingFields		PendingField[]	Daftar bidang dan nilai yang harus dievaluasi untuk potensi pembatasan.

Respons

Nama	Jenis	Deskripsi
200 OK	CheckRestrictionsResult	Pembatasan yang akan ditempatkan pada sumber daya oleh Azure Policy.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Check policy restrictions at subscription scope

Check policy restrictions at subscription scope including audit effect

Check policy restrictions at subscription scope

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2024-10-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"
    }
  ]
}

Respon sampel

Kode status:: 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

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2024-10-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
}

Respon sampel

Kode status:: 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"
        }
      }
    ]
  }
}

Definisi

Nama	Deskripsi
CheckRestrictionEvaluationDetails	Detail evaluasi kebijakan.
CheckRestrictionsRequest	Parameter pembatasan kebijakan pemeriksaan yang menjelaskan sumber daya yang sedang dievaluasi.
CheckRestrictionsResourceDetails	Informasi tentang sumber daya yang akan dievaluasi.
CheckRestrictionsResult	Hasil dari evaluasi pembatasan kebijakan pemeriksaan pada sumber daya.
ContentEvaluationResult	Hasil evaluasi untuk konten sumber daya parsial yang disediakan.
ErrorDefinition	Definisi kesalahan.
ErrorResponse	Respons kesalahan.
ExpressionEvaluationDetails	Detail evaluasi ekspresi bahasa kebijakan.
FieldRestriction	Pembatasan pada bidang yang diberlakukan oleh kebijakan tertentu.
FieldRestrictionResult	Jenis pembatasan yang diberlakukan pada bidang .
FieldRestrictions	Pembatasan yang akan ditempatkan pada bidang dalam sumber daya berdasarkan kebijakan.
IfNotExistsEvaluationDetails	Detail evaluasi efek IfNotExists.
PendingField	Bidang yang harus dievaluasi terhadap Azure Policy untuk menentukan pembatasan.
PolicyEffectDetails	Detail efek yang diterapkan ke sumber daya.
PolicyEvaluationResult	Hasil evaluasi kebijakan yang tidak sesuai terhadap konten sumber daya yang diberikan.
PolicyReference	Pengidentifikasi sumber daya untuk kebijakan.
TypedErrorInfo	Detail kesalahan spesifik skenario.

CheckRestrictionEvaluationDetails

Objek

Detail evaluasi kebijakan.

Nama	Jenis	Deskripsi
evaluatedExpressions	ExpressionEvaluationDetails[]	Detail ekspresi yang dievaluasi.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Detail evaluasi efek IfNotExists.
reason	string	Alasan hasil evaluasi.

CheckRestrictionsRequest

Objek

Parameter pembatasan kebijakan pemeriksaan yang menjelaskan sumber daya yang sedang dievaluasi.

Nama	Jenis	Nilai default	Deskripsi
includeAuditEffect	boolean	False	Apakah akan menyertakan kebijakan dengan efek 'audit' dalam hasil. Secara default diatur ke false.
pendingFields	PendingField[]		Daftar bidang dan nilai yang harus dievaluasi untuk potensi pembatasan.
resourceDetails	CheckRestrictionsResourceDetails		Informasi tentang sumber daya yang akan dievaluasi.

CheckRestrictionsResourceDetails

Objek

Informasi tentang sumber daya yang akan dievaluasi.

Nama	Jenis	Deskripsi
apiVersion	string	Versi api dari konten sumber daya.
resourceContent	object	Konten sumber daya. Ini harus mencakup properti apa pun yang sudah diketahui dan dapat menjadi sekumpulan parsial dari semua properti sumber daya.
scope	string	Cakupan tempat sumber daya sedang dibuat. Misalnya, jika sumber daya adalah sumber daya anak, ini akan menjadi ID sumber daya sumber daya induk.

CheckRestrictionsResult

Objek

Hasil dari evaluasi pembatasan kebijakan pemeriksaan pada sumber daya.

Nama	Jenis	Deskripsi
contentEvaluationResult	ContentEvaluationResult	Hasil evaluasi untuk konten sumber daya parsial yang disediakan.
fieldRestrictions	FieldRestrictions[]	Pembatasan yang akan ditempatkan pada berbagai bidang dalam sumber daya berdasarkan kebijakan.

ContentEvaluationResult

Objek

Hasil evaluasi untuk konten sumber daya parsial yang disediakan.

Nama	Jenis	Deskripsi
policyEvaluations	PolicyEvaluationResult[]	Hasil evaluasi kebijakan terhadap konten sumber daya yang diberikan. Ini akan menunjukkan apakah konten parsial yang disediakan akan ditolak as-is.

ErrorDefinition

Objek

Definisi kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	TypedErrorInfo[]	Detail kesalahan spesifik skenario tambahan.
code	string	Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.
details	ErrorDefinition[]	Detail kesalahan internal.
message	string	Deskripsi kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	ErrorDefinition	Rincian kesalahan.

ExpressionEvaluationDetails

Objek

Detail evaluasi ekspresi bahasa kebijakan.

Nama	Jenis	Deskripsi
expression	string	Ekspresi dievaluasi.
expressionKind	string	Jenis ekspresi yang dievaluasi.
expressionValue	object	Nilai ekspresi.
operator	string	Operator untuk membandingkan nilai ekspresi dan nilai target.
path	string	Jalur properti jika ekspresi adalah bidang atau alias.
result	string	Hasil evaluasi.
targetValue	object	Nilai target yang akan dibandingkan dengan nilai ekspresi.

FieldRestriction

Objek

Pembatasan pada bidang yang diberlakukan oleh kebijakan tertentu.

Nama	Jenis	Deskripsi
defaultValue	string	Nilai yang akan ditetapkan kebijakan untuk bidang jika pengguna tidak memberikan nilai.
policy	PolicyReference	Detail kebijakan yang menyebabkan pembatasan bidang.
policyEffect	string	Efek dari kebijakan yang menyebabkan pembatasan bidang. http://aka.ms/policyeffects
reason	string	Alasan pembatasan.
result	FieldRestrictionResult	Jenis pembatasan yang diberlakukan pada bidang .
values	string[]	Nilai yang diperlukan kebijakan atau penolakan untuk bidang .

FieldRestrictionResult

Enumerasi

Jenis pembatasan yang diberlakukan pada bidang .

Nilai	Deskripsi
Required	Bidang dan/atau nilai diperlukan oleh kebijakan.
Removed	Bidang akan dihapus oleh kebijakan.
Deny	Bidang dan/atau nilai akan ditolak oleh kebijakan.
Audit	Bidang dan/atau nilai akan diaudit oleh kebijakan.

FieldRestrictions

Objek

Pembatasan yang akan ditempatkan pada bidang dalam sumber daya berdasarkan kebijakan.

Nama	Jenis	Deskripsi
field	string	Nama bidang. Ini bisa berupa properti tingkat atas seperti 'name' atau 'type' atau alias bidang Azure Policy.
restrictions	FieldRestriction[]	Pembatasan yang ditempatkan pada bidang tersebut berdasarkan kebijakan.

IfNotExistsEvaluationDetails

Objek

Detail evaluasi efek IfNotExists.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya terakhir yang dievaluasi untuk efek IfNotExists.
totalResources	integer	Jumlah total sumber daya yang kondisi keberadaannya berlaku.

PendingField

Objek

Bidang yang harus dievaluasi terhadap Azure Policy untuk menentukan pembatasan.

Nama	Jenis	Deskripsi
field	string	Nama bidang. Ini bisa berupa properti tingkat atas seperti 'name' atau 'type' atau alias bidang Azure Policy.
values	string[]	Daftar nilai potensial untuk bidang yang harus dievaluasi terhadap Azure Policy.

PolicyEffectDetails

Objek

Detail efek yang diterapkan ke sumber daya.

Nama	Jenis	Deskripsi
policyEffect	string	Efek yang diterapkan ke sumber daya. http://aka.ms/policyeffects

PolicyEvaluationResult

Objek

Hasil evaluasi kebijakan yang tidak sesuai terhadap konten sumber daya yang diberikan.

Nama	Jenis	Deskripsi
effectDetails	PolicyEffectDetails	Detail efek yang diterapkan ke sumber daya.
evaluationDetails	CheckRestrictionEvaluationDetails	Hasil terperinci dari ekspresi dan nilai kebijakan yang dievaluasi.
evaluationResult	string	Hasil evaluasi kebijakan terhadap sumber daya. Ini biasanya akan menjadi 'Tidak Patuh' tetapi mungkin berisi nilai lain jika kesalahan ditemui.
policyInfo	PolicyReference	Detail kebijakan yang dievaluasi.

PolicyReference

Objek

Pengidentifikasi sumber daya untuk kebijakan.

Nama	Jenis	Deskripsi
policyAssignmentId	string	Pengidentifikasi sumber daya penetapan kebijakan.
policyDefinitionId	string	Pengidentifikasi sumber daya definisi kebijakan.
policyDefinitionReferenceId	string	Pengidentifikasi referensi definisi kebijakan tertentu dalam definisi kumpulan kebijakan.
policySetDefinitionId	string	Pengidentifikasi sumber daya dari definisi kumpulan kebijakan.

TypedErrorInfo

Objek

Detail kesalahan spesifik skenario.

Nama	Jenis	Deskripsi
info		Detail kesalahan spesifik skenario.
type	string	Jenis detail kesalahan yang disertakan.

Bagikan melalui

Policy Restrictions - Check At Subscription Scope

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Check policy restrictions at subscription scope

Permintaan sampel

Respon sampel

Check policy restrictions at subscription scope including audit effect

Permintaan sampel

Respon sampel

Definisi

CheckRestrictionEvaluationDetails

CheckRestrictionsRequest

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo