Policy Assignments - Create By Id

Služba:: Policy

Verze rozhraní API:: 2025-01-01

Vytvoří nebo aktualizuje přiřazení zásad.
Tato operace vytváří nebo aktualizuje přiřazení politiky s daným ID. Přiřazení politik provedených v rámci rozsahu se vztahují na všechny zdroje obsažené v tomto rozsahu. Například když přiřadíte politiku ke skupině zdrojů, tato politika se vztahuje na všechny zdroje ve skupině. ID přiřazení politik mají tento formát: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Platné rozsahy jsou: skupina správy (formát: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), předplatné (formát: '/subscriptions/{subscriptionId}'), resource group (formát: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', nebo resource (formát: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
policyAssignmentId	path	True	string	ID přiřazení pojistky k vytvoření. Použijte formát {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
identity	Identity	Spravovaná identita přidružená k přiřazení zásad.
location	string	Umístění přiřazení zásady. Vyžaduje se pouze při využití spravované identity.
properties.assignmentType	assignmentType	Typ přiřazení zásad. Možné hodnoty jsou NotSpecified, System, SystemHidden a Custom. Neměnný
properties.definitionVersion	string	Verze definice zásady, která se má použít.
properties.description	string	Tato zpráva bude součástí odpovědi v případě porušení zásad.
properties.displayName	string	Zobrazovaný název přiřazení zásady.
properties.enforcementMode	enforcementMode	Režim vynucení přiřazení zásad. Možné hodnoty jsou Default, DoNotEnforce a Enroll
properties.metadata	object	Metadata přiřazení zásad. Metadata jsou otevřený objekt, který je obvykle kolekcí párů klíč-hodnota.
properties.nonComplianceMessages	NonComplianceMessage[]	Zprávy, které popisují, proč prostředek nedodržuje zásady.
properties.notScopes	string[]	Vyloučené obory zásad.
properties.overrides	Override[]	Přepsání hodnoty vlastnosti zásady.
properties.parameters	<string, ParameterValuesValue>	Hodnoty parametrů pro přiřazené pravidlo zásad. Klíče jsou názvy parametrů.
properties.policyDefinitionId	string	ID definice zásady nebo definice sady zásad, která se přiřazuje.
properties.resourceSelectors	ResourceSelector[]	Seznam selektoru prostředků pro filtrování zásad podle vlastností prostředků.

Odpovědi

Name	Typ	Description
201 Created	PolicyAssignment	Vytvořeno – Vrací informace o přidělení pojistky.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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"
  }
}

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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"
  }
}

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
assignmentType	Typ přiřazení zásad. Možné hodnoty jsou NotSpecified, System, SystemHidden a Custom. Neměnný
CloudError	Odpověď na chybu operace zásad.
createdByType	Typ identity, která prostředek vytvořila.
enforcementMode	Režim vynucení přiřazení zásad. Možné hodnoty jsou Default, DoNotEnforce a Enroll
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
Identity	Identita prostředku Přiřazení politik podporují maximálně jednu identitu. To je buď identita přiřazená systému, nebo identita přiřazená jedním uživatelem.
NonComplianceMessage	Zpráva, která popisuje, proč prostředek nedodržuje zásady. To se zobrazuje v chybových zprávách odepření a ve výsledcích dodržování předpisů nevyhovujících prostředkům.
Override	Přepsání hodnoty vlastnosti zásady.
OverrideKind	Druh přepsání.
ParameterValuesValue	Hodnota parametru.
PolicyAssignment	Úkol s politikou.
ResourceIdentityType	Typ identity. Toto je jediné povinné pole při přidávání identity přiřazené systémem nebo uživatelem k prostředku.
ResourceSelector	Selektor prostředků pro filtrování zásad podle vlastností prostředku.
Selector	Výraz selektoru.
SelectorKind	Druh selektoru.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentities	Identita uživatele přidružená k zásadě. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

assignmentType

Výčet

Typ přiřazení zásad. Možné hodnoty jsou NotSpecified, System, SystemHidden a Custom. Neměnný

Hodnota	Description
NotSpecified
System
SystemHidden
Custom

CloudError

Objekt

Odpověď na chybu operace zásad.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

enforcementMode

Výčet

Režim vynucení přiřazení zásad. Možné hodnoty jsou Default, DoNotEnforce a Enroll

Hodnota	Description
Default	Účinek zásad se vynucuje během vytváření nebo aktualizace prostředku.
DoNotEnforce	Efekt politiky není vynucován při vytváření nebo aktualizaci zdrojů.
Enroll	Efekt politiky není vynucován při vytváření nebo aktualizaci zdroje, dokud není zdroj nebo rozsah zdroje zapsán do instance přiřazení. Zápis probíhá po nasazení zdroje pro zápis do politiky.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Objekt

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

Identity

Objekt

Identita prostředku Přiřazení politik podporují maximálně jednu identitu. To je buď identita přiřazená systému, nebo identita přiřazená jedním uživatelem.

Name	Typ	Description
principalId	string	Hlavní ID identity zdroje. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systému
tenantId	string	ID tenanta identity zdroje. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systému
type	ResourceIdentityType	Typ identity. Toto je jediné povinné pole při přidávání identity přiřazené systémem nebo uživatelem k prostředku.
userAssignedIdentities	UserAssignedIdentities	Identita uživatele přidružená k zásadě. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

NonComplianceMessage

Objekt

Zpráva, která popisuje, proč prostředek nedodržuje zásady. To se zobrazuje v chybových zprávách odepření a ve výsledcích dodržování předpisů nevyhovujících prostředkům.

Name	Typ	Description
message	string	Zpráva, která popisuje, proč prostředek nedodržuje zásady. To se zobrazuje v chybových zprávách odepření a ve výsledcích dodržování předpisů nevyhovujících prostředkům.
policyDefinitionReferenceId	string	Referenční ID definice zásady v definici sady zásad, pro kterou je zpráva určená. To platí jenom v případě, že přiřazení zásady přiřadí definici sady zásad. Pokud tato zpráva není zadána, platí pro všechny zásady přiřazené tímto přiřazením zásad.

Override

Objekt

Přepsání hodnoty vlastnosti zásady.

Name	Typ	Description
kind	OverrideKind	Druh přepsání.
selectors	Selector[]	Seznam výrazů selektoru
value	string	Hodnota pro přepsání vlastnosti zásady.

OverrideKind

Výčet

Druh přepsání.

Hodnota	Description
policyEffect	Přebije to typ efektu politiky.
definitionVersion	Přepíše definici a verzi, hodnotu majetku přiřazení pojistky.

ParameterValuesValue

Objekt

Hodnota parametru.

Name	Typ	Description
value		Hodnota parametru.