Trezory a tajné kódy Microsoft.KeyVault
- nejnovější
-
2023-07-01 - 2023-02-01
- 11. 11. 2022
-
2022-07-07 -
2022-022-01-preview -
11. 11. 2021 ve verzi Preview - 10. 10. 2021
-
2021-06-01-preview -
2021-04-01-preview -
2020-04-01-preview -
2019-09-09 - 2018-02-14
-
2018-02-14-preview - 10. 10. 2016
Definice prostředku Bicep
Trezory nebo typy prostředků tajných kódů je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Poznámky
Pokyny k používání trezorů klíčů pro zabezpečené hodnoty najdete v tématu Správa tajných kódů pomocíBicep .
Rychlý start k vytvoření tajného kódu najdete v tématu Rychlý start: Nastavení a načtení tajného kódu ze služby Azure Key Vault pomocí šablony ARM.
Rychlý start k vytvoření klíče najdete v tématu Rychlý start: Vytvoření trezoru klíčů Azure a klíče pomocí šablony ARM.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault,vaults/secrets, přidejte do šablony následující bicep.
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'
}
}
Hodnoty vlastností
trezory/tajné kódy
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku Podívejte se, jak nastavit názvy a typy podřízených prostředků v Bicep. |
string (povinné) Limit znaků: 1-127 Platné znaky: Alfanumerické znaky a spojovníky |
| visačky | Značky, které budou přiřazeny tajnému klíči. | Slovník názvů a hodnot značek Viz Značky v šablonách |
| rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: trezory |
| vlastnosti | Vlastnosti tajného klíče | secretProperties (povinné) |
SecretProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| atributy | Atributy tajného kódu. | secretAttributes |
| contentType | Typ obsahu tajného klíče. | řetězec |
| hodnota | Hodnota tajného kódu. POZNÁMKA: Hodnota se nikdy nevrátí ze služby, protože rozhraní API používající tento model jsou určená pro interní použití v nasazeních ARM. Uživatelé by měli použít službu REST roviny dat pro interakci s tajnými kódy trezoru. | řetězec |
SecretAttributes
| Jméno | Popis | Hodnota |
|---|---|---|
| zpřístupněný | Určuje, zda je objekt povolen. | Bool |
| Exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | Int |
| nbf | Před datem v sekundách od 1970-01-01T00:00:00Z. | Int |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
| Šablona | Popis |
|---|---|
|
vytvoření služby API Management s protokolem SSL ze služby KeyVault nasazení  |
Tato šablona nasadí službu API Management nakonfigurovanou s identitou přiřazenou uživatelem. Tato identita používá k načtení certifikátu SSL ze služby KeyVault a udržuje ji aktualizovanou kontrolou každých 4 hodin. |
|
vytvoří cluster Azure Stack HCI 23H2 nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoří cluster Azure Stack HCI 23H2 nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM pomocí vlastní IP adresy úložiště. |
|
vytvoří cluster Azure Stack HCI 23H2 v bezpínacím režimu sítě s duálním propojením nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoří cluster Azure Stack HCI 23H2 v Switchless-SingleLink síťovém režimu nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoření služby Azure Key Vault a tajného kódu nasazení |
Tato šablona vytvoří službu Azure Key Vault a tajný klíč. |
|
vytvoření služby Azure Key Vault pomocí RBAC a tajného nasazení |
Tato šablona vytvoří službu Azure Key Vault a tajný klíč. Místo spoléhání na zásady přístupu využívá Azure RBAC ke správě autorizace tajných kódů. |
|
připojení ke službě Key Vault prostřednictvím privátního koncového bodu nasazení |
Tato ukázka ukazuje, jak použít konfiguraci virtuální sítě a privátní zóny DNS pro přístup ke službě Key Vault prostřednictvím privátního koncového bodu. |
|
Vytvoření služby Key Vault a seznam tajných kódů nasazení |
Tato šablona vytvoří službu Key Vault a seznam tajných kódů v trezoru klíčů, jak je předáno, spolu s parametry. |
|
vytvoření tokenu SAS služby Azure Maps uloženého ve službě Azure Key Vault nasazení |
Tato šablona nasadí účet Azure Maps a vypíše token Sas na základě poskytnuté identity přiřazené uživatelem, která se má uložit v tajném kódu služby Azure Key Vault. |
|
vytvoření služby Application Gateway V2 se službou Key Vault nasazení |
Tato šablona nasadí službu Application Gateway V2 ve virtuální síti, identitu definovanou uživatelem, službu Key Vault, tajný klíč (data certifikátu) a zásadu přístupu ve službě Key Vault a službě Application Gateway. |
|
Testovací prostředí pro službu Azure Firewall Premium nasazení |
Tato šablona vytvoří zásady brány Azure Firewall Premium a brány firewall s prémiovými funkcemi, jako je detekce kontroly neoprávněných vniknutí (IDPS), kontrola protokolu TLS a filtrování kategorií webu. |
|
Vytvoření klíčů ssh a uložení ve službě KeyVault nasazení |
Tato šablona používá prostředek deploymentScriptu k vygenerování klíčů SSH a uložení privátního klíče do služby KeyVault. |
|
aplikaci Funkcí Azure a funkci aktivovanou protokolem HTTP nasazení |
Tento příklad nasadí aplikaci Funkcí Azure a vloženou funkci aktivovanou protokolem HTTP v šabloně. Nasadí také službu Key Vault a naplní tajný kód klíčem hostitele aplikace funkcí. |
|
Application Gateway s interní službou API Management a webovou aplikací nasazení |
Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure. |
Definice prostředku šablony ARM
Trezory nebo typy prostředků tajných kódů je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Poznámky
Pokyny k používání trezorů klíčů pro zabezpečené hodnoty najdete v tématu Správa tajných kódů pomocíBicep .
Rychlý start k vytvoření tajného kódu najdete v tématu Rychlý start: Nastavení a načtení tajného kódu ze služby Azure Key Vault pomocí šablony ARM.
Rychlý start k vytvoření klíče najdete v tématu Rychlý start: Vytvoření trezoru klíčů Azure a klíče pomocí šablony ARM.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault,vaults/secrets, přidejte do šablony následující KÓD JSON.
{
"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"
}
}
Hodnoty vlastností
trezory/tajné kódy
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/vaults/secrets |
| apiVersion | Verze rozhraní API prostředku | '2023-07-01' |
| Jméno | Název prostředku Podívejte se, jak nastavit názvy a typy podřízených prostředků v šablonách JSON ARM. |
string (povinné) Limit znaků: 1-127 Platné znaky: Alfanumerické znaky a spojovníky |
| visačky | Značky, které budou přiřazeny tajnému klíči. | Slovník názvů a hodnot značek Viz Značky v šablonách |
| vlastnosti | Vlastnosti tajného klíče | secretProperties (povinné) |
SecretProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| atributy | Atributy tajného kódu. | secretAttributes |
| contentType | Typ obsahu tajného klíče. | řetězec |
| hodnota | Hodnota tajného kódu. POZNÁMKA: Hodnota se nikdy nevrátí ze služby, protože rozhraní API používající tento model jsou určená pro interní použití v nasazeních ARM. Uživatelé by měli použít službu REST roviny dat pro interakci s tajnými kódy trezoru. | řetězec |
SecretAttributes
| Jméno | Popis | Hodnota |
|---|---|---|
| zpřístupněný | Určuje, zda je objekt povolen. | Bool |
| Exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | Int |
| nbf | Před datem v sekundách od 1970-01-01T00:00:00Z. | Int |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
| Šablona | Popis |
|---|---|
|
vytvoření služby API Management s protokolem SSL ze služby KeyVault nasazení |
Tato šablona nasadí službu API Management nakonfigurovanou s identitou přiřazenou uživatelem. Tato identita používá k načtení certifikátu SSL ze služby KeyVault a udržuje ji aktualizovanou kontrolou každých 4 hodin. |
|
vytvoří cluster Azure Stack HCI 23H2 nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoří cluster Azure Stack HCI 23H2 nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM pomocí vlastní IP adresy úložiště. |
|
vytvoří cluster Azure Stack HCI 23H2 v bezpínacím režimu sítě s duálním propojením nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoří cluster Azure Stack HCI 23H2 v Switchless-SingleLink síťovém režimu nasazení |
Tato šablona vytvoří cluster Azure Stack HCI 23H2 pomocí šablony ARM. |
|
vytvoření služby Azure Key Vault a tajného kódu nasazení |
Tato šablona vytvoří službu Azure Key Vault a tajný klíč. |
|
vytvoření služby Azure Key Vault pomocí RBAC a tajného nasazení |
Tato šablona vytvoří službu Azure Key Vault a tajný klíč. Místo spoléhání na zásady přístupu využívá Azure RBAC ke správě autorizace tajných kódů. |
|
připojení ke službě Key Vault prostřednictvím privátního koncového bodu nasazení |
Tato ukázka ukazuje, jak použít konfiguraci virtuální sítě a privátní zóny DNS pro přístup ke službě Key Vault prostřednictvím privátního koncového bodu. |
|
Vytvoření služby Key Vault a seznam tajných kódů nasazení |
Tato šablona vytvoří službu Key Vault a seznam tajných kódů v trezoru klíčů, jak je předáno, spolu s parametry. |
|
vytvoření tokenu SAS služby Azure Maps uloženého ve službě Azure Key Vault nasazení |
Tato šablona nasadí účet Azure Maps a vypíše token Sas na základě poskytnuté identity přiřazené uživatelem, která se má uložit v tajném kódu služby Azure Key Vault. |
|
vytvoření služby Application Gateway V2 se službou Key Vault nasazení |
Tato šablona nasadí službu Application Gateway V2 ve virtuální síti, identitu definovanou uživatelem, službu Key Vault, tajný klíč (data certifikátu) a zásadu přístupu ve službě Key Vault a službě Application Gateway. |
|
Testovací prostředí pro službu Azure Firewall Premium nasazení |
Tato šablona vytvoří zásady brány Azure Firewall Premium a brány firewall s prémiovými funkcemi, jako je detekce kontroly neoprávněných vniknutí (IDPS), kontrola protokolu TLS a filtrování kategorií webu. |
|
Vytvoření klíčů ssh a uložení ve službě KeyVault nasazení |
Tato šablona používá prostředek deploymentScriptu k vygenerování klíčů SSH a uložení privátního klíče do služby KeyVault. |
|
aplikaci Funkcí Azure a funkci aktivovanou protokolem HTTP nasazení |
Tento příklad nasadí aplikaci Funkcí Azure a vloženou funkci aktivovanou protokolem HTTP v šabloně. Nasadí také službu Key Vault a naplní tajný kód klíčem hostitele aplikace funkcí. |
|
Application Gateway s interní službou API Management a webovou aplikací nasazení |
Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Trezory nebo typy prostředků tajných kódů je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault/vaults/secrets, přidejte do šablony následující Terraform.
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"
}
})
}
Hodnoty vlastností
trezory/tajné kódy
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/vaults/secrets@2023-07-01 |
| Jméno | Název prostředku | string (povinné) Limit znaků: 1-127 Platné znaky: Alfanumerické znaky a spojovníky |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: trezory |
| visačky | Značky, které budou přiřazeny tajnému klíči. | Slovník názvů a hodnot značek |
| vlastnosti | Vlastnosti tajného klíče | secretProperties (povinné) |
SecretProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| atributy | Atributy tajného kódu. | secretAttributes |
| contentType | Typ obsahu tajného klíče. | řetězec |
| hodnota | Hodnota tajného kódu. POZNÁMKA: Hodnota se nikdy nevrátí ze služby, protože rozhraní API používající tento model jsou určená pro interní použití v nasazeních ARM. Uživatelé by měli použít službu REST roviny dat pro interakci s tajnými kódy trezoru. | řetězec |
SecretAttributes
| Jméno | Popis | Hodnota |
|---|---|---|
| zpřístupněný | Určuje, zda je objekt povolen. | Bool |
| Exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | Int |
| nbf | Před datem v sekundách od 1970-01-01T00:00:00Z. | Int |