Policy Definitions - Create Or Update At Management Group

Referensi

Service:: Policy

API Version:: 2023-04-01

Membuat atau memperbarui definisi kebijakan dalam grup manajemen.
Operasi ini membuat atau memperbarui definisi kebijakan dalam grup manajemen yang diberikan dengan nama yang diberikan.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
managementGroupId	path	True	string	ID grup manajemen.
policyDefinitionName	path	True	string	Nama definisi kebijakan yang akan dibuat. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

managementGroupId

path

True

string

ID grup manajemen.

policyDefinitionName

path

True

string

Nama definisi kebijakan yang akan dibuat.

Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

api-version

query

True

string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.description	string	Deskripsi definisi kebijakan.
properties.displayName	string	Nama tampilan definisi kebijakan.
properties.metadata	object	Metadata definisi kebijakan. Metadata adalah objek terbuka dan biasanya merupakan kumpulan pasangan nilai kunci.
properties.mode	string	Mode definisi kebijakan. Beberapa contohnya adalah Semua, Terindeks, Microsoft.KeyVault.Data.
properties.parameters	<string, ParameterDefinitionsValue>	Definisi parameter untuk parameter yang digunakan dalam aturan kebijakan. Kuncinya adalah nama parameter.
properties.policyRule	object	Aturan kebijakan.
properties.policyType	policyType	Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static.
properties.version	string	Versi definisi kebijakan dalam format #.#.#.
properties.versions	string[]	Daftar versi yang tersedia untuk definisi kebijakan ini.

Respons

Nama	Jenis	Deskripsi
201 Created	PolicyDefinition	Dibuat - Mengembalikan informasi tentang definisi kebijakan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Create or update a policy definition at management group level

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2023-04-01

{
  "properties": {
    "mode": "All",
    "displayName": "Enforce resource naming convention",
    "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    }
  }
}

Sample Response

Status code:: 201

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "ResourceNaming",
  "properties": {
    "mode": "All",
    "displayName": "Naming Convention",
    "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    },
    "policyType": "Custom"
  }
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari operasi kebijakan.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons Kesalahan
Metadata	Metadata umum untuk parameter .
ParameterDefinitionsValue	Definisi parameter yang dapat diberikan ke kebijakan.
parameterType	Tipe data parameter.
PolicyDefinition	Definisi kebijakan.
policyType	Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

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

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

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

ErrorResponse

Respons Kesalahan

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

Metadata

Metadata umum untuk parameter .

Nama	Jenis	Deskripsi
assignPermissions	boolean	Atur ke true agar portal Azure membuat penetapan peran pada ID sumber daya atau nilai cakupan sumber daya parameter ini selama penetapan kebijakan. Properti ini berguna jika Anda ingin menetapkan izin di luar cakupan penugasan.
description	string	Deskripsi parameter .
displayName	string	Nama tampilan untuk parameter .
strongType	string	Digunakan saat menetapkan definisi kebijakan melalui portal. Menyediakan daftar nilai konteks yang diketahui untuk dipilih pengguna.

ParameterDefinitionsValue

Definisi parameter yang dapat diberikan ke kebijakan.

Nama	Jenis	Deskripsi
allowedValues	object[]	Nilai yang diizinkan untuk parameter .
defaultValue	object	Nilai default untuk parameter jika tidak ada nilai yang disediakan.
metadata	Metadata	Metadata umum untuk parameter .
schema	object	Menyediakan validasi input parameter selama penugasan menggunakan skema JSON yang ditentukan sendiri. Properti ini hanya didukung untuk parameter jenis objek dan mengikuti implementasi Skema Json.NET 2019-09. Anda dapat mempelajari selengkapnya penggunaan skema di https://json-schema.org/ dan menguji skema draf di https://www.jsonschemavalidator.net/.
type	parameterType	Tipe data parameter.

parameterType

Tipe data parameter.

Nama	Jenis	Deskripsi
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string