Magazyny/klucze Microsoft.KeyVault 2022-02-01-preview
Definicja zasobu Bicep
Typ zasobu magazynów/kluczy można wdrożyć za pomocą operacji, które są przeznaczone:
- 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 dziennik zmian.
Uwagi
Aby uzyskać wskazówki dotyczące używania magazynów kluczy do zabezpieczania wartości, zobacz Manage secrets by using Bicep (Zarządzanie wpisami tajnymi przy użyciu 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.
Format zasobu
Aby utworzyć zasób Microsoft.KeyVault/vaults/keys, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2022-02-01-preview' = {
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
magazyny/klucze
| 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 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 |
| properties | Właściwości klucza do utworzenia. | KeyProperties (wymagane) |
Właściwości klucza
| Nazwa | Opis | Wartość |
|---|---|---|
| atrybuty | Atrybuty klucza. | KeyAttributes |
| 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" "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 | 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 |
KeyAttributes
| 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 |
KeyReleasePolicy
| 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 |
RotationPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| atrybuty | Atrybuty zasad rotacji kluczy. | KeyRotationPolicyAttributes |
| lifetimeActions | Okres istnieniaAkcje akcji rotacji kluczy. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nazwa | Opis | Wartość |
|---|---|---|
| expiryTime | Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Na przykład: "P90D", "P1Y". | ciąg |
Okres istnienia
| Nazwa | Opis | Wartość |
|---|---|---|
| action | Akcja okresu istnienia zasad rotacji kluczyAkcja. | Akcja |
| Wyzwalacz | Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. | Wyzwalacz |
Akcja
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. | "Powiadom" "Obróć" |
Wyzwalacz
| 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 |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Tworzenie klucza w usłudze Azure KeyVault |
Ten moduł umożliwia utworzenie klucza w istniejącej usłudze KeyVault. |
| Szyfrowanie konta usługi Azure Storage przy użyciu klucza zarządzanego przez klienta |
Ten szablon służy do wdrażania konta magazynu z kluczem zarządzanym przez klienta na potrzeby szyfrowania wygenerowanego i umieszczonego w Key Vault. |
Definicja zasobu szablonu usługi ARM
Typ zasobu magazynów/kluczy można wdrożyć za pomocą operacji, które są przeznaczone:
- 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 dziennik zmian.
Uwagi
Aby uzyskać wskazówki dotyczące używania magazynów kluczy do zabezpieczania wartości, zobacz Manage secrets by using Bicep (Zarządzanie wpisami tajnymi przy użyciu 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.
Format zasobu
Aby utworzyć zasób Microsoft.KeyVault/vaults/keys, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2022-02-01-preview",
"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
magazyny/klucze
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.KeyVault/vaults/keys" |
| apiVersion | Wersja interfejsu API zasobów | "2022-02-01-preview" |
| name | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM 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. | KeyProperties (wymagane) |
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: "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 | 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 puste | RotacjaPolicy |
KeyAttributes
| 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 |
KeyReleasePolicy
| 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 |
RotacjaPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| atrybuty | Atrybuty zasad rotacji kluczy. | KeyRotationPolicyAttributes |
| lifetimeActions | Okres istnienia akcji rotacji kluczy. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nazwa | Opis | Wartość |
|---|---|---|
| expiryTime | Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Na przykład: "P90D", "P1Y". | ciąg |
Okres istnienia
| Nazwa | Opis | Wartość |
|---|---|---|
| action | Akcja okresu istnienia zasad rotacji kluczyAkcja. | Akcja |
| Wyzwalacz | Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. | Wyzwalacz |
Akcja
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. | "Powiadom" "Obróć" |
Wyzwalacz
| 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 |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Tworzenie klucza w usłudze Azure KeyVault |
Ten moduł umożliwia utworzenie klucza w istniejącej usłudze KeyVault. |
| Szyfrowanie konta usługi Azure Storage przy użyciu klucza zarządzanego przez klienta |
Ten szablon służy do wdrażania konta magazynu z kluczem zarządzanym przez klienta na potrzeby szyfrowania wygenerowanego i umieszczonego w Key Vault. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu magazynów/kluczy można wdrożyć za pomocą operacji, które są przeznaczone:
- 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/vaults/keys, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2022-02-01-preview"
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
magazyny/klucze
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.KeyVault/vaults/keys@2022-02-01-preview" |
| name | Nazwa zasobu | ciąg (wymagany) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: magazyny |
| tags | Tagi, które zostaną przypisane do klucza. | Słownik nazw tagów i wartości. |
| properties | Właściwości klucza do utworzenia. | KeyProperties (wymagane) |
Właściwości klucza
| Nazwa | Opis | Wartość |
|---|---|---|
| atrybuty | Atrybuty klucza. | KeyAttributes |
| 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 | 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 |
KeyAttributes
| 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 |
KeyReleasePolicy
| 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 |
RotationPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| atrybuty | Atrybuty zasad rotacji kluczy. | KeyRotationPolicyAttributes |
| lifetimeActions | Okres istnieniaAkcje akcji rotacji kluczy. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nazwa | Opis | Wartość |
|---|---|---|
| expiryTime | Czas wygaśnięcia nowej wersji klucza. Powinien być w formacie ISO8601. Na przykład: "P90D", "P1Y". | ciąg |
Okres istnienia
| Nazwa | Opis | Wartość |
|---|---|---|
| action | Akcja okresu istnienia zasad rotacji kluczyAkcja. | Akcja |
| Wyzwalacz | Wyzwalacz okresu istnienia zasad rotacji kluczyAkcja. | Wyzwalacz |
Akcja
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter. | "Powiadom" "Obróć" |
Wyzwalacz
| 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 |
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla