Policy Set Definitions - Get At Management Group

Servizio:

Policy

Versione API:

2023-04-01

Recupera una definizione del set di criteri.
Questa operazione recupera la definizione del set di criteri nel gruppo di gestione specificato con il nome specificato.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
managementGroupId	path	True	string	ID del gruppo di gestione.
policySetDefinitionName	path	True	string	Nome della definizione del set di criteri da ottenere. Criterio di espressione regolare: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PolicySetDefinition	OK: restituisce informazioni sulla definizione del set di criteri.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Retrieve a policy set definition at management group level

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement?api-version=2023-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_policy_set_definition_at_management_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="CostManagement",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definitions.get_at_management_group(
        management_group_id="MyManagementGroup",
        policy_set_definition_name="CostManagement",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionAtManagementGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:

200

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "CostManagement",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore da un'operazione di criteri.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla 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.
ParameterValuesValue	Valore di un parametro.
PolicyDefinitionGroup	Gruppo di definizione dei criteri.
PolicyDefinitionReference	Riferimento alla definizione dei criteri.
PolicySetDefinition	Definizione del set di criteri.
policyType	Tipo di definizione del set di 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 di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo 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 sulla 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 nel valore dell'ID risorsa o 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 per assegnare la definizione dei criteri tramite il portale. Fornisce un elenco di valori con riconoscimento del contesto da cui scegliere l'utente.

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 auto-definito. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema Json.NET schema 2019-09. Per altre informazioni sull'uso di schemi https://json-schema.org/ in e schemi di test, vedere 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

ParameterValuesValue

Valore di un parametro.

Nome	Tipo	Descrizione
value	object	Valore del parametro.

PolicyDefinitionGroup

Gruppo di definizione dei criteri.

Nome	Tipo	Descrizione
additionalMetadataId	string	ID risorsa di una risorsa contenente metadati aggiuntivi sul gruppo.
category	string	Categoria del gruppo.
description	string	Descrizione del gruppo.
displayName	string	il nome visualizzato del gruppo.
name	string	Nome del gruppo.

PolicyDefinitionReference

Riferimento alla definizione dei criteri.

Nome	Tipo	Descrizione
groupNames	string[]	Nome dei gruppi a cui appartiene questo riferimento alla definizione dei criteri.
parameters	<string,  ParameterValuesValue>	Valori dei parametri per la regola dei criteri a cui si fa riferimento. Le chiavi sono i nomi dei parametri.
policyDefinitionId	string	ID della definizione o del set di criteri.
policyDefinitionReferenceId	string	ID univoco (all'interno della definizione del set di criteri) per questo riferimento alla definizione dei criteri.

PolicySetDefinition

Definizione del set di criteri.

Nome	Tipo	Descrizione
id	string	ID della definizione del set di criteri.
name	string	Nome della definizione del set di criteri.
properties.description	string	Descrizione della definizione del set di criteri.
properties.displayName	string	Nome visualizzato della definizione del set di criteri.
properties.metadata	object	Metadati delle definizioni del set di criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie di valori chiave.
properties.parameters	<string,  ParameterDefinitionsValue>	Parametri di definizione del set di criteri che possono essere usati nei riferimenti alle definizioni dei criteri.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	I metadati che descrivono i gruppi di riferimenti alle definizioni dei criteri all'interno della definizione del set di criteri.
properties.policyDefinitions	PolicyDefinitionReference[]	Matrice di riferimenti alla definizione dei criteri.
properties.policyType	policyType	Tipo di definizione del set di criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.
properties.version	string	Versione della definizione del set di criteri in formato #.#.# .
properties.versions	string[]	Elenco delle versioni disponibili per questa definizione del set di criteri.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo della risorsa (Microsoft.Authorization/policySetDefinitions).

policyType

Tipo di definizione del set di criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.

Nome	Tipo	Descrizione
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.