Udostępnij za pośrednictwem

Microsoft.KeyVault managedHSMs/keys 2023-02-01

  • Artykuł

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@2023-02-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

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "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
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 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:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"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. "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 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ść
contentType Typ zawartości i wersja zasad wydania klucza struna
dane Kodowanie obiektów blob reguł zasad, w których można zwolnić klucz. struna

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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". struna
timeBeforeExpiry 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". struna

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[a-zA-Z0-9-]{1,127}$ (wymagane)
rodzic 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

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": "2023-02-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

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "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
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 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:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"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. "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 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ść
contentType Typ zawartości i wersja zasad wydania klucza struna
dane Kodowanie obiektów blob reguł zasad, w których można zwolnić klucz. struna

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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". struna
timeBeforeExpiry 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". struna

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-02-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"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu managedHSMs/keys można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

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@2023-02-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  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

ManagedHsmAction

Nazwa Opis Wartość
typ Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. "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
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 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:
"Odszyfruj"
"szyfruj"
"import"
"release"
"znak"
"unwrapKey"
"Verify"
"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. "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 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ść
contentType Typ zawartości i wersja zasad wydania klucza struna
dane Kodowanie obiektów blob reguł zasad, w których można zwolnić klucz. struna

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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". struna
timeBeforeExpiry 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". struna

Microsoft.KeyVault/managedHSMs/keys

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[a-zA-Z0-9-]{1,127}$ (wymagane)
parent_id 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@2023-02-01"