Udostępnij za pośrednictwem

Microsoft.KeyVault managedHSMs/keys 2023-02-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu managedHSMs/keys można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2023-02-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
}

Wartości właściwości

managedHSMs/keys

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
tags Tagi, które zostaną przypisane do klucza. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Symboliczna nazwa zasobu typu : managedHSMs
properties Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)

ManagedHsmKeyProperties

Nazwa Opis Wartość
atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Tablica ciągów zawierająca dowolną z:
"Odszyfrowywanie"
"Szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"weryfikuj"
"wrapKey"
Keysize Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. int
kty Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. "WE"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Kluczowe zasady wydania w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest puste ManagedHsmKeyReleasePolicy
rotationPolicy Zasady rotacji kluczy w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest puste ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Nazwa Opis Wartość
enabled Określa, czy obiekt jest włączony. bool
exp Data wygaśnięcia w sekundach od 1970-01-01T00:00:00Z. int
Eksportowalny Wskazuje, czy klucz prywatny można wyeksportować. bool
Nbf Nie wcześniej niż w sekundach od 1970-01-01T00:00:00Z. int

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
Contenttype Typ zawartości i wersja zasad wydania klucza ciąg
dane Kodowanie obiektów blob reguł zasad, w których można zwolnić klucz. ciąg

ManagedHsmRotationPolicy

Nazwa Opis Wartość
atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions Okres istnieniaAkcje akcji rotacji kluczy. ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Nazwa Opis Wartość
expiryTime Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Na przykład: "P90D", "P1Y". ciąg

ManagedHsmLifetimeAction

Nazwa Opis Wartość
action Akcja okresu istnienia zasad rotacji kluczyAkcja. ManagedHsmAction
Wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. ManagedHsmTrigger

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "Powiadom"
"Obróć"

ManagedHsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy to tylko rotacji. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiry Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadomienia. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu managedHSMs/keys można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2023-02-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

Wartości właściwości

zarządzane maszyny/klucze

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.KeyVault/managedHSMs/keys"
apiVersion Wersja interfejsu API zasobów '2023-02-01'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
tags Tagi, które zostaną przypisane do klucza. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)

ManagedHsmKeyProperties

Nazwa Opis Wartość
atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName. "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Tablica ciągów zawierająca dowolną z:
"Odszyfrowywanie"
"Szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"weryfikuj"
"wrapKey"
Keysize Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. int
kty Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. "WE"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Kluczowe zasady wydania w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest puste ManagedHsmKeyReleasePolicy
rotationPolicy Zasady rotacji kluczy w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest puste ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Nazwa Opis Wartość
enabled Określa, czy obiekt jest włączony. bool
exp Data wygaśnięcia w sekundach od 1970-01-01T00:00:00Z. int
Eksportowalny Wskazuje, czy klucz prywatny można wyeksportować. bool
Nbf Nie wcześniej niż w sekundach od 1970-01-01T00:00:00Z. int

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
Contenttype Typ zawartości i wersja zasad wydania klucza ciąg
dane Kodowanie obiektów blob reguł zasad, w ramach których można zwolnić klucz. ciąg

ManagedHsmRotationPolicy

Nazwa Opis Wartość
atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions Okres istnienia akcji rotacji kluczy. ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Nazwa Opis Wartość
expiryTime Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Np. "P90D", "P1Y". ciąg

ManagedHsmLifetimeAction

Nazwa Opis Wartość
action Akcja okresu istnienia zasad rotacji kluczyAction. ManagedHsmAction
Wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAction. ManagedHsmTrigger

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "Powiadom"
"Obróć"

ManagedHsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy to tylko rotacji. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiry Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadomienia. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu managedHSMs/keys można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

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

Format zasobu

Aby utworzyć zasób Microsoft.KeyVault/managedHSMs/keys, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2023-02-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

Wartości właściwości

zarządzane maszyny/klucze

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.KeyVault/managedHSMs/keys@2023-02-01"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu : managedHSMs
tags Tagi, które zostaną przypisane do klucza. Słownik nazw tagów i wartości.
properties Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)

ManagedHsmKeyProperties

Nazwa Opis Wartość
atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName. "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Tablica ciągów zawierająca dowolną z:
"Odszyfruj"
"Szyfruj"
"import"
"release"
"podpis"
"unwrapKey"
"verify" (weryfikowanie)
"wrapKey"
Keysize Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. int
kty Typ klucza. Prawidłowe wartości można znaleźć w temacie JsonWebKeyType. "EC"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Kluczowe zasady wydania w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest pusty ManagedHsmKeyReleasePolicy
rotationPolicy Zasady rotacji kluczy w odpowiedzi. Będzie on używany zarówno dla danych wyjściowych, jak i wejściowych. Pominięto, jeśli jest pusty ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Nazwa Opis Wartość
enabled Określa, czy obiekt jest włączony. bool
exp Data wygaśnięcia w sekundach od 1970-01-01T00:00:00Z. int
Eksportowalny Wskazuje, czy klucz prywatny można wyeksportować. bool
Nbf Data wcześniejsza w sekundach od 1970-01-01T00:00:00Z. int

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
Contenttype Typ zawartości i wersja zasad wydania klucza ciąg
dane Kodowanie obiektów blob reguł zasad, w których można zwolnić klucz. ciąg

ManagedHsmRotationPolicy

Nazwa Opis Wartość
atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions Okres istnieniaAkcje akcji rotacji kluczy. ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Nazwa Opis Wartość
expiryTime Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Na przykład: "P90D", "P1Y". ciąg

ManagedHsmLifetimeAction

Nazwa Opis Wartość
action Akcja okresu istnienia zasad rotacji kluczyAkcja. ManagedHsmAction
Wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. ManagedHsmTrigger

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "Powiadom"
"Obróć"

ManagedHsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy to tylko rotacji. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiry Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadomienia. Będzie on w formacie czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg