Microsoft.Authorization policyDefinitions
Definicja zasobu Bicep
Typ zasobu policyDefinitions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
scope Użyj właściwości tego zasobu, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w środowisku Bicep.
Typ zasobu policyDefinitions można wdrożyć przy użyciu operacji docelowych:
- Grupy zarządzania — zobacz polecenia wdrażania grupy zarządzania
- Subskrypcje — zobacz polecenia wdrażania subskrypcji
Ten typ zasobu można odwoływać się jako zasób tylko do odczytu na poziomie: Dzierżawcy
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Authorization/policyDefinitions, dodaj następujący kod Bicep do szablonu.
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'
]
}
}
Wartości właściwości
Policydefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–128 nazwa wyświetlana 1–64 nazwa zasobu Prawidłowe znaki: Nazwa wyświetlana może zawierać dowolne znaki. Nazwa zasobu nie może być używana: <>*%&:\?+/ lub znaki sterujące. Nie można zakończyć kropką ani spacją. |
| scope | Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. | Zasób docelowy W przypadku elementu Bicep ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia. |
| properties | Właściwości definicji zasad. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| description (opis) | Opis definicji zasad. | ciąg |
| displayName | Nazwa wyświetlana definicji zasad. | ciąg |
| metadane | Metadane definicji zasad. Metadane to otwarty obiekt i zazwyczaj jest kolekcją par klucz wartości. | W przypadku Bicep można użyć funkcji any(). |
| tryb | Tryb definicji zasad. Niektóre przykłady to All, Indexed, Microsoft.KeyVault.Data. | ciąg |
| parameters | Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. | ParametrDefinitions |
| policyRule | Reguła zasad. | W przypadku Bicep można użyć funkcji any(). |
| policyType | Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. | "BuiltIn" "Niestandardowy" "NotSpecified" "Statyczny" |
| Wersja | Wersja definicji zasad w formacie #.#.# | ciąg |
| versions (wersje) | Lista dostępnych wersji tej definicji zasad. | ciąg[] |
ParametrDefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ParametrDefinitionsValue |
ParametrDefinitionsValue
| Nazwa | Opis | Wartość |
|---|---|---|
| Allowedvalues | Dozwolone wartości parametru. | dowolny[] |
| Defaultvalue | Wartość domyślna parametru, jeśli nie podano żadnej wartości. | W przypadku Bicep można użyć funkcji any(). |
| metadane | Ogólne metadane parametru. | ParameterDefinitionsValueMetadata |
| schema | Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można uzyskać na stronie https://json-schema.org/ i przetestować schematy robocze na stronie https://www.jsonschemavalidator.net/. |
W przypadku funkcji Bicep można użyć funkcji any(). |
| typ | Typ danych parametru. | "Tablica" "Wartość logiczna" "DateTime" "Float" "Liczba całkowita" "Obiekt" "Ciąg" |
ParameterDefinitionsValueMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| assignPermissions | Ustaw wartość true, aby Azure Portal utworzyć przypisania ról dla wartości identyfikatora zasobu lub zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. | bool |
| description (opis) | Opis parametru. | ciąg |
| displayName | Nazwa wyświetlana parametru. | ciąg |
| strongType | Używany podczas przypisywania definicji zasad za pośrednictwem portalu. Zawiera listę kontekstowych wartości do wyboru przez użytkownika. | ciąg |
| {niestandardowa właściwość} | W przypadku funkcji Bicep można użyć funkcji any(). |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Wdrażanie definicji zasad i przypisywanie do grupy zarządzania |
Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do docelowej grupy zarządzania. Obecnie nie można wdrożyć tego szablonu za pośrednictwem witryny Azure Portal. |
| Wdrażanie def i przypisywanie zasad do wielu Grupy mgmt |
Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do wielu grup zarządzania. |
| Twórca menedżera usługi Azure Virtual Network Manager i przykładowych sieci wirtualnych |
Ten szablon służy do wdrażania usługi Azure Virtual Network Manager i przykładowych sieci wirtualnych w nazwanej grupie zasobów. Obsługuje wiele topologii łączności i typów członkostwa w grupach sieci. |
Definicja zasobu szablonu usługi ARM
Typ zasobu policyDefinitions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w szablonach usługi ARM.
Typ zasobu policyDefinitions można wdrożyć z operacjami docelowymi:
- Grupy zarządzania — zobacz polecenia wdrażania grupy zarządzania
- Subskrypcje — zobacz polecenia wdrażania subskrypcji
Ten typ zasobu można odwoływać jako zasób tylko do odczytu na poziomie: Dzierżawy
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Authorization/policyDefinitions, dodaj następujący kod JSON do szablonu.
{
"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" ]
}
}
Wartości właściwości
Policydefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Authorization/policyDefinitions" |
| apiVersion | Wersja interfejsu API zasobów | '2023-04-01' |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–128 nazwa wyświetlana 1–64 nazwa zasobu Prawidłowe znaki: Nazwa wyświetlana może zawierać dowolne znaki. Nazwa zasobu nie może być używana: <>*%&:\?+/ lub znaki sterujące. Nie można zakończyć kropką ani spacją. |
| scope | Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. | Zasób docelowy W przypadku formatu JSON ustaw wartość na pełną nazwę zasobu, aby zastosować zasób rozszerzenia do. |
| properties | Właściwości definicji zasad. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| description (opis) | Opis definicji zasad. | ciąg |
| displayName | Nazwa wyświetlana definicji zasad. | ciąg |
| metadane | Metadane definicji zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. | |
| tryb | Tryb definicji zasad. Niektóre przykłady to All, Indexed, Microsoft.KeyVault.Data. | ciąg |
| parameters | Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. | ParametrDefinitions |
| policyRule | Reguła zasad. | |
| policyType | Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. | "BuiltIn" "Niestandardowy" "NotSpecified" "Statyczny" |
| Wersja | Wersja definicji zasad w formacie #.#.# | ciąg |
| versions (wersje) | Lista dostępnych wersji tej definicji zasad. | ciąg[] |
ParametrDefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ParametrDefinitionsValue |
ParametrDefinitionsValue
| Nazwa | Opis | Wartość |
|---|---|---|
| Allowedvalues | Dozwolone wartości parametru. | dowolny[] |
| Defaultvalue | Wartość domyślna parametru, jeśli nie podano żadnej wartości. | |
| metadane | Ogólne metadane parametru. | ParameterDefinitionsValueMetadata |
| schema | Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można dowiedzieć się na stronie https://json-schema.org/ i przetestować schematy robocze pod adresem https://www.jsonschemavalidator.net/. |
|
| typ | Typ danych parametru. | "Tablica" "Wartość logiczna" "DateTime" "Float" "Liczba całkowita" "Obiekt" "Ciąg" |
ParameterDefinitionsValueMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| assignPermissions | Ustaw wartość true, aby Azure Portal utworzyć przypisania ról w identyfikatorze zasobu lub wartości zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. | bool |
| description (opis) | Opis parametru. | ciąg |
| displayName | Nazwa wyświetlana parametru. | ciąg |
| strongType | Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia listę kontekstowych wartości do wyboru przez użytkownika. | ciąg |
| {niestandardowa właściwość} |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Wdrażanie definicji zasad i przypisywanie do grupy zarządzania |
Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do docelowej grupy zarządzania. Obecnie nie można wdrożyć tego szablonu za pośrednictwem witryny Azure Portal. |
| Wdrażanie def i przypisywanie zasad do wielu Grupy mgmt |
Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do wielu grup zarządzania. |
| Twórca menedżera usługi Azure Virtual Network i przykładowych sieci wirtualnych |
Ten szablon wdraża usługę Azure Virtual Network Manager i przykładowe sieci wirtualne w nazwanej grupie zasobów. Obsługuje ona wiele topologii łączności i typów członkostwa w grupach sieciowych. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu policyDefinitions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
parent_id Użyj właściwości tego zasobu, aby ustawić zakres dla tego zasobu.
Typ zasobu policyDefinitions można wdrożyć przy użyciu operacji docelowych:
- Grupy zarządzania
- Subskrypcje
Ten typ zasobu można odwoływać się jako zasób tylko do odczytu na poziomie: Dzierżawcy
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Authorization/policyDefinitions, dodaj następujący program Terraform do szablonu.
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"
]
}
})
}
Wartości właściwości
Policydefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Authorization/policyDefinitions@2023-04-01" |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–128 nazwa wyświetlana 1–64 nazwa zasobu Prawidłowe znaki: Nazwa wyświetlana może zawierać dowolne znaki. Nazwa zasobu nie może być używana: <>*%&:\?+/ lub znaki sterujące. Nie można zakończyć kropką ani spacją. |
| parent_id | Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. | ciąg (wymagany) |
| properties | Właściwości definicji zasad. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| description (opis) | Opis definicji zasad. | ciąg |
| displayName | Nazwa wyświetlana definicji zasad. | ciąg |
| metadane | Metadane definicji zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. | |
| tryb | Tryb definicji zasad. Przykładami są Wszystkie, Indeksowane, Microsoft.KeyVault.Data. | ciąg |
| parameters | Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. | ParametryDefinitions |
| policyRule | Reguła zasad. | |
| policyType | Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. | "BuiltIn" "Niestandardowy" "Nieokreślone" "Statyczny" |
| Wersja | Wersja definicji zasad w formacie #.#.# | ciąg |
| versions (wersje) | Lista dostępnych wersji dla tej definicji zasad. | ciąg[] |
ParametryDefinitions
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nazwa | Opis | Wartość |
|---|---|---|
| Allowedvalues | Dozwolone wartości parametru. | any[] |
| Defaultvalue | Wartość domyślna parametru, jeśli nie podano żadnej wartości. | |
| metadane | Ogólne metadane parametru. | ParameterDefinitionsValueMetadata |
| schema | Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko w przypadku parametrów typu obiektu i jest zgodna z implementacją schematu Json.NET 2019-09. Więcej informacji na temat używania schematów można uzyskać na stronie https://json-schema.org/ i przetestować schematy robocze na stronie https://www.jsonschemavalidator.net/. |
|
| typ | Typ danych parametru. | "Tablica" "Wartość logiczna" "DateTime" "Float" "Liczba całkowita" "Obiekt" "Ciąg" |
ParameterDefinitionsValueMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| assignPermissions | Ustaw wartość true, aby Azure Portal utworzyć przypisania ról dla wartości identyfikatora zasobu lub zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania. | bool |
| description (opis) | Opis parametru. | ciąg |
| displayName | Nazwa wyświetlana parametru. | ciąg |
| strongType | Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia listę kontekstowych wartości do wyboru przez użytkownika. | ciąg |
| {niestandardowa właściwość} |