Policy Set Definitions - Get Built In

Reference

Služba:: Policy

Verze rozhraní API:: 2023-04-01

Načte integrovanou definici sady zásad.
Tato operace načte předdefinované definice sady zásad s daným názvem.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
policySetDefinitionName	path	True	string	Název definice sady zásad, která se má získat. Vzor regulárního výrazu: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Čárkami oddělený seznam dalších vlastností, které se mají zahrnout do odpovědi. Podporované hodnoty jsou LatestDefinitionVersion, EffectiveDefinitionVersion.

policySetDefinitionName

path

True

string

Název definice sady zásad, která se má získat.

Vzor regulárního výrazu: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

api-version

query

True

string

Verze rozhraní API, která se má použít pro tuto operaci.

$expand

query

string

Čárkami oddělený seznam dalších vlastností, které se mají zahrnout do odpovědi. Podporované hodnoty jsou LatestDefinitionVersion, EffectiveDefinitionVersion.

Odpovědi

Name	Typ	Description
200 OK	PolicySetDefinition	OK – Vrátí informace o předdefinované definici sady zásad.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Retrieve a built-in policy set definition

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?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.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_definitions.get_built_in(
        policy_set_definition_name="1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
    )
    print(response)


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

Ukázková odpověď

Stavový kód:: 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",
    "versions": [
      "1.2.1",
      "1.0.0"
    ],
    "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",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
}

Definice

Name	Description
CloudError	Odpověď na chybu operace zásad.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
Metadata	Obecná metadata parametru
ParameterDefinitionsValue	Definice parametru, který lze poskytnout zásadám.
parameterType	Datový typ parametru.
ParameterValuesValue	Hodnota parametru.
PolicyDefinitionGroup	Skupina definic zásad.
PolicyDefinitionReference	Referenční informace k definici zásad.
PolicySetDefinition	Definice sady zásad.
policyType	Typ definice sady zásad. Možné hodnoty jsou NotSpecified, BuiltIn, Custom a Static.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Odpověď na chybu operace zásad.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

Metadata

Obecná metadata parametru

Name	Typ	Description
assignPermissions	boolean	Pokud chcete, aby azure Portal při přiřazování zásad vytvářelo přiřazení rolí pro ID prostředku nebo hodnotu oboru prostředku tohoto parametru. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení.
description	string	Popis parametru.
displayName	string	Zobrazovaný název parametru.
strongType	string	Používá se při přiřazování definice zásady prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat.

ParameterDefinitionsValue

Definice parametru, který lze poskytnout zásadám.

Name	Typ	Description
allowedValues	object[]	Povolené hodnoty parametru.
defaultValue	object	Výchozí hodnota parametru, pokud není zadaná žádná hodnota.
metadata	Metadata	Obecná metadata parametru
schema	object	Poskytuje ověřování vstupů parametrů během přiřazení pomocí schématu JSON definovaného vlastním kódem. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací Json.NET Schema 2019-09. Další informace o používání schémat najdete v tématu https://json-schema.org/ a testování konceptů schémat na https://www.jsonschemavalidator.net/.
type	parameterType	Datový typ parametru.

parameterType

Datový typ parametru.

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

ParameterValuesValue

Hodnota parametru.

Name	Typ	Description
value	object	Hodnota parametru.

PolicyDefinitionGroup

Skupina definic zásad.

Name	Typ	Description
additionalMetadataId	string	ID prostředku prostředku, který obsahuje další metadata o skupině.
category	string	Kategorie skupiny.
description	string	Popis skupiny.
displayName	string	Zobrazovaný název skupiny.
name	string	Název skupiny.

PolicyDefinitionReference

Referenční informace k definici zásad.

Name	Typ	Description
definitionVersion	string	Verze definice zásady, která se má použít.
effectiveDefinitionVersion	string	Platná verze definice zásady, která se používá. Tato možnost se vyskytuje pouze v případě, že se požaduje prostřednictvím parametru dotazu $expand.
groupNames	string[]	Název skupin, do nichž patří tento odkaz na definici zásad.
latestDefinitionVersion	string	K dispozici je nejnovější verze definice zásady. Tato možnost se vyskytuje pouze v případě, že se požaduje prostřednictvím parametru dotazu $expand.
parameters	<string, ParameterValuesValue>	Hodnoty parametrů pro odkazované pravidlo zásad. Klíče jsou názvy parametrů.
policyDefinitionId	string	ID definice zásady nebo definice sady zásad.
policyDefinitionReferenceId	string	Jedinečné ID (v definici sady zásad) pro tento odkaz na definici zásady.