Policy Definitions - Create Or Update At Management Group

Referens

Service:: Policy

API Version:: 2023-04-01

Skapar eller uppdaterar en principdefinition i en hanteringsgrupp.
Den här åtgärden skapar eller uppdaterar en principdefinition i den angivna hanteringsgruppen med det angivna namnet.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
managementGroupId	path	True	string	ID för hanteringsgruppen.
policyDefinitionName	path	True	string	Namnet på den principdefinition som ska skapas. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

managementGroupId

path

True

string

ID för hanteringsgruppen.

policyDefinitionName

path

True

string

Namnet på den principdefinition som ska skapas.

Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

api-version

query

True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.description	string	Beskrivning av principdefinitionen.
properties.displayName	string	Principdefinitionens visningsnamn.
properties.metadata	object	Principdefinitionsmetadata. Metadata är ett öppet objekt och är vanligtvis en samling nyckel/värde-par.
properties.mode	string	Principdefinitionsläget. Några exempel är Alla, Indexerat, Microsoft.KeyVault.Data.
properties.parameters	<string, ParameterDefinitionsValue>	Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen.
properties.policyRule	object	Principregeln.
properties.policyType	policyType	Typ av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
properties.version	string	Principdefinitionsversionen i #.#.#-format.
properties.versions	string[]	En lista över tillgängliga versioner för den här principdefinitionen.

Svar

Name	Typ	Description
201 Created	PolicyDefinition	Skapad – returnerar information om principdefinitionen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

Create or update a policy definition at management group level

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2023-04-01

{
  "properties": {
    "mode": "All",
    "displayName": "Enforce resource naming convention",
    "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    }
  }
}

Sample Response

Status code:: 201

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "ResourceNaming",
  "properties": {
    "mode": "All",
    "displayName": "Naming Convention",
    "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    },
    "policyType": "Custom"
  }
}

Definitioner

Name	Description
CloudError	Ett felsvar från en principåtgärd.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
Metadata	Allmänna metadata för parametern .
ParameterDefinitionsValue	Definitionen av en parameter som kan anges för principen.
parameterType	Parameterns datatyp.
PolicyDefinition	Principdefinitionen.
policyType	Typ av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
systemData	Metadata som rör skapande och senaste ändring av resursen.

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 OData-felsvarsformatet.)

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
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.

Metadata

Allmänna metadata för parametern .

Name	Typ	Description
assignPermissions	boolean	Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.
description	string	Beskrivningen av parametern .
displayName	string	Visningsnamnet för parametern .
strongType	string	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.

ParameterDefinitionsValue

Definitionen av en parameter som kan anges för principen.

Name	Typ	Description
allowedValues	object[]	Tillåtna värden för parametern.
defaultValue	object	Standardvärdet för parametern om inget värde anges.
metadata	Metadata	Allmänna metadata för parametern .
schema	object	Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för objekttypsparametrar och följer implementeringen Json.NET Schema 2019-09. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.
type	parameterType	Parameterns datatyp.

parameterType

Parameterns datatyp.

Name	Typ	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string