你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/openidConnectProviders 2022-08-01
- 最新
- 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 资源定义
可以使用目标操作部署 service/openidConnectProviders 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
属性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务 |
| 性能 | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | string （必需） |
| clientSecret | 作为客户端应用程序的开发人员控制台的客户端机密。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
| 描述 | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 约束： 最大长度 = 50 （必需） |
| metadataEndpoint | 元数据终结点 URI。 | string （必需） |
| useInApiDocumentation | 如果为 true，开放 ID Connect 提供程序将在开发人员门户中的 API 文档中使用。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |
ARM 模板资源定义
可以使用目标操作部署 service/openidConnectProviders 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
属性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2022-08-01' |
| 名字 | 资源名称 | 字符串 约束： 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| 性能 | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/openidConnectProviders” |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | string （必需） |
| clientSecret | 作为客户端应用程序的开发人员控制台的客户端机密。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
| 描述 | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 约束： 最大长度 = 50 （必需） |
| metadataEndpoint | 元数据终结点 URI。 | string （必需） |
| useInApiDocumentation | 如果为 true，开放 ID Connect 提供程序将在开发人员门户中的 API 文档中使用。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 service/openidConnectProviders 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/openidConnectProviders 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01"
name = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
属性值
Microsoft.ApiManagement/service/openidConnectProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务 |
| 性能 | OpenId Connect 提供程序协定属性。 | OpenidConnectProviderContractProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01” |
OpenidConnectProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 开发人员控制台（即客户端应用程序）的客户端 ID。 | string （必需） |
| clientSecret | 作为客户端应用程序的开发人员控制台的客户端机密。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
| 描述 | OpenID Connect 提供程序的用户友好说明。 | 字符串 |
| displayName | 用户友好的 OpenID Connect 提供程序名称。 | 字符串 约束： 最大长度 = 50 （必需） |
| metadataEndpoint | 元数据终结点 URI。 | string （必需） |
| useInApiDocumentation | 如果为 true，开放 ID Connect 提供程序将在开发人员门户中的 API 文档中使用。 如果未提供任何值，则默认为 False。 | bool |
| useInTestConsole | 如果为 true，可在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值，则默认为 True。 | bool |