Microsoft.Authorization policySetDefinitions 2023-04-01
Bicep-resourcedefinitie
Het resourcetype policySetDefinitions is een extensieresource, wat betekent dat u deze kunt toepassen op een andere resource.
Gebruik de scope
eigenschap voor deze resource om het bereik voor deze resource in te stellen. Zie Bereik instellen voor extensieresources in Bicep.
Het resourcetype policySetDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Beheergroepen : zie implementatieopdrachten voor beheergroepen
- Abonnementen - Zie opdrachten voor abonnementsimplementatie
U kunt naar dit resourcetype verwijzen als een alleen-lezen resource op het niveau van: Tenants
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.Authorization/policySetDefinitions wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Eigenschapswaarden
policySetDefinitions
Naam | Description | Waarde |
---|---|---|
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 1-128 weergavenaam Resourcenaam 1-64 Geldige tekens: De weergavenaam kan tekens bevatten. Resourcenaam kan het volgende niet gebruiken: <>*%&:\?.+/ of besturingstekens. Kan niet eindigen met punt of spatie. |
scope | Gebruik deze optie bij het maken van een extensieresource voor een ander bereik dan het implementatiebereik. | Doelbron Stel voor Bicep deze eigenschap in op de symbolische naam van de resource om de extensieresource toe te passen. |
properties | De definitie-eigenschappen van de beleidsset. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
Naam | Description | Waarde |
---|---|---|
beschrijving | De beschrijving van de definitie van de beleidsset. | tekenreeks |
displayName | De weergavenaam van de definitie van de beleidsset. | tekenreeks |
metagegevens | De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-eindobject en zijn meestal een verzameling sleutelwaardeparen. | Voor Bicep kunt u de functie any() gebruiken. |
parameters | De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities. | ParameterDefinitions |
policyDefinitionGroups | De metagegevens die groepen verwijzingen naar beleidsdefinities binnen de definitie van de beleidsset beschrijven. | PolicyDefinitionGroup[] |
policyDefinitions | Een matrix met verwijzingen naar beleidsdefinities. | PolicyDefinitionReference[] (vereist) |
policyType | Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static. | 'BuiltIn' 'Aangepast' 'Niet opgegeven' Statisch |
versie | De definitieversie van de beleidsset in #.#.#-indeling. | tekenreeks |
versies | Een lijst met beschikbare versies voor deze beleidssetdefinitie. | tekenreeks[] |
ParameterDefinitions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
Naam | Description | Waarde |
---|---|---|
allowedValues | De toegestane waarden voor de parameter. | any[] |
standaardwaarde | De standaardwaarde voor de parameter als er geen waarde is opgegeven. | Voor Bicep kunt u de functie any() gebruiken. |
metagegevens | Algemene metagegevens voor de parameter. | ParameterDefinitionsValueMetadata |
schema | Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelf-gedefinieerd JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de implementatie Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en test conceptschema's op https://www.jsonschemavalidator.net/. |
Voor Bicep kunt u de functie any() gebruiken. |
type | Het gegevenstype van de parameter. | 'Matrix' 'Booleaanse waarde' 'DateTime' 'Float' 'Geheel getal' 'Object' 'Tekenreeks' |
ParameterDefinitionsValueMetadata
Naam | Description | Waarde |
---|---|---|
assignPermissions | Stel in op true om tijdens beleidstoewijzingen roltoewijzingen te maken voor de resource-id of resourcebereikwaarde van deze parameter Azure Portal. Deze eigenschap is handig als u machtigingen buiten het toewijzingsbereik wilt toewijzen. | booleaans |
beschrijving | De beschrijving van de parameter. | tekenreeks |
displayName | De weergavenaam voor de parameter. | tekenreeks |
strongType | Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen. | tekenreeks |
{aangepaste eigenschap} | Voor Bicep kunt u de functie any() gebruiken. |
PolicyDefinitionGroup
Naam | Description | Waarde |
---|---|---|
additionalMetadataId | Een resource-id van een resource die aanvullende metagegevens over de groep bevat. | tekenreeks |
category | De categorie van de groep. | tekenreeks |
beschrijving | De beschrijving van de groep. | tekenreeks |
displayName | De weergavenaam van de groep. | tekenreeks |
naam | De naam van de groep. | tekenreeks (vereist) |
PolicyDefinitionReference
Naam | Description | Waarde |
---|---|---|
groupNames | De naam van de groepen waartoe deze beleidsdefinitiereferentie behoort. | tekenreeks[] |
parameters | De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen. | Parametervalues |
policyDefinitionId | De id van de beleidsdefinitie of beleidssetdefinitie. | tekenreeks (vereist) |
policyDefinitionReferenceId | Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities. | tekenreeks |
Parametervalues
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterValuesValue |
ParameterValuesValue
Naam | Description | Waarde |
---|---|---|
waarde | De waarde van de parameter. | Voor Bicep kunt u de functie any() gebruiken. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype policySetDefinitions is een extensieresource, wat betekent dat u deze kunt toepassen op een andere resource.
Gebruik de scope
eigenschap voor deze resource om het bereik voor deze resource in te stellen. Zie Bereik instellen voor extensieresources in ARM-sjablonen.
Het resourcetype policySetDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Beheergroepen : zie opdrachten voor beheergroepimplementatie
- Abonnementen - Zie opdrachten voor abonnementsimplementatie
U kunt naar dit resourcetype verwijzen als een alleen-lezen resource op het niveau van: Tenants
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Authorization/policySetDefinitions-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Eigenschapswaarden
policySetDefinitions
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | 'Microsoft.Authorization/policySetDefinitions' |
apiVersion | De resource-API-versie | '2023-04-01' |
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 1-128 weergavenaam Resourcenaam 1-64 Geldige tekens: De weergavenaam kan tekens bevatten. Resourcenaam kan het volgende niet gebruiken: <>*%&:\?.+/ of besturingstekens. Kan niet eindigen met punt of spatie. |
scope | Gebruik deze optie bij het maken van een extensieresource in een ander bereik dan het implementatiebereik. | Doelbron Stel voor JSON de waarde in op de volledige naam van de resource om de extensieresource op toe te passen. |
properties | De definitie-eigenschappen van de beleidsset. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
Naam | Description | Waarde |
---|---|---|
beschrijving | De beschrijving van de definitie van de beleidsset. | tekenreeks |
displayName | De weergavenaam van de definitie van de beleidsset. | tekenreeks |
metagegevens | De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-ended object en zijn meestal een verzameling sleutelwaardeparen. | |
parameters | De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities. | ParameterDefinitions |
policyDefinitionGroups | De metagegevens die groepen beleidsdefinitieverwijzingen binnen de definitie van de beleidsset beschrijven. | PolicyDefinitionGroup[] |
policyDefinitions | Een matrix met verwijzingen naar beleidsdefinities. | PolicyDefinitionReference[] (vereist) |
policyType | Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static. | 'BuiltIn' 'Aangepast' 'NotSpecified' Statisch |
versie | De definitieversie van de beleidsset in #.#.#-indeling. | tekenreeks |
versies | Een lijst met beschikbare versies voor deze beleidssetdefinitie. | tekenreeks[] |
ParameterDefinitions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
Naam | Description | Waarde |
---|---|---|
allowedValues | De toegestane waarden voor de parameter. | any[] |
standaardwaarde | De standaardwaarde voor de parameter als er geen waarde is opgegeven. | |
metagegevens | Algemene metagegevens voor de parameter. | ParameterDefinitionsValueMetadata |
schema | Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelf-gedefinieerd JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de implementatie van Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en conceptschema's testen op https://www.jsonschemavalidator.net/. |
|
type | Het gegevenstype van de parameter. | 'Matrix' 'Booleaanse waarde' 'DateTime' 'Float' 'Geheel getal' 'Object' 'Tekenreeks' |
ParameterDefinitionsValueMetadata
Naam | Description | Waarde |
---|---|---|
assignPermissions | Stel in op true om tijdens beleidstoewijzingen roltoewijzingen te maken voor de resource-id of resourcebereikwaarde van deze parameter Azure Portal. Deze eigenschap is handig als u machtigingen buiten het toewijzingsbereik wilt toewijzen. | booleaans |
beschrijving | De beschrijving van de parameter. | tekenreeks |
displayName | De weergavenaam voor de parameter. | tekenreeks |
strongType | Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen. | tekenreeks |
{aangepaste eigenschap} |
PolicyDefinitionGroup
Naam | Description | Waarde |
---|---|---|
additionalMetadataId | Een resource-id van een resource die aanvullende metagegevens over de groep bevat. | tekenreeks |
category | De categorie van de groep. | tekenreeks |
beschrijving | De beschrijving van de groep. | tekenreeks |
displayName | De weergavenaam van de groep. | tekenreeks |
naam | De naam van de groep. | tekenreeks (vereist) |
PolicyDefinitionReference
Naam | Description | Waarde |
---|---|---|
groupNames | De naam van de groepen waartoe deze beleidsdefinitiereferentie behoort. | tekenreeks[] |
parameters | De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen. | Parametervalues |
policyDefinitionId | De id van de beleidsdefinitie of beleidssetdefinitie. | tekenreeks (vereist) |
policyDefinitionReferenceId | Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities. | tekenreeks |
Parametervalues
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterValuesValue |
ParameterValuesValue
Naam | Description | Waarde |
---|---|---|
waarde | De waarde van de parameter. |
Terraform-resourcedefinitie (AzAPI-provider)
Het resourcetype policySetDefinitions is een extensieresource, wat betekent dat u deze kunt toepassen op een andere resource.
Gebruik de parent_id
eigenschap voor deze resource om het bereik voor deze resource in te stellen.
Het resourcetype policySetDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Beheergroepen
- Abonnementen
U kunt naar dit resourcetype verwijzen als een alleen-lezen resource op het niveau van: Tenants
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Authorization/policySetDefinitions-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
groupNames = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Eigenschapswaarden
policySetDefinitions
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | "Microsoft.Authorization/policySetDefinitions@2023-04-01" |
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 1-128 weergavenaam Resourcenaam 1-64 Geldige tekens: De weergavenaam kan tekens bevatten. Resourcenaam kan het volgende niet gebruiken: <>*%&:\?.+/ of besturingstekens. Kan niet eindigen met punt of spatie. |
parent_id | De id van de resource om deze extensieresource op toe te passen. | tekenreeks (vereist) |
properties | De definitie-eigenschappen van de beleidsset. | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
Naam | Description | Waarde |
---|---|---|
beschrijving | De beschrijving van de definitie van de beleidsset. | tekenreeks |
displayName | De weergavenaam van de definitie van de beleidsset. | tekenreeks |
metagegevens | De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-ended object en zijn meestal een verzameling sleutelwaardeparen. | |
parameters | De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities. | ParameterDefinitions |
policyDefinitionGroups | De metagegevens die groepen verwijzingen naar beleidsdefinities binnen de definitie van de beleidsset beschrijven. | PolicyDefinitionGroup[] |
policyDefinitions | Een matrix met verwijzingen naar beleidsdefinities. | PolicyDefinitionReference[] (vereist) |
policyType | Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static. | "Ingebouwd" "Aangepast" "Niet opgegeven" "Statisch" |
versie | De definitieversie van de beleidsset in #.#.#-indeling. | tekenreeks |
versies | Een lijst met beschikbare versies voor deze beleidssetdefinitie. | tekenreeks[] |
ParameterDefinitions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterDefinitionsValue |
ParameterDefinitionsValue
Naam | Description | Waarde |
---|---|---|
allowedValues | De toegestane waarden voor de parameter. | any[] |
standaardwaarde | De standaardwaarde voor de parameter als er geen waarde is opgegeven. | |
metagegevens | Algemene metagegevens voor de parameter. | ParameterDefinitionsValueMetadata |
schema | Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelf-gedefinieerd JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de implementatie Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en test conceptschema's op https://www.jsonschemavalidator.net/. |
|
type | Het gegevenstype van de parameter. | "Matrix" "Booleaanse waarde" "Datum/tijd" "Float" "Geheel getal" "Object" "Tekenreeks" |
ParameterDefinitionsValueMetadata
Naam | Description | Waarde |
---|---|---|
assignPermissions | Stel in op true om Azure Portal roltoewijzingen te laten maken op de resource-id of resourcebereikwaarde van deze parameter tijdens de beleidstoewijzing. Deze eigenschap is handig als u machtigingen buiten het toewijzingsbereik wilt toewijzen. | booleaans |
beschrijving | De beschrijving van de parameter. | tekenreeks |
displayName | De weergavenaam voor de parameter. | tekenreeks |
strongType | Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen. | tekenreeks |
{aangepaste eigenschap} |
PolicyDefinitionGroup
Naam | Description | Waarde |
---|---|---|
additionalMetadataId | Een resource-id van een resource die aanvullende metagegevens over de groep bevat. | tekenreeks |
category | De categorie van de groep. | tekenreeks |
beschrijving | De beschrijving van de groep. | tekenreeks |
displayName | De weergavenaam van de groep. | tekenreeks |
naam | De naam van de groep. | tekenreeks (vereist) |
PolicyDefinitionReference
Naam | Description | Waarde |
---|---|---|
groupNames | De naam van de groepen waartoe deze beleidsdefinitie verwijst. | tekenreeks[] |
parameters | De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen. | Parametervalues |
policyDefinitionId | De id van de beleidsdefinitie of beleidssetdefinitie. | tekenreeks (vereist) |
policyDefinitionReferenceId | Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities. | tekenreeks |
Parametervalues
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ParameterValuesValue |
ParameterValuesValue
Naam | Description | Waarde |
---|---|---|
waarde | De waarde van de parameter. |