Policy Definitions - Create Or Update At Management Group

Service:

Policy

API Version:

2023-04-01

Vytvoří nebo aktualizuje definici zásad ve skupině pro správu.
Tato operace vytvoří nebo aktualizuje definici zásad v dané skupině pro správu s daným názvem.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2023-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
managementGroupId	path	True	string	ID skupiny pro správu.
policyDefinitionName	path	True	string	Název definice zásady, která se má vytvořit. Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.description	string	Popis definice zásady
properties.displayName	string	Zobrazovaný název definice zásady.
properties.metadata	object	Metadata definice zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů.
properties.mode	string	Režim definice zásad. Mezi příklady patří Vše, Indexováno, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>	Definice parametrů pro parametry použité v pravidle zásad. Klíče jsou názvy parametrů.
properties.policyRule	object	Pravidlo zásad.
properties.policyType	policyType	Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické.
properties.version	string	Verze definice zásady ve formátu #.#.#
properties.versions	string[]	Seznam dostupných verzí pro tuto definici zásady

Odpovědi

Name	Typ	Description
201 Created	PolicyDefinition	Vytvořeno – vrátí informace o definici zásady.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Příklady

Create or update a policy definition at management group level

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2023-04-01

{
  "properties": {
    "mode": "All",
    "displayName": "Enforce resource naming convention",
    "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    }
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python create_or_update_policy_definition_at_management_group.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(),
        policy_definition_name="ResourceNaming",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_definitions.create_or_update_at_management_group(
        management_group_id="MyManagementGroup",
        policy_definition_name="ResourceNaming",
        parameters={
            "properties": {
                "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
                "displayName": "Enforce resource naming convention",
                "metadata": {"category": "Naming"},
                "mode": "All",
                "parameters": {
                    "prefix": {
                        "metadata": {"description": "Resource name prefix", "displayName": "Prefix"},
                        "type": "String",
                    },
                    "suffix": {
                        "metadata": {"description": "Resource name suffix", "displayName": "Suffix"},
                        "type": "String",
                    },
                },
                "policyRule": {
                    "if": {
                        "not": {"field": "name", "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"}
                    },
                    "then": {"effect": "deny"},
                },
            }
        },
    )
    print(response)


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

Sample Response

Status code:

201

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

Definice

Name	Description
CloudError	Chybová odpověď z 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ý je možné poskytnout zásadám.
parameterType	Datový typ parametru.
PolicyDefinition	Definice zásady.
policyType	Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Chybová odpověď z operace zásad.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (Tento formát také odpovídá formátu 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	Typ další informace.

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	Nastavte na hodnotu true, aby Azure Portal vytvořit přiřazení rolí podle ID prostředku nebo oboru zdroje tohoto parametru během přiřazování zásad. 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ásad prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat.

ParameterDefinitionsValue

Definice parametru, který je možné 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í samodefinované schématu JSON. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací schématu Json.NET 2019-09. Další informace o používání schémat najdete v https://json-schema.org/ a testování konceptů schémat najdete v tématu 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

PolicyDefinition

Definice zásady.

Name	Typ	Výchozí hodnota	Description
id	string		ID definice zásady.
name	string		Název definice zásady.
properties.description	string		Popis definice zásady
properties.displayName	string		Zobrazovaný název definice zásady.
properties.metadata	object		Metadata definice zásad. Metadata jsou objekt s otevřeným koncem a obvykle se jedná o kolekci párů hodnot klíčů.
properties.mode	string	Indexed	Režim definice zásad. Mezi příklady patří Vše, Indexováno, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>		Definice parametrů pro parametry použité v pravidle zásad. Klíče jsou názvy parametrů.
properties.policyRule	object		Pravidlo zásad.
properties.policyType	policyType		Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické.
properties.version	string		Verze definice zásady ve formátu #.#.#
properties.versions	string[]		Seznam dostupných verzí pro tuto definici zásady
systemData	systemData		Systémová metadata vztahující se k tomuto prostředku.
type	string		Typ prostředku (Microsoft.Authorization/policyDefinitions).

policyType

Typ definice zásad. Možné hodnoty jsou Nezadané, Předdefinované, Vlastní a Statické.

Name	Typ	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.