你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/openidConnectProviders 2023-05-01-preview
Bicep 资源定义
service/openidConnectProviders 资源类型可以使用以下目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
属性值
service/openidConnectProviders
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务”的资源的符号名称 |
| properties | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | 字符串 (必需) |
| clientSecret | 开发人员控制台的客户端机密，即客户端应用程序。 | 字符串 |
| description | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 (必需) |
| metadataEndpoint | 元数据终结点 URI。 | 字符串 (必需) |
| useInApiDocumentation | 如果为 true，将在开发人员门户的 API 文档中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可以在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建API 管理服务和配置子实体 |
ARM 模板资源定义
service/openidConnectProviders 资源类型可以使用以下目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
属性值
service/openidConnectProviders
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.ApiManagement/service/openidConnectProviders' |
| apiVersion | 资源 API 版本 | “2023-05-01-preview” |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| properties | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | 字符串 (必需) |
| clientSecret | 开发人员控制台的客户端机密，即客户端应用程序。 | 字符串 |
| description | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 (必需) |
| metadataEndpoint | 元数据终结点 URI。 | 字符串 (必需) |
| useInApiDocumentation | 如果为 true，将在开发人员门户的 API 文档中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可以在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建API 管理服务和配置子实体 |
Terraform (AzAPI 提供程序) 资源定义
service/openidConnectProviders 资源类型可以使用以下目标操作进行部署：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-05-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
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/openidConnectProviders@2023-05-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| parent_id | 此资源的父资源 ID。 | 类型为“服务”的资源的 ID |
| properties | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | 字符串 (必需) |
| clientSecret | 开发人员控制台的客户端机密，即客户端应用程序。 | 字符串 |
| description | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 (必需) |
| metadataEndpoint | 元数据终结点 URI。 | 字符串 (必需) |
| useInApiDocumentation | 如果为 true，将在开发人员门户的 API 文档中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可以在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |