Policy Set Definition Versions - Get

Service:

Policy

API-versie:

2023-04-01

Hiermee wordt een definitieversie van een beleidsset opgehaald.
Met deze bewerking wordt de definitieversie van de beleidsset in het opgegeven abonnement opgehaald met de opgegeven naam en versie.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2023-04-01

Met optionele parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?$expand={$expand}&api-version=2023-04-01

URI-parameters

Name	In	Vereist	Type	Description
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	De definitieversie van de beleidsset. De notatie is x.y.z waarbij x het primaire versienummer is, y het secundaire versienummer is en z het patchnummer is
policySetDefinitionName	path	True	string pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$	De naam van de definitie van de beleidsset.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$expand	query		string	Door komma's gescheiden lijst met aanvullende eigenschappen die moeten worden opgenomen in het antwoord. Ondersteunde waarden zijn 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

Antwoorden

Name	Type	Description
200 OK	PolicySetDefinitionVersion	OK: retourneert informatie over de definitieversie van de beleidsset.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Retrieve a policy set definition version

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2023-04-01

Java

/**
 * Samples for PolicySetDefinitionVersions Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/
     * getPolicySetDefinitionVersion.json
     */
    /**
     * Sample code: Retrieve a policy set definition version.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void retrieveAPolicySetDefinitionVersion(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicySetDefinitionVersions()
            .getWithResponse("CostManagement", "1.2.1", null, com.azure.core.util.Context.NONE);
    }
}

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

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_version.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(),
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_set_definition_versions.get(
        policy_set_definition_name="CostManagement",
        policy_definition_version="1.2.1",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.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

Go

package armpolicy_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armpolicy"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/219b2e3ef270f18149774eb2793b48baacde982f/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json
func ExampleSetDefinitionVersionsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicy.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSetDefinitionVersionsClient().Get(ctx, "CostManagement", "1.2.1", &armpolicy.SetDefinitionVersionsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SetDefinitionVersion = armpolicy.SetDefinitionVersion{
	// 	Name: to.Ptr("1.2.1"),
	// 	Type: to.Ptr("Microsoft.Authorization/policySetDefinitions/versions"),
	// 	ID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1"),
	// 	Properties: &armpolicy.SetDefinitionVersionProperties{
	// 		Description: to.Ptr("Policies to enforce low cost storage SKUs"),
	// 		DisplayName: to.Ptr("Cost Management"),
	// 		Metadata: map[string]any{
	// 			"category": "Cost Management",
	// 		},
	// 		PolicyDefinitionGroups: []*armpolicy.DefinitionGroup{
	// 			{
	// 				Name: to.Ptr("CostSaving"),
	// 				Description: to.Ptr("Policies designed to control spend within a subscription."),
	// 				DisplayName: to.Ptr("Cost Management Policies"),
	// 			},
	// 			{
	// 				Name: to.Ptr("Organizational"),
	// 				Description: to.Ptr("Policies that help enforce resource organization standards within a subscription."),
	// 				DisplayName: to.Ptr("Organizational Policies"),
	// 		}},
	// 		PolicyDefinitions: []*armpolicy.DefinitionReference{
	// 			{
	// 				DefinitionVersion: to.Ptr("1.*.*"),
	// 				GroupNames: []*string{
	// 					to.Ptr("CostSaving")},
	// 					Parameters: map[string]*armpolicy.ParameterValuesValue{
	// 						"listOfAllowedSKUs": &armpolicy.ParameterValuesValue{
	// 							Value: []any{
	// 								"Standard_GRS",
	// 								"Standard_LRS",
	// 							},
	// 						},
	// 					},
	// 					PolicyDefinitionID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
	// 					PolicyDefinitionReferenceID: to.Ptr("Limit_Skus"),
	// 				},
	// 				{
	// 					DefinitionVersion: to.Ptr("1.*.*"),
	// 					GroupNames: []*string{
	// 						to.Ptr("Organizational")},
	// 						Parameters: map[string]*armpolicy.ParameterValuesValue{
	// 							"prefix": &armpolicy.ParameterValuesValue{
	// 								Value: "DeptA",
	// 							},
	// 							"suffix": &armpolicy.ParameterValuesValue{
	// 								Value: "-LC",
	// 							},
	// 						},
	// 						PolicyDefinitionID: to.Ptr("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
	// 						PolicyDefinitionReferenceID: to.Ptr("Resource_Naming"),
	// 				}},
	// 				Version: to.Ptr("1.2.1"),
	// 			},
	// 		}
}

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

JavaScript

const { PolicyClient } = require("@azure/arm-policy");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to This operation retrieves the policy set definition version in the given subscription with the given name and version.
 *
 * @summary This operation retrieves the policy set definition version in the given subscription with the given name and version.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json
 */
async function retrieveAPolicySetDefinitionVersion() {
  const subscriptionId =
    process.env["POLICY_SUBSCRIPTION_ID"] || "ae640e6b-ba3e-4256-9d62-2993eecfa6f2";
  const policySetDefinitionName = "CostManagement";
  const policyDefinitionVersion = "1.2.1";
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const result = await client.policySetDefinitionVersions.get(
    policySetDefinitionName,
    policyDefinitionVersion,
  );
  console.log(result);
}

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

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "name": "1.2.1",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "version": "1.2.1",
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

Definities

Name	Description
CloudError	Een foutbericht van een beleidsbewerking.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
Metadata	Algemene metagegevens voor de parameter.
ParameterDefinitionsValue	De definitie van een parameter die aan het beleid kan worden verstrekt.
parameterType	Het gegevenstype van de parameter.
ParameterValuesValue	De waarde van een parameter.
PolicyDefinitionGroup	De beleidsdefinitiegroep.
PolicyDefinitionReference	De verwijzing naar de beleidsdefinitie.
PolicySetDefinitionVersion	De definitieversie van de beleidsset.
policyType	Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Object

Een foutbericht van een beleidsbewerking.

Name	Type	Description
error	ErrorResponse	Foutreactie Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactie-indeling.)

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorResponse

Object

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

Metadata

Object

Algemene metagegevens voor de parameter.

Name	Type	Description
assignPermissions	boolean	Ingesteld op waar als u azure Portal roltoewijzingen wilt laten maken voor de resource-id of resourcebereikwaarde van deze parameter tijdens het toewijzen van het beleid. Deze eigenschap is handig als u machtigingen wilt toewijzen buiten het toewijzingsbereik.
description	string	De beschrijving van de parameter.
displayName	string	De weergavenaam voor de parameter.
strongType	string	Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen.

ParameterDefinitionsValue

Object

De definitie van een parameter die aan het beleid kan worden verstrekt.

Name	Type	Description
allowedValues	object[]	De toegestane waarden voor de parameter.
defaultValue	object	De standaardwaarde voor de parameter als er geen waarde wordt opgegeven.
metadata	Metadata	Algemene metagegevens voor de parameter.
schema	object	Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelfgedefinieerde JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de Json.NET Schema 2019-09-implementatie. U vindt meer informatie over het gebruik van schema's op https://json-schema.org/ en het testen van conceptschema's op https://www.jsonschemavalidator.net/.
type	parameterType	Het gegevenstype van de parameter.

parameterType

Inventarisatie

Het gegevenstype van de parameter.

Waarde	Description
Array
Boolean
DateTime
Float
Integer
Object
String

ParameterValuesValue

Object

De waarde van een parameter.

Name	Type	Description
value	object	De waarde van de parameter.

PolicyDefinitionGroup

Object

De beleidsdefinitiegroep.

Name	Type	Description
additionalMetadataId	string	Een resource-id van een resource die aanvullende metagegevens over de groep bevat.
category	string	De categorie van de groep.
description	string	De beschrijving van de groep.
displayName	string	De weergavenaam van de groep.
name	string	De naam van de groep.

PolicyDefinitionReference

Object

De verwijzing naar de beleidsdefinitie.

Name	Type	Description
definitionVersion	string	De versie van de te gebruiken beleidsdefinitie.
effectiveDefinitionVersion	string	De effectieve versie van de gebruikte beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
groupNames	string[]	De naam van de groepen waartoe deze beleidsdefinitiereferentie behoort.
latestDefinitionVersion	string	De nieuwste versie van de beschikbare beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
parameters	<string,  ParameterValuesValue>	De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen.
policyDefinitionId	string	De id van de beleidsdefinitie of beleidssetdefinitie.
policyDefinitionReferenceId	string	Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities.

PolicySetDefinitionVersion

Object

De definitieversie van de beleidsset.

Name	Type	Description
id	string	De id van de definitieversie van de beleidsset.
name	string	De naam van de definitieversie van de beleidsset.
properties.description	string	De beschrijving van de definitie van de beleidsset.
properties.displayName	string	De weergavenaam van de definitie van de beleidsset.
properties.metadata	object	De metagegevens van de definitie van de beleidsset. Metagegevens zijn een geopend object en zijn meestal een verzameling sleutel-waardeparen.
properties.parameters	<string,  ParameterDefinitionsValue>	De parameters voor beleidssetdefinities die kunnen worden gebruikt in verwijzingen naar beleidsdefinities.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	De metagegevens die groepen beleidsdefinitieverwijzingen beschrijven binnen de beleidssetdefinitie.
properties.policyDefinitions	PolicyDefinitionReference[]	Een matrix met beleidsdefinitieverwijzingen.
properties.policyType	policyType	Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
properties.version	string	De definitieversie van de beleidsset in #.#.# -indeling.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource (Microsoft.Authorization/policySetDefinitions/versions).

policyType

Inventarisatie

Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

Waarde	Description
BuiltIn
Custom
NotSpecified
Static

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.