Policy Assignments - Create By Id

Layanan:: Policy

Versi API:: 2025-01-01

Membuat atau memperbarui penetapan kebijakan.
Operasi ini membuat atau memperbarui penetapan kebijakan dengan ID yang diberikan. Penetapan kebijakan yang dibuat pada cakupan berlaku untuk semua sumber daya yang terkandung dalam cakupan tersebut. Misalnya, saat Anda menetapkan kebijakan ke grup sumber daya, kebijakan tersebut berlaku untuk semua sumber daya dalam grup. ID penetapan kebijakan memiliki format ini: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Cakupan yang valid adalah: grup manajemen (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), langganan (format: '/subscriptions/{subscriptionId}'), grup sumber daya (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', atau sumber daya (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2025-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
policyAssignmentId	path	True	string	ID penetapan kebijakan yang akan dibuat. Gunakan format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
identity	Identity	Identitas terkelola yang terkait dengan penetapan kebijakan.
location	string	Lokasi penetapan kebijakan. Hanya diperlukan saat menggunakan identitas terkelola.
properties.assignmentType	assignmentType	Jenis penetapan kebijakan. Nilai yang mungkin adalah NotSpecified, System, SystemHidden, dan Custom. Tetap.
properties.definitionVersion	string	Versi definisi kebijakan yang akan digunakan.
properties.description	string	Pesan ini akan menjadi bagian dari respons jika terjadi pelanggaran kebijakan.
properties.displayName	string	Nama tampilan penetapan kebijakan.
properties.enforcementMode	enforcementMode	Mode penegakan penetapan kebijakan. Nilai yang mungkin adalah Default, DoNotEnforce, dan Enroll
properties.metadata	object	Metadata penetapan kebijakan. Metadata adalah objek terbuka dan biasanya merupakan kumpulan pasangan nilai kunci.
properties.nonComplianceMessages	NonComplianceMessage[]	Pesan yang menjelaskan mengapa sumber daya tidak mematuhi kebijakan.
properties.notScopes	string[]	Cakupan kebijakan yang dikecualikan.
properties.overrides	Override[]	Nilai properti kebijakan akan ditimpa.
properties.parameters	<string, ParameterValuesValue>	Nilai parameter untuk aturan kebijakan yang ditetapkan. Kuncinya adalah nama parameter.
properties.policyDefinitionId	string	ID definisi kebijakan atau definisi kumpulan kebijakan yang ditetapkan.
properties.resourceSelectors	ResourceSelector[]	Daftar pemilih sumber daya untuk memfilter kebijakan menurut properti sumber daya.

Respons

Nama	Jenis	Deskripsi
201 Created	PolicyAssignment	Dibuat - Mengembalikan informasi tentang penetapan kebijakan.
Other Status Codes	CloudError	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

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

Permintaan sampel

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "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",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Respon sampel

Kode status:: 201

{
  "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",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

Permintaan sampel

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "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",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Respon sampel

Kode status:: 201

{
  "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",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Definisi

Nama	Deskripsi
assignmentType	Jenis penetapan kebijakan. Nilai yang mungkin adalah NotSpecified, System, SystemHidden, dan Custom. Tetap.
CloudError	Respons kesalahan dari operasi kebijakan.
createdByType	Jenis identitas yang membuat sumber daya.
enforcementMode	Mode penegakan penetapan kebijakan. Nilai yang mungkin adalah Default, DoNotEnforce, dan Enroll
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons Kesalahan
Identity	Identitas untuk sumber daya. Penetapan kebijakan mendukung maksimal satu identitas. Itu adalah identitas yang ditetapkan sistem atau identitas yang ditetapkan pengguna tunggal.
NonComplianceMessage	Pesan yang menjelaskan mengapa sumber daya tidak sesuai dengan kebijakan. Ini ditampilkan dalam pesan kesalahan 'tolak' dan pada hasil kepatuhan sumber daya yang tidak patuh.
Override	Nilai properti kebijakan akan ditimpa.
OverrideKind	Jenis penimpaan.
ParameterValuesValue	Nilai parameter.
PolicyAssignment	Penetapan kebijakan.
ResourceIdentityType	Jenis identitas. Ini adalah satu-satunya bidang yang diperlukan saat menambahkan sistem atau identitas yang ditetapkan pengguna ke sumber daya.
ResourceSelector	Pemilih sumber daya untuk memfilter kebijakan menurut properti sumber daya.
Selector	Ekspresi pemilih.
SelectorKind	Jenis pemilih.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentities	Identitas pengguna yang terkait dengan kebijakan. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

assignmentType

Enumerasi

Jenis penetapan kebijakan. Nilai yang mungkin adalah NotSpecified, System, SystemHidden, dan Custom. Tetap.

Nilai	Deskripsi
NotSpecified
System
SystemHidden
Custom

CloudError

Objek

Respons kesalahan dari operasi kebijakan.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

enforcementMode

Enumerasi

Mode penegakan penetapan kebijakan. Nilai yang mungkin adalah Default, DoNotEnforce, dan Enroll

Nilai	Deskripsi
Default	Efek kebijakan diberlakukan selama pembuatan atau pembaruan sumber daya.
DoNotEnforce	Efek kebijakan tidak diterapkan selama pembuatan atau pembaruan sumber daya.
Enroll	Efek kebijakan tidak diberlakukan selama pembuatan atau pembaruan sumber daya hingga sumber daya atau cakupan sumber daya didaftarkan ke instans penetapan. Pendaftaran terjadi setelah penyebaran sumber daya pendaftaran kebijakan.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Objek

Respons Kesalahan

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

Identity

Objek

Identitas untuk sumber daya. Penetapan kebijakan mendukung maksimal satu identitas. Itu adalah identitas yang ditetapkan sistem atau identitas yang ditetapkan pengguna tunggal.

Nama	Jenis	Deskripsi
principalId	string	ID utama identitas sumber daya. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem
tenantId	string	ID penyewa identitas sumber daya. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem
type	ResourceIdentityType	Jenis identitas. Ini adalah satu-satunya bidang yang diperlukan saat menambahkan sistem atau identitas yang ditetapkan pengguna ke sumber daya.
userAssignedIdentities	UserAssignedIdentities	Identitas pengguna yang terkait dengan kebijakan. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Objek

Pesan yang menjelaskan mengapa sumber daya tidak sesuai dengan kebijakan. Ini ditampilkan dalam pesan kesalahan 'tolak' dan pada hasil kepatuhan sumber daya yang tidak patuh.

Nama	Jenis	Deskripsi
message	string	Pesan yang menjelaskan mengapa sumber daya tidak sesuai dengan kebijakan. Ini ditampilkan dalam pesan kesalahan 'tolak' dan pada hasil kepatuhan sumber daya yang tidak patuh.
policyDefinitionReferenceId	string	ID referensi definisi kebijakan dalam definisi kumpulan kebijakan yang ditujukan untuk pesan. Ini hanya berlaku jika penetapan kebijakan menetapkan definisi yang ditetapkan kebijakan. Jika ini tidak disediakan, pesan berlaku untuk semua kebijakan yang ditetapkan oleh penetapan kebijakan ini.

Override

Objek

Nilai properti kebijakan akan ditimpa.

Nama	Jenis	Deskripsi
kind	OverrideKind	Jenis penimpaan.
selectors	Selector[]	Daftar ekspresi pemilih.
value	string	Nilai untuk mengambil alih properti kebijakan.

OverrideKind

Enumerasi

Jenis penimpaan.

Nilai	Deskripsi
policyEffect	Ini akan mengganti jenis efek kebijakan.
definitionVersion	Ini akan mengganti nilai properti versi definisi dari penetapan kebijakan.

ParameterValuesValue

Objek

Nilai parameter.

Nama	Jenis	Deskripsi
value		Nilai parameter .