Udostępnij za pośrednictwem

Magazyny/klucze Microsoft.KeyVault 2020-04-01-preview

  • Artykuł

Uwagi

Aby uzyskać wskazówki dotyczące używania magazynów kluczy do zabezpieczania wartości, zobacz Manage secrets by using Bicep.

Aby zapoznać się z przewodnikiem Szybki start dotyczącym tworzenia wpisu tajnego, zobacz Szybki start: ustawianie i pobieranie wpisu tajnego z usługi Azure Key Vault przy użyciu szablonu usługi ARM.

Aby zapoznać się z przewodnikiem Szybki start dotyczącym tworzenia klucza, zobacz Szybki start: tworzenie magazynu kluczy platformy Azure i klucza przy użyciu szablonu usługi ARM.

Definicja zasobu Bicep

Typ zasobu magazynów/kluczy 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/vaults/keys, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2020-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

KeyAttributes

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
nbf Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nazwa Opis Wartość

KeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. KeyAttributes
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"
"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"

Microsoft.KeyVault/vaults/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: magazyny
Właściwości Właściwości klucza do utworzenia. KeyProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Przykłady z przewodnika Szybki start

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

Plik Bicep Opis
szyfrowanie konta usługi Azure Storage przy użyciu klucza zarządzanego przez klienta Ten szablon wdraża konto magazynu z kluczem zarządzanym przez klienta na potrzeby szyfrowania wygenerowanego i umieszczonego w usłudze Key Vault.

Definicja zasobu szablonu usługi ARM

Typ zasobu magazynów/kluczy 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/vaults/keys, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

KeyAttributes

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
nbf Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nazwa Opis Wartość

KeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. KeyAttributes
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"
"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"

Microsoft.KeyVault/vaults/keys

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2020-04-01-preview"
nazwa Nazwa zasobu struna

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

Szablony szybkiego startu

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

Szablon Opis
szyfrowanie konta usługi Azure Storage przy użyciu klucza zarządzanego przez klienta

wdrażanie w usłudze Azure		 Ten szablon wdraża konto magazynu z kluczem zarządzanym przez klienta na potrzeby szyfrowania wygenerowanego i umieszczonego w usłudze Key Vault.
Tworzenie klucza w usłudze Azure KeyVault

wdrażanie w usłudze Azure		 Ten moduł umożliwia utworzenie klucza w istniejącej usłudze KeyVault.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu magazynów/kluczy 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/vaults/keys, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2020-04-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
    }
  })
}

Wartości właściwości

KeyAttributes

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
nbf Nie wcześniej niż data w sekundach od 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nazwa Opis Wartość

KeyProperties

Nazwa Opis Wartość
Atrybuty Atrybuty klucza. KeyAttributes
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"
"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"

Microsoft.KeyVault/vaults/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: magazyny
Właściwości Właściwości klucza do utworzenia. KeyProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.KeyVault/vaults/keys@2020-04-01-preview"