Policy Assignments - Create By Id

Referencia

Service:: Policy

API Version:: 2023-04-01

Szabályzat-hozzárendelést hoz létre vagy frissít.
Ez a művelet létrehozza vagy frissíti a szabályzat-hozzárendelést a megadott azonosítóval. A hatókörön végrehajtott szabályzat-hozzárendelések az adott hatókörben található összes erőforrásra vonatkoznak. Ha például hozzárendel egy szabályzatot egy erőforráscsoporthoz, a szabályzat a csoport összes erőforrására érvényes. A szabályzat-hozzárendelési azonosítók formátuma a következő: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Érvényes hatókörök: felügyeleti csoport (formátum: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), előfizetés (formátum: "/subscriptions/{subscriptionId}"), erőforráscsoport (formátum: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", vagy erőforrás (formátum: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
policyAssignmentId	path	True	string	A létrehozandó szabályzat-hozzárendelés azonosítója. Használja a következő formátumot: {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
identity	Identity	A szabályzat-hozzárendeléshez társított felügyelt identitás.
location	string	A szabályzat-hozzárendelés helye. Csak felügyelt identitás használatakor szükséges.
properties.description	string	Ez az üzenet a szabályzat megsértése esetén a válasz része lesz.
properties.displayName	string	A szabályzat-hozzárendelés megjelenítendő neve.
properties.enforcementMode	enforcementMode	A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Alapértelmezett és DoNotEnforce.
properties.metadata	object	A szabályzat-hozzárendelés metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye.
properties.nonComplianceMessages	NonComplianceMessage[]	Azokat az üzeneteket, amelyek azt írják le, hogy egy erőforrás miért nem felel meg a szabályzatnak.
properties.notScopes	string[]	A szabályzat kizárt hatókörei.
properties.overrides	Override[]	A szabályzattulajdonság értékének felülbírálása.
properties.parameters	<string, ParameterValuesValue>	A hozzárendelt szabályzatszabály paraméterértékei. A kulcsok a paraméternevek.
properties.policyDefinitionId	string	A hozzárendelt szabályzatdefiníció vagy szabályzatkészlet-definíció azonosítója.
properties.resourceSelectors	ResourceSelector[]	Az erőforrás-választó lista, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.

Válaszok

Name	Típus	Description
201 Created	PolicyAssignment	Létrehozva – A szabályzat-hozzárendeléssel kapcsolatos információkat adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-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",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 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",
    "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"
}

Create or update policy assignment with a managed identity by ID

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-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",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 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",
    "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": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Definíciók

Name	Description
CloudError	Egy szabályzatművelet hibaválasza.
createdByType	Az erőforrást létrehozó identitás típusa.
enforcementMode	A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Alapértelmezett és DoNotEnforce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
Identity	Az erőforrás identitása. A szabályzat-hozzárendelések legfeljebb egy identitást támogatnak. Ez vagy rendszer által hozzárendelt identitás, vagy egy felhasználó által hozzárendelt identitás.
NonComplianceMessage	Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "deny" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg.
Override	A szabályzattulajdonság értékének felülbírálása.
OverrideKind	A felülbírálás típusa.
ParameterValuesValue	Egy paraméter értéke.
PolicyAssignment	A szabályzat-hozzárendelés.
ResourceIdentityType	Az identitás típusa. Ez az egyetlen kötelező mező, amikor rendszer- vagy felhasználó által hozzárendelt identitást ad hozzá egy erőforráshoz.
ResourceSelector	Az erőforrás-választó, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.
Selector	A választókifejezés.
SelectorKind	A választó típusa.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentities	A szabályzathoz társított felhasználói identitás. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Egy szabályzatművelet hibaválasza.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Alapértelmezett és DoNotEnforce.

Name	Típus	Description
Default	string	A szabályzathatás kényszerítve van az erőforrás-létrehozás vagy -frissítés során.
DoNotEnforce	string	A szabályzat hatása nem lesz kényszerítve az erőforrás létrehozása vagy frissítése során.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

Identity

Az erőforrás identitása. A szabályzat-hozzárendelések legfeljebb egy identitást támogatnak. Ez vagy rendszer által hozzárendelt identitás, vagy egy felhasználó által hozzárendelt identitás.

Name	Típus	Description
principalId	string	Az erőforrás-identitás egyszerű azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva
tenantId	string	Az erőforrás-identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva
type	ResourceIdentityType	Az identitás típusa. Ez az egyetlen kötelező mező, amikor rendszer- vagy felhasználó által hozzárendelt identitást ad hozzá egy erőforráshoz.
userAssignedIdentities	UserAssignedIdentities	A szabályzathoz társított felhasználói identitás. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "deny" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg.

Name	Típus	Description
message	string	Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "deny" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg.
policyDefinitionReferenceId	string	A szabályzatdefiníció referenciaazonosítója egy szabályzatkészlet-definícióban, amelynek az üzenetet szánták. Ez csak akkor alkalmazható, ha a szabályzat-hozzárendelés hozzárendel egy szabályzatkészlet-definíciót. Ha ez nem jelenik meg, az üzenet a szabályzat-hozzárendelés által hozzárendelt összes szabályzatra vonatkozik.

Override

A szabályzattulajdonság értékének felülbírálása.

Name	Típus	Description
kind	OverrideKind	A felülbírálás típusa.
selectors	Selector[]	A választókifejezések listája.
value	string	A szabályzattulajdonság felülbírálásához használni kívánt érték.

OverrideKind

A felülbírálás típusa.

Name	Típus	Description
policyEffect	string	Felülbírálja a szabályzateffektus típusát.

ParameterValuesValue

Egy paraméter értéke.

Name	Típus	Description
value	object	A paraméter értéke.