Dela via


Policy Exemptions - Create Or Update

Den här åtgärden skapar eller uppdaterar ett principundantag med angivet omfång och namn. Principundantag gäller för alla resurser som ingår i deras omfång. När du till exempel skapar ett principundantag i resursgruppsomfånget för en principtilldelning på samma nivå eller högre, undantas undantaget för alla tillämpliga resurser i resursgruppen.

PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}?api-version=2022-07-01-preview

URI-parametrar

Name I Obligatorisk Typ Description
policyExemptionName
path True

string

Namnet på principundantaget som ska tas bort.

scope
path True

string

Omfånget för principundantaget. Giltiga omfång är: hanteringsgrupp (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}'

api-version
query True

string

DEN API-version som ska användas för åtgärden.

Begärandetext

Name Obligatorisk Typ Description
properties.exemptionCategory True

exemptionCategory

Kategorin för principundantag. Möjliga värden är Undantag och Minimerade.

properties.policyAssignmentId True

string

ID:t för den principtilldelning som undantas.

properties.assignmentScopeValidation

AssignmentScopeValidation

Alternativet om du vill verifiera undantaget finns i eller under tilldelningsomfånget.

properties.description

string

Beskrivningen av principundantaget.

properties.displayName

string

Visningsnamnet för principundantaget.

properties.expiresOn

string (date-time)

Förfallodatum och tid (i UTC ISO 8601-format åå-MM-ddTHH:mm:ssZ) för principundantaget.

properties.metadata

object

Metadata för principundantag. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.

properties.policyDefinitionReferenceIds

string[]

Referens-ID-listan för principdefinition när den associerade principtilldelningen är en tilldelning av en principuppsättningsdefinition.

properties.resourceSelectors

ResourceSelector[]

Listan över resursväljare för att filtrera principer efter resursegenskaper.

Svar

Name Typ Description
200 OK

PolicyExemption

OK – Returnerar information om det uppdaterade principundantaget.

201 Created

PolicyExemption

Skapad – Returnerar information om det nya principundantaget.

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 a policy exemption
Create or update a policy exemption with resource selectors

Create or update a policy exemption

Exempelbegäran

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM?api-version=2022-07-01-preview

{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    }
  }
}

Exempelsvar

{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-07-01T01:01:01.1075056Z"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM",
  "type": "Microsoft.Authorization/policyExemptions",
  "name": "DemoExpensiveVM"
}
{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM",
  "type": "Microsoft.Authorization/policyExemptions",
  "name": "DemoExpensiveVM"
}

Create or update a policy exemption with resource selectors

Exempelbegäran

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM?api-version=2022-07-01-preview

{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    },
    "assignmentScopeValidation": "Default",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  }
}

Exempelsvar

{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    },
    "assignmentScopeValidation": "Default",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-07-01T01:01:01.1075056Z"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM",
  "type": "Microsoft.Authorization/policyExemptions",
  "name": "DemoExpensiveVM"
}
{
  "properties": {
    "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
    "policyDefinitionReferenceIds": [
      "Limit_Skus"
    ],
    "exemptionCategory": "Waiver",
    "displayName": "Exempt demo cluster",
    "description": "Exempt demo cluster from limit sku",
    "metadata": {
      "reason": "Temporary exemption for a expensive VM demo"
    },
    "assignmentScopeValidation": "Default",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM",
  "type": "Microsoft.Authorization/policyExemptions",
  "name": "DemoExpensiveVM"
}

Definitioner

Name Description
AssignmentScopeValidation

Alternativet om du vill verifiera undantaget finns i eller under tilldelningsomfånget.

CloudError

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

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorResponse

Felsvar

exemptionCategory

Kategorin för principundantag. Möjliga värden är Undantag och Minimerade.

PolicyExemption

Principundantaget.

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.

AssignmentScopeValidation

Alternativet om du vill verifiera undantaget finns i eller under tilldelningsomfånget.

Värde Description
Default

Det här alternativet verifierar att undantaget finns i eller under tilldelningsomfånget.

DoNotValidate

Det här alternativet kringgår valideringen av undantagsomfånget i eller under principtilldelningsomfånget.

CloudError

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 felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.)

createdByType

Den typ av identitet som skapade resursen.

Värde Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorResponse

Felsvar

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorResponse[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

exemptionCategory

Kategorin för principundantag. Möjliga värden är Undantag och Minimerade.

Värde Description
Mitigated

Den här kategorin av undantag innebär vanligtvis att åtgärdsåtgärderna har tillämpats på omfånget.

Waiver

Den här kategorin av undantag innebär vanligtvis att omfånget inte är tillämpligt för principen.

PolicyExemption

Principundantaget.

Name Typ Standardvärde Description
id

string

ID för principundantaget.

name

string

Namnet på principundantaget.

properties.assignmentScopeValidation

AssignmentScopeValidation

Default

Alternativet om du vill verifiera undantaget finns i eller under tilldelningsomfånget.

properties.description

string

Beskrivningen av principundantaget.

properties.displayName

string

Visningsnamnet för principundantaget.

properties.exemptionCategory

exemptionCategory

Kategorin för principundantag. Möjliga värden är Undantag och Minimerade.

properties.expiresOn

string (date-time)

Förfallodatum och tid (i UTC ISO 8601-format åå-MM-ddTHH:mm:ssZ) för principundantaget.

properties.metadata

object

Metadata för principundantag. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.

properties.policyAssignmentId

string

ID:t för den principtilldelning som undantas.

properties.policyDefinitionReferenceIds

string[]

Referens-ID-listan för principdefinition när den associerade principtilldelningen är en tilldelning av en principuppsättningsdefinition.

properties.resourceSelectors

ResourceSelector[]

Listan över resursväljare för att filtrera principer efter resursegenskaper.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

type

string

Resurstypen (Microsoft.Authorization/policyExemptions).

ResourceSelector

Resursväljaren som filtrerar principer efter resursegenskaper.

Name Typ Description
name

string

Namnet på resursväljaren.

selectors

Selector[]

Listan över väljarens uttryck.

Selector

Väljarens uttryck.

Name Typ Description
in

string[]

Listan med värden som ska filtreras in.

kind

SelectorKind

Väljarens typ.

notIn

string[]

Listan med värden som ska filtreras bort.

SelectorKind

Väljarens typ.

Värde Description
policyDefinitionReferenceId

Väljarens typ för att filtrera principer efter principdefinitionens referens-ID.

resourceLocation

Väljarens typ för att filtrera principer efter resursplatsen.

resourceType

Väljarens typ för att filtrera principer efter resurstyp.

resourceWithoutLocation

Väljarens typ för att filtrera principer efter resursen utan plats.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.