Policy Definitions - Create Or Update At Management Group

Riferimento

Service:: Policy

API Version:: 2023-04-01

Crea o aggiorna una definizione di criteri in un gruppo di gestione.
Questa operazione crea o aggiorna una definizione di criteri nel gruppo di gestione specificato con il nome specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
managementGroupId	path	True	string	ID del gruppo di gestione.
policyDefinitionName	path	True	string	Nome della definizione dei criteri da creare. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

managementGroupId

path

True

string

ID del gruppo di gestione.

policyDefinitionName

path

True

string

Nome della definizione dei criteri da creare.

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

api-version

query

True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.description	string	Descrizione della definizione dei criteri.
properties.displayName	string	Nome visualizzato della definizione dei criteri.
properties.metadata	object	Metadati della definizione dei criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie chiave-valore.
properties.mode	string	Modalità di definizione dei criteri. Alcuni esempi sono All, Indexed, Microsoft.KeyVault.Data.
properties.parameters	<string, ParameterDefinitionsValue>	Definizioni dei parametri per i parametri usati nella regola dei criteri. Le chiavi sono i nomi dei parametri.
properties.policyRule	object	Regola dei criteri.
properties.policyType	policyType	Tipo di definizione dei criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.
properties.version	string	Versione della definizione dei criteri in formato #.#.#.
properties.versions	string[]	Elenco delle versioni disponibili per questa definizione di criteri.

Risposte

Nome	Tipo	Descrizione
201 Created	PolicyDefinition	Creato: restituisce informazioni sulla definizione dei criteri.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
CloudError	Risposta di errore da un'operazione di criteri.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore
Metadata	Metadati generali per il parametro .
ParameterDefinitionsValue	Definizione di un parametro che può essere fornito ai criteri.
parameterType	Tipo di dati del parametro.
PolicyDefinition	Definizione dei criteri.
policyType	Tipo di definizione dei criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Risposta di errore da un'operazione di criteri.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API Resource Manager di Azure per restituire i dettagli dell'errore per le operazioni non riuscite. Segue anche il formato di risposta di errore OData.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

Metadata

Metadati generali per il parametro .

Nome	Tipo	Descrizione
assignPermissions	boolean	Impostare su true per avere portale di Azure creare assegnazioni di ruolo nell'ID risorsa o nel valore dell'ambito della risorsa di questo parametro durante l'assegnazione dei criteri. Questa proprietà è utile nel caso in cui si desideri assegnare autorizzazioni al di fuori dell'ambito di assegnazione.
description	string	Descrizione del parametro.
displayName	string	Nome visualizzato per il parametro.
strongType	string	Usato quando si assegna la definizione dei criteri tramite il portale. Fornisce un elenco di valori che riconosce il contesto tra cui l'utente può scegliere.

ParameterDefinitionsValue

Definizione di un parametro che può essere fornito ai criteri.

Nome	Tipo	Descrizione
allowedValues	object[]	Valori consentiti per il parametro .
defaultValue	object	Valore predefinito per il parametro se non viene specificato alcun valore.
metadata	Metadata	Metadati generali per il parametro .
schema	object	Fornisce la convalida degli input dei parametri durante l'assegnazione usando uno schema JSON self-defined. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema 2019-09 Json.NET. Per altre informazioni sull'uso degli schemi, vedere https://json-schema.org/ e testare gli schemi bozza all'indirizzo https://www.jsonschemavalidator.net/.
type	parameterType	Tipo di dati del parametro.

parameterType

Tipo di dati del parametro.

Nome	Tipo	Descrizione
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string