Microsoft.KeyVault vaults/secrets
Definicja zasobu Bicep
Typ zasobu magazynów/wpisów tajnych 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.
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.
Format zasobu
Aby utworzyć zasób Microsoft.KeyVault/vaults/secrets, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2023-07-01' = {
name: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
}
Wartości właściwości
magazyny/wpisy tajne
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep. |
ciąg (wymagany) Limit znaków: 1–127 Prawidłowe znaki: Alfanumeryczne i łączniki. |
| Tagi | Tagi, które zostaną przypisane do wpisu tajnego. | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| 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 wpisu tajnego | SecretProperties (wymagane) |
SecretProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Atrybuty | Atrybuty wpisu tajnego. | SecretAttributes |
| contentType | Typ zawartości wpisu tajnego. | struna |
| wartość | Wartość wpisu tajnego. UWAGA: wartość nigdy nie zostanie zwrócona z usługi, ponieważ interfejsy API korzystające z tego modelu są przeznaczone do użytku wewnętrznego we wdrożeniach usługi ARM. Użytkownicy powinni używać usługi REST płaszczyzny danych do interakcji z wpisami tajnymi magazynu. | struna |
Atrybuty secretAttributes
| 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 |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
Tworzenie usługi API Management przy użyciu protokołu SSL z usługi KeyVault wdrażanie  |
Ten szablon wdraża usługę API Management skonfigurowaną przy użyciu tożsamości przypisanej przez użytkownika. Używa tej tożsamości do pobierania certyfikatu SSL z usługi KeyVault i aktualizuje go co 4 godziny. |
|
tworzy klaster usługi Azure Stack HCI 23H2 wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
tworzy klaster usługi Azure Stack HCI 23H2 wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM przy użyciu niestandardowego adresu IP magazynu |
|
tworzy klaster usługi Azure Stack HCI 23H2 w trybie sieciowym przełącznika bez przełącznika z dwoma łączami wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
tworzy klaster usługi Azure Stack HCI 23H2 w trybie sieci Switchless-SingleLink wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
Tworzenie usługi Azure Key Vault i wpisu tajnego wdrażanie |
Ten szablon tworzy usługę Azure Key Vault i wpis tajny. |
|
Tworzenie usługi Azure Key Vault przy użyciu kontroli dostępu opartej na rolach i klucza tajnego wdrażanie |
Ten szablon tworzy usługę Azure Key Vault i wpis tajny. Zamiast polegać na zasadach dostępu, korzysta ona z kontroli dostępu opartej na rolach platformy Azure w celu zarządzania autoryzacją wpisów tajnych |
|
Nawiązywanie połączenia z usługą Key Vault za pośrednictwem prywatnego punktu końcowego wdrażanie |
W tym przykładzie pokazano, jak skonfigurować sieć wirtualną i prywatną strefę DNS w celu uzyskania dostępu do usługi Key Vault za pośrednictwem prywatnego punktu końcowego. |
|
Tworzenie usługi Key Vault i lista wpisów tajnych wdrażanie |
Ten szablon tworzy usługę Key Vault i listę wpisów tajnych w magazynie kluczy, które są przekazywane wraz z parametrami |
|
Tworzenie tokenu SAS usługi Azure Maps przechowywanego w usłudze Azure Key Vault wdrażanie |
Ten szablon wdraża konto usługi Azure Maps i wyświetla token sygnatury dostępu współdzielonego na podstawie podanej tożsamości przypisanej przez użytkownika, która ma być przechowywana w kluczu tajnym usługi Azure Key Vault. |
|
tworzenie usługi Application Gateway w wersji 2 przy użyciu usługi Key Vault wdrażanie |
Ten szablon wdraża usługę Application Gateway w wersji 2 w sieci wirtualnej, tożsamość zdefiniowaną przez użytkownika, usługę Key Vault, wpis tajny (dane certyfikatu) i zasady dostępu w usłudze Key Vault i usłudze Application Gateway. |
| środowisko testowe dla usługi Azure Firewall — wersja Premium wdrażanie |
Ten szablon tworzy usługę Azure Firewall — wersja Premium i zasady zapory z funkcjami premium, takimi jak wykrywanie inspekcji włamań (IDPS), inspekcja protokołu TLS i filtrowanie kategorii internetowej |
|
Tworzenie kluczy ssh-keys i przechowywanie w usłudze KeyVault wdrażanie |
Ten szablon używa zasobu deploymentScript do generowania kluczy SSH i przechowywania klucza prywatnego w usłudze keyVault. |
|
aplikacji funkcji platformy Azure i funkcji wyzwalanej przez protokół HTTP wdrażanie |
W tym przykładzie wdrożono aplikację funkcji platformy Azure i funkcję wyzwalaną przez protokół HTTP w tekście w szablonie. Wdraża również usługę Key Vault i wypełnia wpis tajny kluczem hosta aplikacji funkcji. |
|
Application Gateway z wewnętrznymi usługami API Management i Web App wdrażanie |
Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
Definicja zasobu szablonu usługi ARM
Typ zasobu magazynów/wpisów tajnych 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.
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.
Format zasobu
Aby utworzyć zasób Microsoft.KeyVault/vaults/secrets, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2023-07-01",
"name": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
}
}
Wartości właściwości
magazyny/wpisy tajne
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.KeyVault/vaults/secrets" |
| apiVersion | Wersja interfejsu API zasobów | '2023-07-01' |
| nazwa | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON. |
ciąg (wymagany) Limit znaków: 1–127 Prawidłowe znaki: Alfanumeryczne i łączniki. |
| Tagi | Tagi, które zostaną przypisane do wpisu tajnego. | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| Właściwości | Właściwości wpisu tajnego | SecretProperties (wymagane) |
SecretProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Atrybuty | Atrybuty wpisu tajnego. | SecretAttributes |
| contentType | Typ zawartości wpisu tajnego. | struna |
| wartość | Wartość wpisu tajnego. UWAGA: wartość nigdy nie zostanie zwrócona z usługi, ponieważ interfejsy API korzystające z tego modelu są przeznaczone do użytku wewnętrznego we wdrożeniach usługi ARM. Użytkownicy powinni używać usługi REST płaszczyzny danych do interakcji z wpisami tajnymi magazynu. | struna |
Atrybuty secretAttributes
| 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 |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
Tworzenie usługi API Management przy użyciu protokołu SSL z usługi KeyVault wdrażanie |
Ten szablon wdraża usługę API Management skonfigurowaną przy użyciu tożsamości przypisanej przez użytkownika. Używa tej tożsamości do pobierania certyfikatu SSL z usługi KeyVault i aktualizuje go co 4 godziny. |
|
tworzy klaster usługi Azure Stack HCI 23H2 wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
tworzy klaster usługi Azure Stack HCI 23H2 wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM przy użyciu niestandardowego adresu IP magazynu |
|
tworzy klaster usługi Azure Stack HCI 23H2 w trybie sieciowym przełącznika bez przełącznika z dwoma łączami wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
tworzy klaster usługi Azure Stack HCI 23H2 w trybie sieci Switchless-SingleLink wdrażanie |
Ten szablon tworzy klaster usługi Azure Stack HCI 23H2 przy użyciu szablonu usługi ARM. |
|
Tworzenie usługi Azure Key Vault i wpisu tajnego wdrażanie |
Ten szablon tworzy usługę Azure Key Vault i wpis tajny. |
|
Tworzenie usługi Azure Key Vault przy użyciu kontroli dostępu opartej na rolach i klucza tajnego wdrażanie |
Ten szablon tworzy usługę Azure Key Vault i wpis tajny. Zamiast polegać na zasadach dostępu, korzysta ona z kontroli dostępu opartej na rolach platformy Azure w celu zarządzania autoryzacją wpisów tajnych |
|
Nawiązywanie połączenia z usługą Key Vault za pośrednictwem prywatnego punktu końcowego wdrażanie |
W tym przykładzie pokazano, jak skonfigurować sieć wirtualną i prywatną strefę DNS w celu uzyskania dostępu do usługi Key Vault za pośrednictwem prywatnego punktu końcowego. |
|
Tworzenie usługi Key Vault i lista wpisów tajnych wdrażanie |
Ten szablon tworzy usługę Key Vault i listę wpisów tajnych w magazynie kluczy, które są przekazywane wraz z parametrami |
|
Tworzenie tokenu SAS usługi Azure Maps przechowywanego w usłudze Azure Key Vault wdrażanie |
Ten szablon wdraża konto usługi Azure Maps i wyświetla token sygnatury dostępu współdzielonego na podstawie podanej tożsamości przypisanej przez użytkownika, która ma być przechowywana w kluczu tajnym usługi Azure Key Vault. |
|
tworzenie usługi Application Gateway w wersji 2 przy użyciu usługi Key Vault wdrażanie |
Ten szablon wdraża usługę Application Gateway w wersji 2 w sieci wirtualnej, tożsamość zdefiniowaną przez użytkownika, usługę Key Vault, wpis tajny (dane certyfikatu) i zasady dostępu w usłudze Key Vault i usłudze Application Gateway. |
| środowisko testowe dla usługi Azure Firewall — wersja Premium wdrażanie |
Ten szablon tworzy usługę Azure Firewall — wersja Premium i zasady zapory z funkcjami premium, takimi jak wykrywanie inspekcji włamań (IDPS), inspekcja protokołu TLS i filtrowanie kategorii internetowej |
|
Tworzenie kluczy ssh-keys i przechowywanie w usłudze KeyVault wdrażanie |
Ten szablon używa zasobu deploymentScript do generowania kluczy SSH i przechowywania klucza prywatnego w usłudze keyVault. |
|
aplikacji funkcji platformy Azure i funkcji wyzwalanej przez protokół HTTP wdrażanie |
W tym przykładzie wdrożono aplikację funkcji platformy Azure i funkcję wyzwalaną przez protokół HTTP w tekście w szablonie. Wdraża również usługę Key Vault i wypełnia wpis tajny kluczem hosta aplikacji funkcji. |
|
Application Gateway z wewnętrznymi usługami API Management i Web App wdrażanie |
Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu magazynów/wpisów tajnych 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/secrets, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2023-07-01"
name = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
Wartości właściwości
magazyny/wpisy tajne
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.KeyVault/vaults/secrets@2023-07-01" |
| nazwa | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–127 Prawidłowe znaki: Alfanumeryczne i łączniki. |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: magazyny |
| Tagi | Tagi, które zostaną przypisane do wpisu tajnego. | Słownik nazw tagów i wartości. |
| Właściwości | Właściwości wpisu tajnego | SecretProperties (wymagane) |
SecretProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Atrybuty | Atrybuty wpisu tajnego. | SecretAttributes |
| contentType | Typ zawartości wpisu tajnego. | struna |
| wartość | Wartość wpisu tajnego. UWAGA: wartość nigdy nie zostanie zwrócona z usługi, ponieważ interfejsy API korzystające z tego modelu są przeznaczone do użytku wewnętrznego we wdrożeniach usługi ARM. Użytkownicy powinni używać usługi REST płaszczyzny danych do interakcji z wpisami tajnymi magazynu. | struna |
Atrybuty secretAttributes
| 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 |