Policy Assignments - Create By Id

Usługa:: Policy

Wersja interfejsu API:: 2025-01-01

Tworzy lub aktualizuje przypisanie zasad.
Ta operacja tworzy lub aktualizuje przypisanie polityki o podany identyfikator. Przypisania polityk do zakresu dotyczą wszystkich zasobów zawartych w tym zakresie. Na przykład, gdy przypisujesz politykę do grupy zasobów, ta polityka dotyczy wszystkich zasobów w grupie. ID przypisania polityk mają taki format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Poprawne zakresy to: grupa zarządzania (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subskrypcja (format: '/subscriptions/{subscriptionId}'), grupa zasobów (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', lub zasób (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
policyAssignmentId	path	True	string	ID przypisania polisy do utworzenia. Użyj formatu "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
identity	Identity	Tożsamość zarządzana skojarzona z przypisaniem zasad.
location	string	Lokalizacja przypisania zasad. Wymagane tylko w przypadku korzystania z tożsamości zarządzanej.
properties.assignmentType	assignmentType	Typ przypisania zasad. Możliwe wartości to NotSpecified, System, SystemHidden i Custom. Niezmienne.
properties.definitionVersion	string	Wersja definicji zasad do użycia.
properties.description	string	Ten komunikat będzie częścią odpowiedzi w przypadku naruszenia zasad.
properties.displayName	string	Nazwa wyświetlana przypisania zasad.
properties.enforcementMode	enforcementMode	Tryb wymuszania przypisania zasad. Możliwe wartości to Default, DoNotEnforce i Enroll
properties.metadata	object	Metadane przypisania zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość.
properties.nonComplianceMessages	NonComplianceMessage[]	Komunikaty opisujące, dlaczego zasób jest niezgodny z zasadami.
properties.notScopes	string[]	Wykluczone zakresy zasad.
properties.overrides	Override[]	Wartość właściwości zasad zastępuje.
properties.parameters	<string, ParameterValuesValue>	Wartości parametrów dla przypisanej reguły zasad. Klucze są nazwami parametrów.
properties.policyDefinitionId	string	Identyfikator przypisanej definicji zasad lub definicji zestawu zasad.
properties.resourceSelectors	ResourceSelector[]	Lista selektorów zasobów do filtrowania zasad według właściwości zasobów.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	PolicyAssignment	Utworzone - Zwraca informacje o przeniesieniu polisy.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
assignmentType	Typ przypisania zasad. Możliwe wartości to NotSpecified, System, SystemHidden i Custom. Niezmienne.
CloudError	Odpowiedź na błąd z operacji zasad.
createdByType	Typ tożsamości, która utworzyła zasób.
enforcementMode	Tryb wymuszania przypisania zasad. Możliwe wartości to Default, DoNotEnforce i Enroll
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
Identity	Tożsamość zasobu. Przydziały polityk obsługują maksymalnie jedną tożsamość. Jest to albo tożsamość przypisana przez system, albo pojedynczy użytkownik.
NonComplianceMessage	Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.
Override	Wartość właściwości zasad zastępuje.
OverrideKind	Rodzaj przesłonięcia.
ParameterValuesValue	Wartość parametru.
PolicyAssignment	Przydział polisy.
ResourceIdentityType	Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu.
ResourceSelector	Selektor zasobów do filtrowania zasad według właściwości zasobów.
Selector	Wyrażenie selektora.
SelectorKind	Rodzaj selektora.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentities	Tożsamość użytkownika skojarzona z zasadami. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

assignmentType

Wyliczenie

Typ przypisania zasad. Możliwe wartości to NotSpecified, System, SystemHidden i Custom. Niezmienne.

Wartość	Opis
NotSpecified
System
SystemHidden
Custom

CloudError

Objekt

Odpowiedź na błąd z operacji zasad.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

enforcementMode

Wyliczenie

Tryb wymuszania przypisania zasad. Możliwe wartości to Default, DoNotEnforce i Enroll

Wartość	Opis
Default	Efekt zasad jest wymuszany podczas tworzenia lub aktualizowania zasobów.
DoNotEnforce	Efekt polityki nie jest egzekwowany podczas tworzenia lub aktualizacji zasobów.
Enroll	Efekt polityki nie jest egzekwowany podczas tworzenia lub aktualizacji zasobu, dopóki zasób lub zakres zasobów nie zostanie zarejestrowany w instancji przypisania. Rejestracja następuje po wdrożeniu zasobu do rejestracji polityki.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

Identity

Objekt

Tożsamość zasobu. Przydziały polityk obsługują maksymalnie jedną tożsamość. Jest to albo tożsamość przypisana przez system, albo pojedynczy użytkownik.

Nazwa	Typ	Opis
principalId	string	Główny identyfikator tożsamości zasobu. Ta właściwość będzie dostępna tylko dla tożsamości przypisanej systemowi
tenantId	string	ID tenanta tożsamości zasobu. Ta właściwość będzie dostępna tylko dla tożsamości przypisanej systemowi
type	ResourceIdentityType	Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu.
userAssignedIdentities	UserAssignedIdentities	Tożsamość użytkownika skojarzona z zasadami. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Objekt

Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.

Nazwa	Typ	Opis
message	string	Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.
policyDefinitionReferenceId	string	Identyfikator odwołania definicji zasad w definicji zestawu zasad, dla których jest przeznaczony komunikat. Ma to zastosowanie tylko wtedy, gdy przypisanie zasad przypisuje definicję zestawu zasad. Jeśli nie zostanie podany komunikat dotyczy wszystkich zasad przypisanych przez to przypisanie zasad.

Override

Objekt

Wartość właściwości zasad zastępuje.

Nazwa	Typ	Opis
kind	OverrideKind	Rodzaj przesłonięcia.
selectors	Selector[]	Lista wyrażeń selektora.
value	string	Wartość, aby zastąpić właściwość zasad.

OverrideKind

Wyliczenie

Rodzaj przesłonięcia.

Wartość	Opis
policyEffect	To przeważy nad typem efektu polisy.
definitionVersion	To przeważy nad wartością własności przypisanej przez definiację i wersję.

ParameterValuesValue

Objekt

Wartość parametru.

Nazwa	Typ	Opis
value		Wartość parametru.