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

Graph QL Api Resolver - Get

获取由其标识符指定的 GraphQL API 解析程序的详细信息。

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

URI 参数

名称 必需 类型 说明
apiId
path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀,其中 n 是修订号。

resolverId
path True

string

minLength: 1
maxLength: 80

GraphQL API 中的解析程序标识符。 当前 API 管理服务实例中必须是唯一的。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服务的名称。

subscriptionId
path True

string

minLength: 1

目标订阅的 ID。

api-version
query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

ResolverContract

响应正文包含指定的解析程序实体。

标头

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 模拟用户帐户

示例

ApiManagementGetGraphQLApiResolver

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc?api-version=2022-08-01

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc",
  "type": "Microsoft.ApiManagement/service/apis/resolvers",
  "name": "57d2ef278aa04f0ad01d6cdc",
  "properties": {
    "displayName": "Query Users",
    "path": "Query/users",
    "description": "A GraphQL Resolver example"
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

ResolverContract

GraphQL API 解析程序详细信息。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级别错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

错误的人工可读表示形式。

ResolverContract

GraphQL API 解析程序详细信息。

名称 类型 说明
id

string

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

name

string

资源的名称

properties.description

string

maxLength: 1000

解析程序的说明。 可能包括 HTML 格式标记。

properties.displayName

string

minLength: 1
maxLength: 300

解析程序名称。

properties.path

string

minLength: 1
maxLength: 300

路径是正在解析的类型/字段。

type

string

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