Microsoft.ApiManagement service/openidConnectProviders 2023-09-01-preview

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

屬性值

service/openidConnectProviders

名字 描述 價值
名字 資源名稱

請參閱如何在 Bicep 中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-80

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

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

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 OpenId Connect 提供者合約屬性。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名字 描述 價值
clientId 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 字串 （必要）
clientSecret 開發人員主控台的用戶端秘密，這是用戶端應用程式。 字串

約束：
敏感性值。 以安全參數的形式傳入。
描述 OpenID Connect 提供者的用戶易記描述。 字串
displayName 用戶易記的 OpenID Connect 提供者名稱。 字串 （必要）

約束：
最大長度 = 50
metadataEndpoint 元數據端點 URI。 字串 （必要）
useInApiDocumentation 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 bool
useInTestConsole 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 bool

快速入門範本

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

範本 描述
使用範本 建立 API 管理實例和所有子資源

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

ARM 樣本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

屬性值

service/openidConnectProviders

名字 描述 價值
類型 資源類型 'Microsoft.ApiManagement/service/openidConnectProviders'
apiVersion 資源 API 版本 '2023-09-01-preview'
名字 資源名稱

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

字元限制：1-80

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

以字母開頭，並以英數位元結尾。
性能 OpenId Connect 提供者合約屬性。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名字 描述 價值
clientId 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 字串 （必要）
clientSecret 開發人員主控台的用戶端秘密，這是用戶端應用程式。 字串

約束：
敏感性值。 以安全參數的形式傳入。
描述 OpenID Connect 提供者的用戶易記描述。 字串
displayName 用戶易記的 OpenID Connect 提供者名稱。 字串 （必要）

約束：
最大長度 = 50
metadataEndpoint 元數據端點 URI。 字串 （必要）
useInApiDocumentation 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 bool
useInTestConsole 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 bool

快速入門範本

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

範本 描述
使用範本 建立 API 管理實例和所有子資源

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

Terraform （AzAPI 提供者） 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

屬性值

service/openidConnectProviders

名字 描述 價值
類型 資源類型 “Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview”
名字 資源名稱 字串 （必要）

字元限制：1-80

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

以字母開頭，並以英數位元結尾。
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 OpenId Connect 提供者合約屬性。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名字 描述 價值
clientId 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 字串 （必要）
clientSecret 開發人員主控台的用戶端秘密，這是用戶端應用程式。 字串

約束：
敏感性值。 以安全參數的形式傳入。
描述 OpenID Connect 提供者的用戶易記描述。 字串
displayName 用戶易記的 OpenID Connect 提供者名稱。 字串 （必要）

約束：
最大長度 = 50
metadataEndpoint 元數據端點 URI。 字串 （必要）
useInApiDocumentation 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 bool
useInTestConsole 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 bool