Share via

Microsoft.ApiManagement 服務/憑證

  • 發行項

Bicep 資源定義

服務/憑證資源類型可以使用目標作業來部署：

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

資源格式

若要建立 Microsoft.ApiManagement/service/certificates 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

屬性值

服務/憑證

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 字串 (必要)

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： 服務
properties 憑證建立或更新屬性詳細數據。 CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

名稱 描述 值
資料 使用 application/x-pkcs12 表示法的 Base 64 編碼憑證。 字串
keyVault 憑證的 KeyVault 位置詳細數據。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password 憑證的密碼 字串

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名稱 描述 值
identityClientId SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別符，其將用來存取密鑰保存庫密碼。 字串
secretIdentifier 用於擷取秘密的金鑰保存庫秘密標識碼。 提供已設定版本的秘密會防止自動重新整理。 這需要 API 管理 服務設定 aka.ms/apimmsi 字串

快速入門範本

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

範本 描述
使用範本建立 API 管理執行個體和所有子資源

部署至 Azure		 此範本示範如何建立 API 管理 服務和設定子實體

ARM 範本資源定義

服務/憑證資源類型可以使用目標作業來部署：

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

資源格式

若要建立 Microsoft.ApiManagement/service/certificates 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

屬性值

服務/憑證

名稱 描述 值
類型 資源類型 'Microsoft.ApiManagement/service/certificates'
apiVersion 資源 API 版本 '2023-05-01-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。		 字串 (必要)

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
properties 憑證建立或更新屬性詳細數據。 CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

名稱 描述 值
資料 使用 application/x-pkcs12 表示法的 Base 64 編碼憑證。 字串
keyVault 憑證的 KeyVault 位置詳細數據。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password 憑證的密碼 字串

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名稱 描述 值
identityClientId SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別符，將用來存取密鑰保存庫秘密。 字串
secretIdentifier 用於擷取秘密的金鑰保存庫秘密標識碼。 提供已建立版本的秘密將會防止自動重新整理。 這需要以 aka.ms/apimmsi 設定 API 管理 服務 字串

快速入門範本

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

範本 描述
使用範本建立 API 管理執行個體和所有子資源

部署至 Azure		 此範本示範如何建立 API 管理 服務及設定子實體

Terraform (AzAPI 提供者) 資源定義

服務/憑證資源類型可以使用目標作業來部署：

  • 資源群組

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

資源格式

若要建立 Microsoft.ApiManagement/service/certificates 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

屬性值

服務/憑證

名稱 描述 值
類型 資源類型 “Microsoft.ApiManagement/service/certificates@2023-05-01-preview”
NAME 資源名稱 需要字串 ()

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼： 服務
properties 憑證建立或更新屬性詳細數據。 CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

名稱 描述 值
資料 使用 application/x-pkcs12 表示法的 Base 64 編碼憑證。 字串
keyVault 憑證的 KeyVault 位置詳細數據。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password 憑證的密碼 字串

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名稱 描述 值
identityClientId SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別符，將用來存取密鑰保存庫秘密。 字串
secretIdentifier 用於擷取秘密的金鑰保存庫秘密標識碼。 提供已建立版本的秘密將會防止自動重新整理。 這需要以 aka.ms/apimmsi 設定 API 管理 服務 字串