Microsoft.KeyVault 保存庫/秘密

• 最新
• 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

Bicep 資源定義

儲存庫/秘密資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

備註

如需使用金鑰保存庫進行安全值的指引，請參閱 使用 Bicep 管理秘密。

如需建立秘密的快速入門，請參閱快速入門：使用ARM樣本從 Azure 金鑰保存庫 設定和擷取秘密。

如需建立金鑰的快速入門，請參閱 快速入門：使用ARM樣本建立 Azure 金鑰保存庫和金鑰。

資源格式

若要建立 Microsoft.KeyVault/vaults/secrets 資源，請將下列 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'
  }
}

屬性值

vaults/secrets

名稱	描述	值
NAME	資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。	需要字串 () 字元限制：1-127 合法字元： 英數字元和連字號。
tags	將指派給秘密的標記。	標記名稱和值的字典。 請參閱 範本中的標籤
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型資源的符號名稱： 保存庫
properties	秘密的屬性	需要 SecretProperties ()

SecretProperties

名稱	描述	值
屬性	秘密的屬性。	SecretAttributes
ContentType	秘密的內容類型。	字串
value	密碼的值。 注意：'value' 永遠不會從服務傳回，因為使用此模型的 API 適用於 ARM 部署的內部使用。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。	字串

SecretAttributes

名稱	描述	值
已啟用	判斷物件是否已啟用。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
nbf	1970-01-01T00：00：00Z 之後的日期不是以秒為單位。	int

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
適用於 Azure 的 SAS 9.4 和 Viya 快速入門範本	適用於 Azure 的 SAS® 9.4 和 Viya 快速入門範本會在雲端上部署這些產品：SAS Enterprise BI Server 9.4、SAS®® Enterprise Miner 15.1 和 Linux 上的 SAS 可視化分析 8.5，以及 Linux 上的 SAS®® 視覺數據採礦和 Machine Learning 8.5 for Viya。 本快速入門是一種參考架構，適用於想要使用雲端易記技術在 Azure 上部署 SAS® 9.4 和 Viya 組合的使用者。 藉由在 Azure 上部署 SAS® 平臺，您可以取得 SAS® 9.4 和 Viya 環境的整合環境，以便利用這兩個世界。 SAS® Viya 是啟用雲端的記憶體內部分析引擎。 其使用彈性、可調整且容錯的處理來解決複雜的分析挑戰。 SAS® Viya 使用支援 SAS®、Python、R、Java 和 Lua 程式設計的標準化程式代碼基底，提供更快速的分析處理。 它也支援雲端、內部部署或混合式環境，並順暢地部署到任何基礎結構或應用程式生態系統。
從 KeyVault 使用 SSL 建立 API 管理 服務	此範本會部署使用使用者指派的身分識別所設定的 API 管理 服務。 它會使用此身分識別從 KeyVault 擷取 SSL 憑證，並每隔 4 小時檢查一次來保持更新。
建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
建立 Azure Key Vault 和秘密	此範本會建立 Azure 金鑰保存庫 和秘密。
使用 RBAC 和秘密建立 Azure 金鑰保存庫	此範本會建立 Azure 金鑰保存庫 和秘密。 它不會依賴存取原則，而是利用 Azure RBAC 來管理秘密的授權
透過私人端點連線到 金鑰保存庫	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取 金鑰保存庫。
建立 Key Vault 和秘密清單	此範本會依照參數一起傳遞，建立金鑰保存庫中的 金鑰保存庫 和秘密清單
建立儲存在 Azure 金鑰保存庫 中的 Azure 地圖服務 SAS 令牌	此範本會部署和 Azure 地圖服務 帳戶，並根據所提供的使用者指派身分識別來列出 Sas 令牌，以儲存在 Azure 金鑰保存庫 秘密中。
使用 金鑰保存庫 建立 應用程式閘道 V2	此範本會在 虛擬網路、使用者定義身分識別、金鑰保存庫、秘密 (憑證數據) 中部署 應用程式閘道 V2，以及在 金鑰保存庫 和 應用程式閘道 上存取原則。
Azure 防火牆 Premium 的測試環境	此範本會建立具有進階功能的 Azure 防火牆 進階和防火牆原則，例如入侵檢查偵測 (IDPS) 、TLS 檢查和 Web 類別篩選
建立 ssh 金鑰並儲存在 KeyVault 中	此範本會使用 deploymentScript 資源來產生 ssh 金鑰，並將私鑰儲存在 keyVault 中。
Azure 函式應用程式和 HTTP 觸發的函式	此範例會在範本中內嵌部署 Azure 函式應用程式和 HTTP 觸發的函式。 它也會部署 金鑰保存庫，並使用函式應用程式的主機金鑰填入秘密。
使用內部 API 管理 和 Web 應用程式進行 應用程式閘道	應用程式閘道 將因特網流量路由傳送至虛擬網路 (內部模式) API 管理 實例，以服務裝載於 Azure Web 應用程式中的 Web API。

ARM 範本資源定義

您可以使用目標作業來部署儲存庫/秘密資源類型：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

備註

如需使用金鑰保存庫進行安全值的指引，請參閱 使用 Bicep 管理秘密。

如需建立秘密的快速入門，請參閱快速入門：使用ARM樣本從 Azure 金鑰保存庫 設定和擷取秘密。

如需建立金鑰的快速入門，請參閱 快速入門：使用ARM樣本建立 Azure 金鑰保存庫和金鑰。

資源格式

若要建立 Microsoft.KeyVault/vaults/secrets 資源，請將下列 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"
  }
}

屬性值

vaults/secrets

名稱	描述	值
類型	資源類型	'Microsoft.KeyVault/vaults/secrets'
apiVersion	資源 API 版本	'2023-07-01'
NAME	資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。	字串 (必要) 字元限制：1-127 合法字元： 英數字元和連字號。
tags	將指派給秘密的標記。	標記名稱和值的字典。 請參閱 範本中的標記
properties	秘密的屬性	SecretProperties (必要)

SecretProperties

名稱	描述	值
屬性	秘密的屬性。	SecretAttributes
ContentType	秘密的內容類型。	字串
value	密碼的值。 注意：'value' 永遠不會從服務傳回，因為使用此模型的 API 適用於 ARM 部署的內部用途。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。	字串

SecretAttributes

名稱	描述	值
已啟用	判斷物件是否已啟用。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
nbf	自 1970-01-01T00：00：00Z 以來的日期不是在秒內。	int

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
適用於 Azure 的 SAS 9.4 和 Viya 快速入門範本	適用於 Azure 的 SAS® 9.4 和 Viya 快速入門範本會在雲端上部署這些產品：SAS Enterprise BI Server 9.4、SAS®® Enterprise Miner 15.1 和 Linux 上的 SAS 可視化分析 8.5，以及 Linux 上的 SAS®® 視覺數據採礦和 Machine Learning 8.5 for Viya。 本快速入門是一種參考架構，適用於想要使用雲端易記技術在 Azure 上部署 SAS® 9.4 和 Viya 組合的使用者。 藉由在 Azure 上部署 SAS® 平臺，您可以取得 SAS® 9.4 和 Viya 環境的整合環境，以便利用這兩個世界。 SAS® Viya 是啟用雲端的記憶體內部分析引擎。 其使用彈性、可調整且容錯的處理來解決複雜的分析挑戰。 SAS® Viya 使用支援 SAS®、Python、R、Java 和 Lua 程式設計的標準化程式代碼基底，提供更快速的分析處理。 它也支援雲端、內部部署或混合式環境，並順暢地部署到任何基礎結構或應用程式生態系統。
從 KeyVault 使用 SSL 建立 API 管理 服務	此範本會部署使用使用者指派的身分識別所設定的 API 管理 服務。 它會使用此身分識別從 KeyVault 擷取 SSL 憑證，並每隔 4 小時檢查一次來保持更新。
建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
建立 Azure Key Vault 和秘密	此範本會建立 Azure 金鑰保存庫 和秘密。
使用 RBAC 和秘密建立 Azure 金鑰保存庫	此範本會建立 Azure 金鑰保存庫 和秘密。 它不會依賴存取原則，而是利用 Azure RBAC 來管理秘密的授權
透過私人端點連線到 金鑰保存庫	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取 金鑰保存庫。
建立 Key Vault 和秘密清單	此範本會建立 金鑰保存庫和金鑰保存庫中的秘密清單，連同參數一起傳遞
建立儲存在 Azure 金鑰保存庫 中的 Azure 地圖服務 SAS 令牌	此範本會部署和 Azure 地圖服務 帳戶，並根據要儲存在 Azure 金鑰保存庫 秘密中提供的使用者指派身分識別來列出 Sas 令牌。
使用 金鑰保存庫 建立 應用程式閘道 V2	此範本會在 虛擬網路、使用者定義身分識別、金鑰保存庫、秘密 (憑證數據) ，以及在 金鑰保存庫 和 應用程式閘道 上部署 應用程式閘道 V2。
Azure 防火牆 Premium 的測試環境	此範本會建立具有進階功能的 Azure 防火牆 進階和防火牆原則，例如入侵檢測 (IDPS) 、TLS 檢查和 Web 類別篩選
建立 ssh-keys 並儲存在 KeyVault 中	此範本會使用 deploymentScript 資源來產生 ssh 金鑰，並將私鑰儲存在 keyVault 中。
Azure 函式應用程式和 HTTP 觸發的函式	此範例會在範本中內嵌部署 Azure 函式應用程式和 HTTP 觸發的函式。 它也會部署 金鑰保存庫，並使用函式應用程式的主機金鑰填入秘密。
使用內部 API 管理和 Web 應用程式 應用程式閘道	應用程式閘道 將因特網流量路由傳送至虛擬網路， (內部模式) API 管理 實例，其服務裝載於 Azure Web 應用程式中的 Web API。

Terraform (AzAPI 提供者) 資源定義

儲存庫/秘密資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.KeyVault/vaults/secrets 資源，請將下列 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"
    }
  })
}

屬性值

vaults/secrets

名稱	描述	值
類型	資源類型	“Microsoft.KeyVault/vaults/secrets@2023-07-01”
NAME	資源名稱	需要字串 () 字元限制：1-127 合法字元： 英數字元和連字號。
parent_id	此資源父系之資源的標識碼。	類型資源的識別碼： 保存庫
tags	將指派給秘密的標記。	標記名稱和值的字典。
properties	秘密的屬性	需要 SecretProperties ()

SecretProperties

名稱	描述	值
屬性	秘密的屬性。	SecretAttributes
ContentType	秘密的內容類型。	字串
value	密碼的值。 注意：'value' 永遠不會從服務傳回，因為使用此模型的 API 適用於 ARM 部署的內部使用。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。	字串

SecretAttributes

名稱	描述	值
已啟用	判斷物件是否已啟用。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
nbf	自 1970-01-01T00：00：00Z 以來的日期不是在秒內。	int