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

Authorization Provider - Get

获取由其标识符指定的授权提供程序的详细信息。

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

URI 参数

名称 必需 类型 说明
authorizationProviderId
path True

string

授权提供程序的标识符。

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

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

AuthorizationProviderContract

响应正文包含指定的授权提供程序实体。 不包含机密

标头

ETag: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetAuthorizationProvider

示例请求

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

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode",
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "name": "aadwithauthcode",
  "properties": {
    "displayName": "aadwithauthcode",
    "identityProvider": "aad",
    "oauth2": {
      "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
      "grantTypes": {
        "authorizationCode": {
          "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d",
          "scopes": "User.Read.All Group.Read.All",
          "loginUri": "https://login.windows.net",
          "resourceUri": "https://graph.microsoft.com",
          "tenantId": "common"
        }
      }
    }
  }
}

定义

名称 说明
AuthorizationProviderContract

授权提供程序协定。

AuthorizationProviderOAuth2GrantTypes

授权提供程序 oauth2 授予类型设置

AuthorizationProviderOAuth2Settings

OAuth2 设置详细信息

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

AuthorizationProviderContract

授权提供程序协定。

名称 类型 说明
id

string

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

name

string

资源的名称

properties.displayName

string

授权提供程序名称。 长度必须为 1 到 300 个字符。

properties.identityProvider

string

标识提供者名称。 长度必须为 1 到 300 个字符。

properties.oauth2

AuthorizationProviderOAuth2Settings

OAuth2 设置

type

string

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

AuthorizationProviderOAuth2GrantTypes

授权提供程序 oauth2 授予类型设置

名称 类型 说明
authorizationCode

object

OAuth2 授权代码授予参数

clientCredentials

object

OAuth2 客户端凭据授予参数

AuthorizationProviderOAuth2Settings

OAuth2 设置详细信息

名称 类型 说明
grantTypes

AuthorizationProviderOAuth2GrantTypes

OAuth2 设置

redirectUrl

string

要在 OAuth 应用程序中设置的重定向 URL。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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