Microsoft.KeyVault-valv/hemligheter 2024-04-01-preview

• senaste
• 2024-12-01-preview
• 2024-11-01
• 2024-04-01-preview
• 2023-07-01
• 2023-02-01
• 2022-11-01
• 2022-07-01
• 2022-02-01-preview
• 2021-11-01-preview
• 2021-10-01
• 2021-06-01-preview
• 2021-04-01-preview
• 2020-04-01-preview
• 2019-09-01
• 2018-02-14
• 2018-02-14-preview
• 2016-10-01

Anmärkningar

Vägledning om hur du använder nyckelvalv för säkra värden finns i Hantera hemligheter med hjälp av Bicep.

En snabbstart om hur du skapar en hemlighet finns i Snabbstart: Ange och hämta en hemlighet från Azure Key Vault med hjälp av en ARM-mall.

En snabbstart om hur du skapar en nyckel finns i Snabbstart: Skapa ett Azure-nyckelvalv och en nyckel med hjälp av ARM-mallen.

Bicep-resursdefinition

Resurstypen valv/hemligheter kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.KeyVault/vaults/secrets-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

Microsoft.KeyVault/vaults/secrets

Namn	Beskrivning	Värde
Namn	Resursnamnet	sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs)
förälder	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen.	Symboliskt namn för resurs av typen: valv
Egenskaper	Egenskaper för hemligheten	SecretProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

SecretAttributes

Namn	Beskrivning	Värde
Aktiverat	Avgör om objektet är aktiverat.	Bool
Exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	Int
nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	Int

SecretCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

SecretProperties

Namn	Beskrivning	Värde
Attribut	Hemlighetens attribut.	SecretAttributes
contentType	Hemlighetens innehållstyp.	sträng
värde	Hemlighetens värde. Obs! "värde" returneras aldrig från tjänsten eftersom API:er som använder den här modellen är avsedda för intern användning i ARM-distributioner. Användare bör använda REST-tjänsten för dataplanet för interaktion med valvhemligheter.	sträng

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil	Beskrivning
Application Gateway med intern API Management och Web App	Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Azure-funktionsapp och en HTTP-utlöst funktion	Det här exemplet distribuerar en Azure-funktionsapp och en HTTP-utlöst funktion infogad i mallen. Den distribuerar också ett Key Vault och fyller i en hemlighet med funktionsappens värdnyckel.
Skapa ett nyckelvalv och en lista över hemligheter	Den här mallen skapar ett Key Vault och en lista över hemligheter i nyckelvalvet som skickats tillsammans med parametrarna
Skapa en API Management-tjänst med SSL från KeyVault	Den här mallen distribuerar en API Management-tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme.
Skapa ett Azure Key Vault och en hemlig	Den här mallen skapar ett Azure Key Vault och en hemlighet.
Skapa ett Azure Key Vault med RBAC och en hemlig	Den här mallen skapar ett Azure Key Vault och en hemlighet. I stället för att förlita sig på åtkomstprinciper använder den Azure RBAC för att hantera auktorisering för hemligheter
FinOps Hub	Den här mallen skapar en ny FinOps-hubbinstans, inklusive Data Lake Storage och en Data Factory.
Testmiljö för Azure Firewall Premium	Den här mallen skapar en Azure Firewall Premium- och brandväggsprincip med premiumfunktioner som Identifiering av intrångsinspektion (IDPS), TLS-inspektion och webbkategorifiltrering

Resursdefinition för ARM-mall

Resurstypen valv/hemligheter kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.KeyVault/vaults/secrets-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

Microsoft.KeyVault/vaults/secrets

Namn	Beskrivning	Värde
apiVersion	API-versionen	"2024-04-01-preview"
Namn	Resursnamnet	sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs)
Egenskaper	Egenskaper för hemligheten	SecretProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.KeyVault/vaults/secrets"

SecretAttributes

Namn	Beskrivning	Värde
Aktiverat	Avgör om objektet är aktiverat.	Bool
Exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	Int
nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	Int

SecretCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

SecretProperties

Namn	Beskrivning	Värde
Attribut	Hemlighetens attribut.	SecretAttributes
contentType	Hemlighetens innehållstyp.	sträng
värde	Hemlighetens värde. Obs! "värde" returneras aldrig från tjänsten eftersom API:er som använder den här modellen är avsedda för intern användning i ARM-distributioner. Användare bör använda REST-tjänsten för dataplanet för interaktion med valvhemligheter.	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Application Gateway med intern API Management och Web App	Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Azure-funktionsapp och en HTTP-utlöst funktion	Det här exemplet distribuerar en Azure-funktionsapp och en HTTP-utlöst funktion infogad i mallen. Den distribuerar också ett Key Vault och fyller i en hemlighet med funktionsappens värdnyckel.
Anslut till ett Nyckelvalv via privat slutpunkt	Det här exemplet visar hur du använder konfigurera ett virtuellt nätverk och en privat DNS-zon för åtkomst till Key Vault via en privat slutpunkt.
Skapa ett nyckelvalv och en lista över hemligheter	Den här mallen skapar ett Key Vault och en lista över hemligheter i nyckelvalvet som skickats tillsammans med parametrarna
Skapa en API Management-tjänst med SSL från KeyVault	Den här mallen distribuerar en API Management-tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme.
Skapa en Application Gateway V2 med Key Vault	Den här mallen distribuerar en Application Gateway V2 i ett virtuellt nätverk, en användardefinierad identitet, Key Vault, en hemlighet (certifikatdata) och åtkomstprincip för Key Vault och Application Gateway.
Skapa ett Azure Key Vault och en hemlig	Den här mallen skapar ett Azure Key Vault och en hemlighet.
Skapa ett Azure Key Vault med RBAC och en hemlig	Den här mallen skapar ett Azure Key Vault och en hemlighet. I stället för att förlita sig på åtkomstprinciper använder den Azure RBAC för att hantera auktorisering för hemligheter
Skapa Azure Maps SAS-token som lagras i en Azure Key Vault-	Den här mallen distribuerar och Azure Maps-kontot och visar en Sas-token baserat på den angivna användartilldelade identiteten som ska lagras i en Azure Key Vault-hemlighet.
Skapa ssh-nycklar och lagra i KeyVault	Den här mallen använder deploymentScript-resursen för att generera ssh-nycklar och lagrar den privata nyckeln i keyVault.
skapar ett Azure Stack HCI 23H2-kluster	Den här mallen skapar ett Azure Stack HCI 23H2-kluster med hjälp av en ARM-mall med hjälp av anpassad lagrings-IP
skapar ett Azure Stack HCI 23H2-kluster	Den här mallen skapar ett Azure Stack HCI 23H2-kluster med hjälp av en ARM-mall.
skapar ett Azure Stack HCI 23H2-kluster i switchless-dual-link-nätverksläge	Den här mallen skapar ett Azure Stack HCI 23H2-kluster med hjälp av en ARM-mall.
skapar ett Azure Stack HCI 23H2-kluster i Switchless-SingleLink nätverksläge	Den här mallen skapar ett Azure Stack HCI 23H2-kluster med hjälp av en ARM-mall.
FinOps Hub	Den här mallen skapar en ny FinOps-hubbinstans, inklusive Data Lake Storage och en Data Factory.
Testmiljö för Azure Firewall Premium	Den här mallen skapar en Azure Firewall Premium- och brandväggsprincip med premiumfunktioner som Identifiering av intrångsinspektion (IDPS), TLS-inspektion och webbkategorifiltrering
uppgraderar ett Azure Stack HCI 22H2-kluster till 23H2-kluster	Den här mallen uppgraderar ett Azure Stack HCI 22H2-kluster till 23H2-kluster med hjälp av en ARM-mall.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen valv/hemligheter kan distribueras med åtgärder som mål:

• Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.KeyVault/vaults/secrets-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/secrets@2024-04-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      contentType = "string"
      value = "string"
    }
  })
}

Egenskapsvärden

Microsoft.KeyVault/vaults/secrets

Namn	Beskrivning	Värde
Namn	Resursnamnet	sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs)
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: valv
Egenskaper	Egenskaper för hemligheten	SecretProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.KeyVault/vaults/secrets@2024-04-01-preview"

SecretAttributes

Namn	Beskrivning	Värde
Aktiverat	Avgör om objektet är aktiverat.	Bool
Exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	Int
nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	Int

SecretCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

SecretProperties

Namn	Beskrivning	Värde
Attribut	Hemlighetens attribut.	SecretAttributes
contentType	Hemlighetens innehållstyp.	sträng
värde	Hemlighetens värde. Obs! "värde" returneras aldrig från tjänsten eftersom API:er som använder den här modellen är avsedda för intern användning i ARM-distributioner. Användare bör använda REST-tjänsten för dataplanet för interaktion med valvhemligheter.	sträng