Policy Set Definition Versions - Get

Szolgáltatás:

Policy

API-verzió:

2023-04-01

Lekéri a szabályzatkészlet definíciójának verzióját.
Ez a művelet lekéri a szabályzatkészlet definíciós verzióját az adott előfizetésben a megadott névvel és verzióval.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	A szabályzatkészlet definíciójának verziója. A formátum x.y.z, ahol az x a főverzió száma, y az alverzió száma, z pedig a javítás száma
policySetDefinitionName	path	True	string pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$	A szabályzatkészlet definíciójának neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$expand	query		string	A válaszban szerepeltetni kívánt további tulajdonságok vesszővel tagolt listája. A támogatott értékek a "LatestDefinitionVersion, EffectiveDefinitionVersion".

Válaszok

Name	Típus	Description
200 OK	PolicySetDefinitionVersion	OK – A szabályzatkészlet definíciójának verziójával kapcsolatos információkat adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Retrieve a policy set definition version

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
CloudError	Egy szabályzatművelet hibaválasza.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
Metadata	A paraméter általános metaadatai.
ParameterDefinitionsValue	A szabályzatnak megadható paraméter definíciója.
parameterType	A paraméter adattípusa.
ParameterValuesValue	Egy paraméter értéke.
PolicyDefinitionGroup	A szabályzatdefiníciós csoport.
PolicyDefinitionReference	A szabályzatdefiníció referenciája.
PolicySetDefinitionVersion	A szabályzatkészlet definíciójának verziója.
policyType	A szabályzatdefiníció típusa. A lehetséges értékek nem meghatározottak, beépítettek, egyéniek és statikusak.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

CloudError

Objektum

Egy szabályzatművelet hibaválasza.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

Metadata

Objektum

A paraméter általános metaadatai.

Name	Típus	Description
assignPermissions	boolean	Állítsa igaz értékre, hogy az Azure Portal szerepkör-hozzárendeléseket hozzon létre a paraméter erőforrás-azonosítóján vagy erőforrás-hatókörének értékén a szabályzat-hozzárendelés során. Ez a tulajdonság akkor hasznos, ha a hozzárendelés hatókörén kívül szeretne engedélyeket hozzárendelni.
description	string	A paraméter leírása.
displayName	string	A paraméter megjelenítendő neve.
strongType	string	A szabályzatdefiníció portálon keresztüli hozzárendeléséhez használatos. A felhasználó által kiválasztandó értékek környezettudatos listáját tartalmazza.

ParameterDefinitionsValue

Objektum

A szabályzatnak megadható paraméter definíciója.

Name	Típus	Description
allowedValues	object[]	A paraméter megengedett értékei.
defaultValue	object	A paraméter alapértelmezett értéke, ha nincs megadva érték.
metadata	Metadata	A paraméter általános metaadatai.
schema	object	A paraméterbemenetek ellenőrzését biztosítja a hozzárendelés során egy ön által definiált JSON-sémával. Ez a tulajdonság csak objektumtípus-paraméterek esetén támogatott, és a Json.NET Schema 2019-09 implementációt követi. A sémák használatáról a https://json-schema.org/ és a vázlatsémák tesztelése a https://www.jsonschemavalidator.net/.
type	parameterType	A paraméter adattípusa.

parameterType

Enumerálás

A paraméter adattípusa.

Érték	Description
Array
Boolean
DateTime
Float
Integer
Object
String

ParameterValuesValue

Objektum

Egy paraméter értéke.

Name	Típus	Description
value	object	A paraméter értéke.

PolicyDefinitionGroup

Objektum

A szabályzatdefiníciós csoport.

Name	Típus	Description
additionalMetadataId	string	Egy erőforrás erőforrás-azonosítója, amely további metaadatokat tartalmaz a csoportról.
category	string	A csoport kategóriája.
description	string	A csoport leírása.
displayName	string	A csoport megjelenítendő neve.
name	string	A csoport neve.

PolicyDefinitionReference

Objektum

A szabályzatdefiníció referenciája.

Name	Típus	Description
definitionVersion	string	A használni kívánt szabályzatdefiníció verziója.
effectiveDefinitionVersion	string	A használt szabályzatdefiníció érvényes verziója. Ez csak akkor jelenik meg, ha a $expand lekérdezési paraméteren keresztül kéri.
groupNames	string[]	Azon csoportok neve, amelyekhez ez a szabályzatdefiníció hivatkozik.
latestDefinitionVersion	string	A szabályzatdefiníció legújabb verziója érhető el. Ez csak akkor jelenik meg, ha a $expand lekérdezési paraméteren keresztül kéri.
parameters	<string,  ParameterValuesValue>	A hivatkozott szabályzatszabály paraméterértékei. A kulcsok a paraméternevek.
policyDefinitionId	string	A szabályzatdefiníció vagy a szabályzatkészlet definíciójának azonosítója.
policyDefinitionReferenceId	string	A szabályzatdefiníciós referencia egyedi azonosítója (a szabályzatkészlet-definíción belül).

PolicySetDefinitionVersion

Objektum

A szabályzatkészlet definíciójának verziója.

Name	Típus	Description
id	string	A szabályzatkészlet definíciós verziójának azonosítója.
name	string	A szabályzatkészlet definíciós verziójának neve.
properties.description	string	A szabályzatkészlet definíciójának leírása.
properties.displayName	string	A szabályzatkészlet definíciójának megjelenítendő neve.
properties.metadata	object	A szabályzatkészlet definíciójának metaadatai. A metaadatok egy nyitott végű objektum, amely általában kulcsértékpárok gyűjteménye.
properties.parameters	<string,  ParameterDefinitionsValue>	A szabályzatdefiníció-hivatkozásokban használható szabályzatkészletdefiníciós paraméterek.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	A szabályzatdefiníció-hivatkozások csoportjait leíró metaadatok a szabályzatkészlet-definíción belül.
properties.policyDefinitions	PolicyDefinitionReference[]	Szabályzatdefiníciós hivatkozások tömbje.
properties.policyType	policyType	A szabályzatdefiníció típusa. A lehetséges értékek nem meghatározottak, beépítettek, egyéniek és statikusak.
properties.version	string	A szabályzatkészlet definíciójának verziója #.#.# formátumban.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa (Microsoft.Authorization/policySetDefinitions/versions).

policyType

Enumerálás

A szabályzatdefiníció típusa. A lehetséges értékek nem meghatározottak, beépítettek, egyéniek és statikusak.

Érték	Description
BuiltIn
Custom
NotSpecified
Static

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.