Microsoft.KeyVault vaults/keys

Artykuł
12/21/2024

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:

grupy zasobów — zobacz polecenia wdrażania 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 kod Bicep do szablonu.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-04-01-preview' = {
  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

Akcja

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

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
Eksportowalny	Wskazuje, czy klucz prywatny można wyeksportować.	Bool
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" "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	KeyReleasePolicy
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	RotationPolicy

KeyReleasePolicy

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

KeyRotationPolicyAttributes

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

Okres istnienia

Nazwa	Opis	Wartość
akcja	Akcja okresu istnienia zasad rotacji kluczyAkcja.	akcji
spust	Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja.	wyzwalacza

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

RotacjaPolicy

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

Spust

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

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:

grupy zasobów — zobacz polecenia wdrażania 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 kod JSON do szablonu.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-04-01-preview",
  "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

Akcja

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

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
Eksportowalny	Wskazuje, czy klucz prywatny można wyeksportować.	Bool
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" "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	KeyReleasePolicy
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	RotationPolicy

KeyReleasePolicy

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

KeyRotationPolicyAttributes

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

Okres istnienia

Nazwa	Opis	Wartość
akcja	Akcja okresu istnienia zasad rotacji kluczyAkcja.	akcji
spust	Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja.	wyzwalacza

Microsoft.KeyVault/vaults/keys

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

RotacjaPolicy

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

Spust

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

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	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	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@2024-04-01-preview"
  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

Akcja

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

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
Eksportowalny	Wskazuje, czy klucz prywatny można wyeksportować.	Bool
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" "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	KeyReleasePolicy
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	RotationPolicy

KeyReleasePolicy

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

KeyRotationPolicyAttributes

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

Okres istnienia

Nazwa	Opis	Wartość
akcja	Akcja okresu istnienia zasad rotacji kluczyAkcja.	akcji
spust	Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja.	wyzwalacza

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@2024-04-01-preview"

RotacjaPolicy

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

Spust

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

Udostępnij za pośrednictwem

Microsoft.KeyVault vaults/keys

Uwagi

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

Akcja

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

Okres istnienia

Microsoft.KeyVault/vaults/keys

RotacjaPolicy

Spust

Przykłady z przewodnika Szybki start

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

Akcja

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

Okres istnienia

Microsoft.KeyVault/vaults/keys

RotacjaPolicy

Spust

Szablony szybkiego startu

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

Akcja

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

Okres istnienia

Microsoft.KeyVault/vaults/keys

RotacjaPolicy

Spust

Opinia

Dodatkowe zasoby