Dela via

Policy Definition Versions - List

  • Referens
Tjänst:
Policy
API-version:
2023-04-01

Hämtar principdefinitionsversioner för en viss principdefinition i en prenumeration
Den här åtgärden hämtar en lista över alla principdefinitionsversioner för den angivna principdefinitionen.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions?api-version=2023-04-01
Med valfria parametrar: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions?api-version=2023-04-01&$top={$top}

URI-parametrar

Name I Obligatorisk Typ Description
policyDefinitionName
 path True

string

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

Namnet på principdefinitionen.
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.
$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

PolicyDefinitionVersionListResult

OK – Returnerar en matris med principdefinitionsversioner.
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 definition versions by subscription

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "value": [
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.2.1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.0.0",
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '-*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/versions/1.0.0",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "1.0.0"
    }
  ]
}

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.
PolicyDefinitionVersion

ID för principdefinitionsversionen.
PolicyDefinitionVersionListResult

Lista över principdefinitionsversioner.
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

PolicyDefinitionVersion

Objekt

ID för principdefinitionsversionen.

Name Typ Standardvärde Description
id

string

ID för principdefinitionsversionen.
name

string

Namnet på principdefinitionsversionen.
properties.description

string

Beskrivningen av principdefinitionen.
properties.displayName

string

Principdefinitionens visningsnamn.
properties.metadata

object

Metadata för principdefinition. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
properties.mode

string

Indexed

Principdefinitionsläget. Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data.
properties.parameters

<string,  ParameterDefinitionsValue>

Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen.
properties.policyRule

object

Principregeln.
properties.policyType

policyType

Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
properties.version

string

Principdefinitionsversionen i #.#.#-format.
systemData

systemData

Systemmetadata för den här resursen.
type

string

Resurstypen (Microsoft.Authorization/policyDefinitions/versions).

PolicyDefinitionVersionListResult

Objekt

Lista över principdefinitionsversioner.

Name Typ Description
nextLink

string

Den URL som ska användas för att hämta nästa uppsättning resultat.
value

PolicyDefinitionVersion[]

En matris med principdefinitionsversioner.

policyType

Uppräkning

Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.

Värde Description
BuiltIn
Custom
NotSpecified
Static

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.