你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

OpenId Connect Provider - Get

获取不带机密的特定 OpenID Connect 提供程序。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}?api-version=2022-08-01

URI 参数

名称 必需 类型 说明
opid
path True

string

OpenID Connect 提供程序的标识符。

正则表达式模式: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

OpenidConnectProviderContract

响应正文包含没有机密的指定 OpenId Connect 提供程序实体。

标头

ETag: string

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetOpenIdConnectProvider

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2?api-version=2022-08-01

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect2",
  "properties": {
    "displayName": "templateoidprovider2",
    "description": "open id provider template2",
    "metadataEndpoint": "https://oidprovider-template2.net",
    "clientId": "oidprovidertemplate2",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

OpenidConnectProviderContract

OpenId Connect 提供程序详细信息。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

OpenidConnectProviderContract

OpenId Connect 提供程序详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.clientId

string

开发人员控制台(客户端应用程序)的客户端 ID。

properties.clientSecret

string

开发人员控制台(即客户端应用程序)的客户端密码。

properties.description

string

OpenID Connect 提供程序的用户友好说明。

properties.displayName

string

用户友好的 OpenID Connect 提供程序名称。

properties.metadataEndpoint

string

元数据终结点 URI。

properties.useInApiDocumentation

boolean

如果为 true,则将在开发人员门户的 API 文档中使用 Open ID Connect 提供程序。 如果未提供任何值,则默认为 False。

properties.useInTestConsole

boolean

如果为 true,可以在开发人员门户测试控制台中使用 Open ID Connect 提供程序。 如果未提供任何值,则默认为 True。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”