Policy Assignments - Create By Id

Tjänst:: Policy

API-version:: 2025-01-01

Skapar eller uppdaterar en principtilldelning.
Denna operation skapar eller uppdaterar policytilldelningen med det givna ID:t. Policytilldelningar som görs inom en omfattning gäller för alla resurser som ingår i den omfattningen. Till exempel, när du tilldelar en policy till en resursgrupp gäller den policyn för alla resurser i gruppen. Policy-tilldelnings-ID:n har detta format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Giltiga omfattningar är: managementgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', eller resurs (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
policyAssignmentId	path	True	string	ID:t för policytilldelningen som ska skapas. Använd formatet {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
identity	Identity	Den hanterade identitet som är associerad med principtilldelningen.
location	string	Platsen för principtilldelningen. Krävs endast vid användning av hanterad identitet.
properties.assignmentType	assignmentType	Typ av principtilldelning. Möjliga värden är NotSpecified, System, SystemHidden och Custom. Oföränderliga.
properties.definitionVersion	string	Den version av principdefinitionen som ska användas.
properties.description	string	Det här meddelandet är en del av svaret i händelse av principöverträdelse.
properties.displayName	string	Visningsnamnet för principtilldelningen.
properties.enforcementMode	enforcementMode	Tvingande läge för principtilldelning. Möjliga värden är Standard, DoNotEnforce och Registrera
properties.metadata	object	Metadata för principtilldelning. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
properties.nonComplianceMessages	NonComplianceMessage[]	Meddelandena som beskriver varför en resurs inte är kompatibel med principen.
properties.notScopes	string[]	Principens undantagna omfång.
properties.overrides	Override[]	Åsidosättning av principegenskapsvärdet.
properties.parameters	<string, ParameterValuesValue>	Parametervärdena för den tilldelade principregeln. Nycklarna är parameternamnen.
properties.policyDefinitionId	string	ID:t för den principdefinition eller principuppsättningsdefinition som tilldelas.
properties.resourceSelectors	ResourceSelector[]	Listan över resursväljare för att filtrera principer efter resursegenskaper.

Svar

Name	Typ	Description
201 Created	PolicyAssignment	Skapat – Returinformation om policyöverlåtelsen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
assignmentType	Typ av principtilldelning. Möjliga värden är NotSpecified, System, SystemHidden och Custom. Oföränderliga.
CloudError	Ett felsvar från en principåtgärd.
createdByType	Den typ av identitet som skapade resursen.
enforcementMode	Tvingande läge för principtilldelning. Möjliga värden är Standard, DoNotEnforce och Registrera
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
Identity	Identitet för resursen. Policytilldelningar stöder maximalt en identitet. Det är antingen en systemtilldelad identitet eller en enskild användar-tilldelad identitet.
NonComplianceMessage	Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.
Override	Åsidosättning av principegenskapsvärdet.
OverrideKind	Åsidosättningstyp.
ParameterValuesValue	Värdet av en parameter.
PolicyAssignment	Policyuppdraget.
ResourceIdentityType	Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.
ResourceSelector	Resursväljaren som filtrerar principer efter resursegenskaper.
Selector	Väljarens uttryck.
SelectorKind	Väljarens typ.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentities	Användaridentiteten som är associerad med principen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

assignmentType

Uppräkning

Typ av principtilldelning. Möjliga värden är NotSpecified, System, SystemHidden och Custom. Oföränderliga.

Värde	Description
NotSpecified
System
SystemHidden
Custom

CloudError

Objekt

Ett felsvar från en principåtgärd.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.)

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

enforcementMode

Uppräkning

Tvingande läge för principtilldelning. Möjliga värden är Standard, DoNotEnforce och Registrera

Värde	Description
Default	Effekten av policyn tillämpas när resursen skapas eller uppdateras.
DoNotEnforce	Policyeffekten tillämpas inte vid resursskapande eller uppdatering.
Enroll	Policyeffekten tillämpas inte vid resursskapande eller uppdatering förrän resursen eller resursens omfattning är registrerad i tilldelningsinstansen. Registrering sker vid användning av policy-inskrivningsresursen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

Identity

Objekt

Identitet för resursen. Policytilldelningar stöder maximalt en identitet. Det är antingen en systemtilldelad identitet eller en enskild användar-tilldelad identitet.

Name	Typ	Description
principalId	string	Huvud-ID för resursidentiteten. Denna egenskap kommer endast att tillhandahållas för en systemtilldelad identitet
tenantId	string	Tenant-ID:t för resursidentiteten. Denna egenskap kommer endast att tillhandahållas för en systemtilldelad identitet
type	ResourceIdentityType	Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.
userAssignedIdentities	UserAssignedIdentities	Användaridentiteten som är associerad med principen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Objekt

Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.

Name	Typ	Description
message	string	Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.
policyDefinitionReferenceId	string	Referens-ID:t för principdefinitionen i en principuppsättningsdefinition som meddelandet är avsett för. Detta gäller endast om principtilldelningen tilldelar en principuppsättningsdefinition. Om detta inte anges gäller meddelandet för alla principer som tilldelats av den här principtilldelningen.

Override

Objekt

Åsidosättning av principegenskapsvärdet.

Name	Typ	Description
kind	OverrideKind	Åsidosättningstyp.
selectors	Selector[]	Listan över väljarens uttryck.
value	string	Värdet för att åsidosätta principegenskapen.

OverrideKind

Uppräkning

Åsidosättningstyp.

Värde	Description
policyEffect	Det kommer att åsidosätta policyeffekten.
definitionVersion	Den kommer att åsidosätta definitionsversionsvärdet för policytilldelningen.

ParameterValuesValue

Objekt

Värdet av en parameter.

Name	Typ	Description
value		Värdet för parametern.