Microsoft.ApiManagement service/openidConnectProviders 2023-03-01-preview
- 最新
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep 資源定義
服務/openidConnectProviders 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/openidConnectProviders 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
屬性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：服務 |
| 性能 | OpenId Connect 提供者合約屬性。 | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 | 字串 （必要） |
| clientSecret | 開發人員主控台的用戶端秘密，這是用戶端應用程式。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 描述 | OpenID Connect 提供者的用戶易記描述。 | 字串 |
| displayName | 用戶易記的 OpenID Connect 提供者名稱。 | 字串 約束： 最大長度 = （必要） |
| metadataEndpoint | 元數據端點 URI。 | 字串 （必要） |
| useInApiDocumentation | 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 | bool |
| useInTestConsole | 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 | bool |
ARM 樣本資源定義
服務/openidConnectProviders 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/openidConnectProviders 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
屬性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2023-03-01-preview' |
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 性能 | OpenId Connect 提供者合約屬性。 | OpenidConnectProviderContractProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/openidConnectProviders' |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 | 字串 （必要） |
| clientSecret | 開發人員主控台的用戶端秘密，這是用戶端應用程式。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 描述 | OpenID Connect 提供者的用戶易記描述。 | 字串 |
| displayName | 用戶易記的 OpenID Connect 提供者名稱。 | 字串 約束： 最大長度 = （必要） |
| metadataEndpoint | 元數據端點 URI。 | 字串 （必要） |
| useInApiDocumentation | 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 | bool |
| useInTestConsole | 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 | bool |
Terraform （AzAPI 提供者） 資源定義
服務/openidConnectProviders 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/openidConnectProviders 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"
name = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
屬性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | OpenId Connect 提供者合約屬性。 | OpenidConnectProviderContractProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview” |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 開發人員主控台的用戶端識別碼，這是用戶端應用程式。 | 字串 （必要） |
| clientSecret | 開發人員主控台的用戶端秘密，這是用戶端應用程式。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 描述 | OpenID Connect 提供者的用戶易記描述。 | 字串 |
| displayName | 用戶易記的 OpenID Connect 提供者名稱。 | 字串 約束： 最大長度 = （必要） |
| metadataEndpoint | 元數據端點 URI。 | 字串 （必要） |
| useInApiDocumentation | 如果為 true，則會在開發人員入口網站的 API 檔中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 False。 | bool |
| useInTestConsole | 如果為 true，可以在開發人員入口網站測試控制台中使用 Open ID Connect 提供者。 如果未提供任何值，則預設為 True。 | bool |