Policy Set Definition Versions - Get Built In

Referens

Tjänst:: Policy

API-version:: 2023-04-01

Hämtar en inbyggd definitionsversion av principuppsättningen.
Den här åtgärden hämtar den inbyggda principuppsättningsdefinitionsversionen med förnamn och version.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
policyDefinitionVersion	path	True	string	Definitionsversionen för principuppsättningen. Formatet är x.y.z där x är huvudversionsnumret, y är delversionsnumret och z är korrigeringsnumret Reguljärt uttrycksmönster: `^\d+\.\d+\.\d+$`
policySetDefinitionName	path	True	string	Namnet på principuppsättningsdefinitionen. Reguljärt uttrycksmönster: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	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".

Svar

Name	Typ	Description
200 OK	PolicySetDefinitionVersion	OK – Returnerar information om den inbyggda definitionsversionen för principuppsättningen.
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

Retrieve a built-in policy set definition version

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8/versions/1.2.1?api-version=2023-04-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_built_in_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="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definition_versions.get_built_in(
        policy_set_definition_name="1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
        policy_definition_version="1.2.1",
    )
    print(response)


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

Exempelsvar

Statuskod:: 200

{
  "properties": {
    "displayName": "[Preview]: Enable Monitoring in Azure Security Center",
    "policyType": "BuiltIn",
    "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.",
    "metadata": {
      "category": "Security Center"
    },
    "version": "1.2.1",
    "parameters": {},
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId1"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId2"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId3"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId4"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId5"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId6"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId7"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId8"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId9"
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "RefId10"
      }
    ]
  },
  "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8/versions/1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "name": "1.2.1"
}

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

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

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

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

ErrorResponse

Felsvar

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

Metadata

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

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

Parameterns datatyp.

Name	Typ	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Värdet för en parameter.

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

PolicyDefinitionGroup

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

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.