Udostępnij za pośrednictwem

Microsoft.Authorization policyDefinitions 2024-05-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu policyDefinitions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Authorization/policyDefinitions, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2024-05-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
    mode: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(Azure.Bicep.Types.Concrete.AnyType)
        type: 'string'
      }
    }
    policyRule: any(Azure.Bicep.Types.Concrete.AnyType)
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Wartości właściwości

Microsoft.Authorization/policyDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (wymagane)
Właściwości Właściwości definicji zasad. PolicyDefinitionProperties

ParametryDefinitions

Nazwa Opis Wartość

ParameterDefinitionsValue

Nazwa Opis Wartość
allowedValues Dozwolone wartości parametru. any[]
defaultValue Wartość domyślna parametru, jeśli nie podano żadnej wartości. jakikolwiek
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schemat Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko dla parametrów typu obiektu i jest zgodna z implementacją Json.NET Schema 2019-09. Aby dowiedzieć się więcej na temat używania schematów, zobacz https://json-schema.org/ i testowanie schematów roboczych w witrynie https://www.jsonschemavalidator.net/. jakikolwiek
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby witryna Azure Portal utworzyła przypisania ról dla identyfikatora 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
opis Opis parametru. struna
displayName Nazwa wyświetlana parametru. struna
strongType Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia kontekstową listę wartości do wyboru przez użytkownika. struna

PolicyDefinitionProperties

Nazwa Opis Wartość
opis Opis definicji zasad. struna
displayName Nazwa wyświetlana definicji zasad. struna
metadane Metadane definicji zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. jakikolwiek
tryb Tryb definicji zasad. Niektóre przykłady to All, Indexed, Microsoft.KeyVault.Data. struna
Parametry Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. ParametrDefinitions
policyRule Reguła zasad. jakikolwiek
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"NotSpecified"
"Statyczny"
Wersja Wersja definicji zasad w formacie #.#.# struna
Wersje Lista dostępnych wersji dla tej definicji zasad. string[]

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Tworzenie menedżera sieci wirtualnej platformy Azure i przykładowych sieci wirtualnych Ten szablon umożliwia wdrożenie menedżera sieci wirtualnej platformy Azure i przykładowych sieci wirtualnych w nazwanej grupie zasobów. Obsługuje wiele topologii łączności i typów członkostwa w grupach sieci.
wdrażanie def zasad i przypisywanie do wielu grup mgmt Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do wielu grup zarządzania.
Wdrażanie definicji zasad i przypisywanie ich 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.

Definicja zasobu szablonu usługi ARM

Typ zasobu policyDefinitions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Authorization/policyDefinitions, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyRule": {},
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Wartości właściwości

Microsoft.Authorization/policyDefinitions

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2024-05-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (wymagane)
Właściwości Właściwości definicji zasad. PolicyDefinitionProperties
typ Typ zasobu "Microsoft.Authorization/policyDefinitions"

ParametryDefinitions

Nazwa Opis Wartość

ParameterDefinitionsValue

Nazwa Opis Wartość
allowedValues Dozwolone wartości parametru. any[]
defaultValue Wartość domyślna parametru, jeśli nie podano żadnej wartości. jakikolwiek
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schemat Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko dla parametrów typu obiektu i jest zgodna z implementacją Json.NET Schema 2019-09. Aby dowiedzieć się więcej na temat używania schematów, zobacz https://json-schema.org/ i testowanie schematów roboczych w witrynie https://www.jsonschemavalidator.net/. jakikolwiek
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby witryna Azure Portal utworzyła przypisania ról dla identyfikatora 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
opis Opis parametru. struna
displayName Nazwa wyświetlana parametru. struna
strongType Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia kontekstową listę wartości do wyboru przez użytkownika. struna

PolicyDefinitionProperties

Nazwa Opis Wartość
opis Opis definicji zasad. struna
displayName Nazwa wyświetlana definicji zasad. struna
metadane Metadane definicji zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. jakikolwiek
tryb Tryb definicji zasad. Niektóre przykłady to All, Indexed, Microsoft.KeyVault.Data. struna
Parametry Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. ParametrDefinitions
policyRule Reguła zasad. jakikolwiek
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"NotSpecified"
"Statyczny"
Wersja Wersja definicji zasad w formacie #.#.# struna
Wersje Lista dostępnych wersji dla tej definicji zasad. string[]

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzenie menedżera sieci wirtualnej platformy Azure i przykładowych sieci wirtualnych

wdrażanie w usłudze Azure		 Ten szablon umożliwia wdrożenie menedżera sieci wirtualnej platformy Azure i przykładowych sieci wirtualnych w nazwanej grupie zasobów. Obsługuje wiele topologii łączności i typów członkostwa w grupach sieci.
wdrażanie def zasad i przypisywanie do wielu grup mgmt

wdrażanie w usłudze Azure		 Ten szablon jest szablonem na poziomie grupy zarządzania, który utworzy definicję zasad i przypisze te zasady do wielu grup zarządzania.
Wdrażanie definicji zasad i przypisywanie ich do grupy zarządzania

wdrażanie w usłudze Azure		 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.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu policyDefinitions można wdrożyć przy użyciu operacji docelowych:

  • grupy zarządzania dzierżawą* * subskrypcji

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      mode = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyRule = ?
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  })
}

Wartości właściwości

Microsoft.Authorization/policyDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (wymagane)
Właściwości Właściwości definicji zasad. PolicyDefinitionProperties
typ Typ zasobu "Microsoft.Authorization/policyDefinitions@2024-05-01"

ParametryDefinitions

Nazwa Opis Wartość

ParameterDefinitionsValue

Nazwa Opis Wartość
allowedValues Dozwolone wartości parametru. any[]
defaultValue Wartość domyślna parametru, jeśli nie podano żadnej wartości. jakikolwiek
metadane Ogólne metadane parametru. ParameterDefinitionsValueMetadata
schemat Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko dla parametrów typu obiektu i jest zgodna z implementacją Json.NET Schema 2019-09. Aby dowiedzieć się więcej na temat używania schematów, zobacz https://json-schema.org/ i testowanie schematów roboczych w witrynie https://www.jsonschemavalidator.net/. jakikolwiek
typ Typ danych parametru. "Tablica"
"Wartość logiczna"
"DateTime"
"Float"
"Liczba całkowita"
"Obiekt"
"Ciąg"

ParameterDefinitionsValueMetadata

Nazwa Opis Wartość
assignPermissions Ustaw wartość true, aby witryna Azure Portal utworzyła przypisania ról dla identyfikatora 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
opis Opis parametru. struna
displayName Nazwa wyświetlana parametru. struna
strongType Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia kontekstową listę wartości do wyboru przez użytkownika. struna

PolicyDefinitionProperties

Nazwa Opis Wartość
opis Opis definicji zasad. struna
displayName Nazwa wyświetlana definicji zasad. struna
metadane Metadane definicji zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość. jakikolwiek
tryb Tryb definicji zasad. Niektóre przykłady to All, Indexed, Microsoft.KeyVault.Data. struna
Parametry Definicje parametrów dla parametrów używanych w regule zasad. Klucze są nazwami parametrów. ParametrDefinitions
policyRule Reguła zasad. jakikolwiek
policyType Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. "BuiltIn"
"Niestandardowy"
"NotSpecified"
"Statyczny"
Wersja Wersja definicji zasad w formacie #.#.# struna
Wersje Lista dostępnych wersji dla tej definicji zasad. string[]