Udostępnij przez

Microsoft.KeyVault managedHSMs/keys

Definicja zasobu Bicep

Typ zasobu managedHSMs/keys 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.KeyVault/managedHSMs/keys, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2025-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[a-zA-Z0-9-]{1,127}$ (wymagane)
nadrzędny W 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.		 Nazwa symboliczna zasobu typu: zarządzane maszynyHSM
Właściwości Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Zarządzana akcja Hsm

Nazwa Opis Wartość
typ Typ akcji. "notify" (powiadom)
"obróć"

ManagedHsmKeyAttributes

Nazwa Opis Wartość
Włączone 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
Sieć NBF Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

ManagedHsmKeyCreateParametersTags

Nazwa Opis Wartość

ManagedHsmKeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName (nazwa_krzywej) Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. Wartość domyślna dla kluczy EC i EC-HSM to P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps (operacje kluczowe) Tablica ciągów zawierająca dowolną z:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"wrapKey"
rozmiar klucza Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. Wartość domyślna dla kluczy RSA i RSA-HSM to 2048. Wyjątek w przypadku funkcji BYOK (Bring Your Own Key) — klucze wymiany kluczy domyślnie to 4096. Int
kty powiedział: Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. "EC"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Zasady wydania klucza 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 (polityka rotacji) 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

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
typ treści 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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nazwa Opis Wartość
akcja Akcja okresu istnienia zasad rotacji kluczyAkcja. Zarządzana akcja Hsm
wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. Zarządzany HsmTrigger

ManagedHsmRotationPolicy

Nazwa Opis Wartość
Atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions (Akcje w życiu) Okres istnienia akcji rotacji kluczy. ZarządzaneHsmLifetimeAction[]

Zarządzany HsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy tylko rotacji. Będzie on mieć format czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiration (czas) Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadamiania. Będzie on mieć format 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ć 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.KeyVault/managedHSMs/keys, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2025-05-01",
  "name": "string",
  "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"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2025-05-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[a-zA-Z0-9-]{1,127}$ (wymagane)
Właściwości Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.KeyVault/managedHSMs/keys"

Zarządzana akcja Hsm

Nazwa Opis Wartość
typ Typ akcji. "notify" (powiadom)
"obróć"

ManagedHsmKeyAttributes

Nazwa Opis Wartość
Włączone 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
Sieć NBF Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

ManagedHsmKeyCreateParametersTags

Nazwa Opis Wartość

ManagedHsmKeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName (nazwa_krzywej) Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. Wartość domyślna dla kluczy EC i EC-HSM to P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps (operacje kluczowe) Tablica ciągów zawierająca dowolną z:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"wrapKey"
rozmiar klucza Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. Wartość domyślna dla kluczy RSA i RSA-HSM to 2048. Wyjątek w przypadku funkcji BYOK (Bring Your Own Key) — klucze wymiany kluczy domyślnie to 4096. Int
kty powiedział: Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. "EC"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Zasady wydania klucza 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 (polityka rotacji) 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

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
typ treści 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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nazwa Opis Wartość
akcja Akcja okresu istnienia zasad rotacji kluczyAkcja. Zarządzana akcja Hsm
wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. Zarządzany HsmTrigger

ManagedHsmRotationPolicy

Nazwa Opis Wartość
Atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions (Akcje w życiu) Okres istnienia akcji rotacji kluczy. ZarządzaneHsmLifetimeAction[]

Zarządzany HsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy tylko rotacji. Będzie on mieć format czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiration (czas) Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadamiania. Będzie on mieć format czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu managedHSMs/keys 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.KeyVault/managedHSMs/keys, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2025-05-01"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[a-zA-Z0-9-]{1,127}$ (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: managedHSMs
Właściwości Właściwości klucza do utworzenia. ManagedHsmKeyProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.KeyVault/managedHSMs/keys@2025-05-01"

Zarządzana akcja Hsm

Nazwa Opis Wartość
typ Typ akcji. "notify" (powiadom)
"obróć"

ManagedHsmKeyAttributes

Nazwa Opis Wartość
Włączone 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
Sieć NBF Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

ManagedHsmKeyCreateParametersTags

Nazwa Opis Wartość

ManagedHsmKeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. ManagedHsmKeyAttributes
curveName (nazwa_krzywej) Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. Wartość domyślna dla kluczy EC i EC-HSM to P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps (operacje kluczowe) Tablica ciągów zawierająca dowolną z:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"wrapKey"
rozmiar klucza Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. Wartość domyślna dla kluczy RSA i RSA-HSM to 2048. Wyjątek w przypadku funkcji BYOK (Bring Your Own Key) — klucze wymiany kluczy domyślnie to 4096. Int
kty powiedział: Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. "EC"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy Zasady wydania klucza 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 (polityka rotacji) 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

ManagedHsmKeyReleasePolicy

Nazwa Opis Wartość
typ treści 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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nazwa Opis Wartość
akcja Akcja okresu istnienia zasad rotacji kluczyAkcja. Zarządzana akcja Hsm
wyzwalacz Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. Zarządzany HsmTrigger

ManagedHsmRotationPolicy

Nazwa Opis Wartość
Atrybuty Atrybuty zasad rotacji kluczy. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions (Akcje w życiu) Okres istnienia akcji rotacji kluczy. ZarządzaneHsmLifetimeAction[]

Zarządzany HsmTrigger

Nazwa Opis Wartość
timeAfterCreate Czas trwania po utworzeniu klucza w celu rotacji klucza. Dotyczy tylko rotacji. Będzie on mieć format czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
timeBeforeExpiration (czas) Czas trwania przed wygaśnięciem klucza w celu rotacji lub powiadamiania. Będzie on mieć format czasu trwania ISO 8601. Na przykład: "P90D", "P1Y". ciąg
  • Last updated on