Microsoft.Authorization policyDefinitions
Bicep-resursdefinition
Resurstypen policyDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.
Använd egenskapen för den scope här resursen för att ange omfånget för den här resursen. Se Ange omfång för tilläggsresurser i Bicep.
Resurstypen policyDefinitions kan distribueras med åtgärder som är mål:
- Hanteringsgrupper – Se kommandon för distribution av hanteringsgrupper
- Prenumerationer – Se kommandon för prenumerationsdistribution
Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Authorization/policyDefinitions-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Egenskapsvärden
policyDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: <>*%&:\?+/ eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg. |
| omfång | Använd när du skapar en tilläggsresurs i ett omfång som skiljer sig från distributionsomfånget. | Målresurs För Bicep anger du den här egenskapen till det symboliska namnet på resursen för att tillämpa tilläggsresursen. |
| properties | Principdefinitionsegenskaperna. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Name | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av principdefinitionen. | sträng |
| displayName | Principdefinitionens visningsnamn. | sträng |
| metadata | Principdefinitionsmetadata. Metadata är ett öppet objekt och är vanligtvis en samling nyckel/värde-par. | För Bicep kan du använda funktionen any(). |
| mode | Principdefinitionsläget. Några exempel är Alla, Indexerat, Microsoft.KeyVault.Data. | sträng |
| parametrar | Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen. | ParameterDefinitions |
| policyRule | Principregeln. | För Bicep kan du använda funktionen any(). |
| policyType | Typ av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. | "BuiltIn" "Anpassad" "NotSpecified" "Statisk" |
| version | Principdefinitionsversionen i #.#.#-format. | sträng |
| versioner | En lista över tillgängliga versioner för den här principdefinitionen. | string[] |
ParameterDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | Beskrivning | Värde |
|---|---|---|
| allowedValues | Tillåtna värden för parametern. | any[] |
| Standardvärde | Standardvärdet för parametern om inget värde anges. | För Bicep kan du använda funktionen any(). |
| metadata | Allmänna metadata för parametern . | ParameterDefinitionsValueMetadata |
| schema | 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 objekttypsparametrar och följer implementeringen Json.NET Schema 2019-09. Du kan läsa mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/. |
För Bicep kan du använda funktionen any(). |
| typ | Parameterns datatyp. | Matris "Booleskt" "DateTime" "Float" Heltal "Objekt" "Sträng" |
ParameterDefinitionsValueMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| assignPermissions | Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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. | boolesk |
| beskrivning | Beskrivningen av parametern . | sträng |
| displayName | Visningsnamnet för parametern . | sträng |
| strongType | Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan. | sträng |
| {anpassad egenskap} | För Bicep kan du använda funktionen any(). |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
Distribuera en principdefinition och tilldela till en hanteringsgrupp |
Den här mallen är en mall på hanteringsgruppsnivå som skapar en principdefinition och tilldelar principen till målhanteringsgruppen. Den här mallen kan för närvarande inte distribueras via Azure-portalen. |
| Distribuera en principdefekt och tilldela till flera mgmt-Grupper |
Den här mallen är en mall på hanteringsgruppsnivå som skapar en principdefinition och tilldelar principen till flera hanteringsgrupper. |
| Skapa en Azure Virtual Network Manager och exempel på virtuella nätverk |
Den här mallen distribuerar en Azure Virtual Network Manager och exempel på virtuella nätverk till den namngivna resursgruppen. Den stöder flera anslutningstopologier och medlemskapstyper för nätverksgrupper. |
Resursdefinition för ARM-mall
Resurstypen policyDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.
Använd egenskapen för den scope här resursen för att ange omfånget för den här resursen. Se Ange omfång för tilläggsresurser i ARM-mallar.
Resurstypen policyDefinitions kan distribueras med åtgärder som är mål:
- Hanteringsgrupper – Se kommandon för distribution av hanteringsgrupper
- Prenumerationer – Se kommandon för prenumerationsdistribution
Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Authorization/policyDefinitions-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Egenskapsvärden
policyDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Authorization/policyDefinitions" |
| apiVersion | Resurs-API-versionen | '2023-04-01' |
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: <>*%&:\?+/ eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg. |
| omfång | Använd när du skapar en tilläggsresurs i ett omfång som skiljer sig från distributionsomfånget. | Målresurs För JSON anger du värdet till det fullständiga namnet på resursen som tilläggsresursen ska tillämpas på. |
| properties | Principdefinitionsegenskaperna. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Name | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av principdefinitionen. | sträng |
| displayName | Principdefinitionens visningsnamn. | sträng |
| metadata | Principdefinitionsmetadata. Metadata är ett öppet objekt och är vanligtvis en samling nyckel/värde-par. | |
| mode | Principdefinitionsläget. Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data. | sträng |
| parametrar | Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen. | ParameterDefinitions |
| policyRule | Principregeln. | |
| policyType | Typ av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. | "Inbyggd" "Anpassad" "NotSpecified" "Statisk" |
| version | Principdefinitionsversionen i #.#.#-format. | sträng |
| versioner | En lista över tillgängliga versioner för den här principdefinitionen. | string[] |
ParameterDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | Beskrivning | Värde |
|---|---|---|
| allowedValues | Tillåtna värden för parametern. | any[] |
| Standardvärde | Standardvärdet för parametern om inget värde anges. | |
| metadata | Allmänna metadata för parametern. | ParameterDefinitionsValueMetadata |
| schema | 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 objekttypsparametrar 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/. |
|
| typ | Parameterns datatyp. | Matris "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng" |
ParameterDefinitionsValueMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| assignPermissions | Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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. | boolesk |
| beskrivning | Beskrivningen av parametern. | sträng |
| displayName | Visningsnamnet för parametern. | sträng |
| strongType | Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan. | sträng |
| {anpassad egenskap} |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
| Distribuera en principdefinition och tilldela till en hanteringsgrupp |
Den här mallen är en mall på hanteringsgruppsnivå som skapar en principdefinition och tilldelar principen till målhanteringsgruppen. Den här mallen kan för närvarande inte distribueras via Azure-portalen. |
| Distribuera en principde def och tilldela till flera Mgmt-Grupper |
Den här mallen är en mall på hanteringsgruppsnivå som skapar en principdefinition och tilldelar principen till flera hanteringsgrupper. |
| Skapa en Azure Virtual Network Manager och exempel på virtuella nätverk |
Den här mallen distribuerar en Azure Virtual Network Manager och exempel på virtuella nätverk till den namngivna resursgruppen. Den stöder flera anslutningstopologier och medlemskapstyper för nätverksgrupper. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen policyDefinitions är en tilläggsresurs, vilket innebär att du kan tillämpa den på en annan resurs.
Använd egenskapen för parent_id den här resursen för att ange omfånget för den här resursen.
Resurstypen policyDefinitions kan distribueras med åtgärder som mål:
- Hanteringsgrupper
- Prenumerationer
Du kan referera till den här resurstypen som en skrivskyddad resurs på nivån: Klientorganisationer
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Authorization/policyDefinitions-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Egenskapsvärden
policyDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Authorization/policyDefinitions@2023-04-01" |
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–128 visningsnamn 1–64 resursnamn Giltiga tecken: Visningsnamnet kan innehålla alla tecken. Resursnamnet kan inte använda: <>*%&:\?+/ eller kontrolltecken. Det går inte att avsluta med punkt eller blanksteg. |
| parent_id | ID:t för resursen som den här tilläggsresursen ska tillämpas på. | sträng (krävs) |
| properties | Egenskaperna för principdefinitionen. | PolicyDefinitionEgenskaper |
PolicyDefinitionEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivningen av principdefinitionen. | sträng |
| displayName | Visningsnamnet för principdefinitionen. | sträng |
| metadata | Principdefinitionsmetadata. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar. | |
| mode | Principdefinitionsläget. Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data. | sträng |
| parametrar | Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen. | ParameterDefinitions |
| policyRule | Principregeln. | |
| policyType | Typ av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static. | "BuiltIn" "Anpassad" "NotSpecified" "Statisk" |
| version | Principdefinitionsversionen i #.#.#-format. | sträng |
| versioner | En lista över tillgängliga versioner för den här principdefinitionen. | string[] |
ParameterDefinitions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Name | Beskrivning | Värde |
|---|---|---|
| allowedValues | Tillåtna värden för parametern. | any[] |
| Standardvärde | Standardvärdet för parametern om inget värde anges. | |
| metadata | Allmänna metadata för parametern. | ParameterDefinitionsValueMetadata |
| schema | 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 objekttypsparametrar 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/. |
|
| typ | Parameterns datatyp. | "Matris" "Booleskt" "DateTime" "Flyttal" "Heltal" "Objekt" "Sträng" |
ParameterDefinitionsValueMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| assignPermissions | Ställ in på true om du vill ha Azure Portal skapa rolltilldelningar för 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. | boolesk |
| beskrivning | Beskrivningen av parametern. | sträng |
| displayName | Visningsnamnet för parametern . | sträng |
| strongType | Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan. | sträng |
| {anpassad egenskap} |