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

Authorization Server - List By Service

列出服务实例中定义的授权服务器集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers?api-version=2021-12-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-12-01-preview

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

$filter
query
  • string

|字段|使用情况|支持的运算符|支持的函数|
|-------------|-------------|-------------|-------------|
|name |filter |ge, le, eq, ne, gt, lt |substringof、contains、startswith、endswith |
|displayName |filter |ge, le, eq, ne, gt, lt |substringof、contains、startswith、endswith |

$skip
query
  • integer
int32

要跳过的记录数。

$top
query
  • integer
int32

要返回的记录数。

响应

Name Type Description
200 OK

指定API 管理服务实例的授权服务器实体的集合。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementListAuthorizationServers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers?api-version=2021-12-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
      "type": "Microsoft.ApiManagement/service/authorizationServers",
      "name": "newauthServer",
      "properties": {
        "displayName": "test2",
        "description": "test server",
        "clientRegistrationEndpoint": "https://www.contoso.com/apps",
        "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
        "authorizationMethods": [
          "GET"
        ],
        "tokenEndpoint": "https://www.contoso.com/oauth2/token",
        "supportState": true,
        "defaultScope": "read write",
        "grantTypes": [
          "authorizationCode",
          "implicit"
        ],
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ],
        "clientId": "1",
        "resourceOwnerUsername": "un",
        "resourceOwnerPassword": "pwd"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2",
      "type": "Microsoft.ApiManagement/service/authorizationServers",
      "name": "newauthServer2",
      "properties": {
        "displayName": "test3",
        "description": "test server",
        "clientRegistrationEndpoint": "https://www.contoso.com/apps",
        "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
        "authorizationMethods": [
          "GET"
        ],
        "clientAuthenticationMethod": [
          "Basic"
        ],
        "tokenEndpoint": "https://www.contoso.com/oauth2/token",
        "supportState": true,
        "defaultScope": "read write",
        "grantTypes": [
          "authorizationCode",
          "implicit"
        ],
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ],
        "clientId": "1",
        "resourceOwnerUsername": "un",
        "resourceOwnerPassword": "pwd"
      }
    }
  ],
  "nextLink": ""
}

定义

AuthorizationServerCollection

分页 OAuth2 授权服务器列表表示形式。

AuthorizationServerContract

外部 OAuth 授权服务器设置。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

TokenBodyParameterContract

OAuth 获取令牌请求正文参数 (www-url-form-encoded) 。

AuthorizationServerCollection

分页 OAuth2 授权服务器列表表示形式。

Name Type Description
count
  • integer

所有页面的总记录计数数。

nextLink
  • string

下一页链接(如果有)。

value

页面值。

AuthorizationServerContract

外部 OAuth 授权服务器设置。

Name Type Description
id
  • string

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

name
  • string

资源的名称

properties.authorizationEndpoint
  • string

OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2

properties.authorizationMethods
  • string[]

授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。

properties.bearerTokenSendingMethods
  • string[]

指定用于向 API 传递访问令牌的机制。

properties.clientAuthenticationMethod
  • string[]

此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定正文时,客户端凭据和其他参数在应用程序/x-www-form-urlencoded 格式的请求正文中传递。

properties.clientId
  • string

已注册到此授权服务器的客户端或应用程序 ID。

properties.clientRegistrationEndpoint
  • string

对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。 包含所引用实体的绝对 URL。

properties.clientSecret
  • string

已注册到此授权服务器的客户端或应用程序机密。 此属性不会在“GET”操作上填充! 使用“/listSecrets”POST 请求获取该值。

properties.defaultScope
  • string

将按默认请求的访问令牌作用域。 可以在 API 级别重写。 应以包含空格分隔值的字符串形式提供。

properties.description
  • string

授权服务器的说明。 可以包含采用 HTML 格式的标记。

properties.displayName
  • string

用户友好的授权服务器名称。

properties.grantTypes
  • string[]

客户端用来请求访问令牌的授权形式。

properties.resourceOwnerPassword
  • string

当此授权服务器支持资源所有者密码授权类型时,可以根据需要指定。 默认的资源所有者密码。

properties.resourceOwnerUsername
  • string

当此授权服务器支持资源所有者密码授权类型时,可以根据需要指定。 默认的资源所有者用户名。

properties.supportState
  • boolean

如果为 true,则授权服务器将包含从授权请求到其响应的状态参数。 客户端可以使用状态参数来引发协议安全性。

properties.tokenBodyParameters

此授权服务器的令牌终结点所需的附加参数,这些参数表示为 JSON 对象数组,其中包含名称和值字符串属性,即 {“name”: “name value”, “value”: “a value”}。

properties.tokenEndpoint
  • string

OAuth 令牌终结点。 包含所引用实体的绝对 URI。

type
  • string

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

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

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

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

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

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

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

TokenBodyParameterContract

OAuth 获取令牌请求正文参数 (www-url-form-encoded) 。

Name Type Description
name
  • string

body 参数名称。

value
  • string

body 参数值。