Policy Set Definition Versions - List

Referens

Tjänst:: Policy

API-version:: 2023-04-01

Hämtar definitionsversionerna för principuppsättningen för en viss principuppsättningsdefinition i en prenumeration.
Den här åtgärden hämtar en lista över alla definitionsversioner av principuppsättningar för den angivna principuppsättningsdefinitionen.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Namnet på principuppsättningsdefinitionen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
$expand	query		string	Kommaavgränsad lista över ytterligare egenskaper som ska ingå i svaret. Värden som stöds är "LatestDefinitionVersion, EffectiveDefinitionVersion".
$top	query		integer (int32) minimum: 1 maximum: 1000	Maximalt antal poster som ska returneras. När filtret $top inte anges returneras 500 poster.

Svar

Name	Typ	Description
200 OK	PolicySetDefinitionVersionListResult	OK – Returnerar en matris med definitionsversioner för principuppsättningar.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List policy set definitions

Exempelbegäran

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


/**
 * Samples for PolicySetDefinitionVersions List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/
     * listPolicySetDefinitionVersions.json
     */
    /**
     * Sample code: List policy set definitions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPolicySetDefinitions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().policyClient().getPolicySetDefinitionVersions().list("CostManagement", null,
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_policy_set_definition_versions.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.list(
        policy_set_definition_name="CostManagement",
    )
    for item in response:
        print(item)


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

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/listPolicySetDefinitionVersions.json
func ExampleSetDefinitionVersionsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSetDefinitionVersionsClient().NewListPager("CostManagement", &armpolicy.SetDefinitionVersionsClientListOptions{Expand: nil,
		Top: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SetDefinitionVersionListResult = armpolicy.SetDefinitionVersionListResult{
		// 	Value: []*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",
		// 				},
		// 				PolicyDefinitions: []*armpolicy.DefinitionReference{
		// 					{
		// 						DefinitionVersion: to.Ptr("1.*.*"),
		// 						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.*.*"),
		// 						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

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

/**
 * This sample demonstrates how to This operation retrieves a list of all the policy set definition versions for the given policy set definition.
 *
 * @summary This operation retrieves a list of all the policy set definition versions for the given policy set definition.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json
 */
async function listPolicySetDefinitions() {
  const subscriptionId =
    process.env["POLICY_SUBSCRIPTION_ID"] || "ae640e6b-ba3e-4256-9d62-2993eecfa6f2";
  const policySetDefinitionName = "CostManagement";
  const credential = new DefaultAzureCredential();
  const client = new PolicyClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.policySetDefinitionVersions.list(policySetDefinitionName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "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",
        "policyDefinitions": [
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

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.
ParameterValuesValue	Värdet för en parameter.
PolicyDefinitionGroup	Principdefinitionsgruppen.
PolicyDefinitionReference	Referensen för principdefinitionen.
PolicySetDefinitionVersion	Definitionsversionen för principuppsättningen.
PolicySetDefinitionVersionListResult	Lista över definitionsversioner för principuppsättningar.
policyType	Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
systemData	Metadata som rör skapande och senaste ändring av resursen.

CloudError

Objekt

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 formatet för OData-felsvar.)

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

Metadata

Objekt

Allmänna metadata för parametern.

Name	Typ	Description
assignPermissions	boolean	Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på 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

Objekt

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

Name	Typ	Description
allowedValues	object[]	De tillåtna värdena 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 parametrar av objekttyp 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

Uppräkning

Parameterns datatyp.

Värde	Description
Array
Boolean
DateTime
Float
Integer
Object
String

ParameterValuesValue

Objekt

Värdet för en parameter.

Name	Typ	Description
value	object	Värdet för parametern.

PolicyDefinitionGroup

Objekt

Principdefinitionsgruppen.

Name	Typ	Description
additionalMetadataId	string	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.
category	string	Gruppens kategori.
description	string	Gruppens beskrivning.
displayName	string	Gruppens visningsnamn.
name	string	Namnet på gruppen.

PolicyDefinitionReference

Objekt

Referensen för principdefinitionen.

Name	Typ	Description
definitionVersion	string	Den version av principdefinitionen som ska användas.
effectiveDefinitionVersion	string	Den effektiva versionen av principdefinitionen som används. Detta finns bara om det begärs via frågeparametern $expand.
groupNames	string[]	Namnet på de grupper som den här principdefinitionsreferensen tillhör.
latestDefinitionVersion	string	Den senaste versionen av den tillgängliga principdefinitionen. Detta finns bara om det begärs via frågeparametern $expand.
parameters	<string, ParameterValuesValue>	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.
policyDefinitionId	string	ID:t för principdefinitionen eller principuppsättningsdefinitionen.
policyDefinitionReferenceId	string	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.