Graph QL Api Resolver - Create Or Update
在 GraphQL API 中创建新的解析程序或更新现有解析程序。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}?api-version=2024-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api
|
path | True |
string minLength: 1maxLength: 256 pattern: ^[^*#&+:<>?]+$ |
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀,其中 n 是修订号。 |
resolver
|
path | True |
string minLength: 1maxLength: 80 |
GraphQL API 中的解析程序标识符。 当前 API 管理服务实例中必须是唯一的。 |
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
API 管理服务的名称。 |
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
If-Match |
string |
实体的 ETag。 创建实体时不需要,但在更新实体时是必需的。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties.description |
string maxLength: 1000 |
解析程序的说明。 可能包括 HTML 格式标记。 |
properties.displayName |
string minLength: 1maxLength: 300 |
解析程序名称。 |
properties.path |
string minLength: 1maxLength: 300 |
路径是正在解析的类型/字段。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
解析程序已成功更新。 标头 ETag: string |
|
201 Created |
已成功创建解析程序。 标头 ETag: string |
|
Other Status Codes |
描述解析程序失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ApiManagementCreateGraphQLApiResolver
示例请求
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver?api-version=2024-05-01
{
"properties": {
"displayName": "Query Users",
"path": "Query/users",
"description": "A GraphQL Resolver example"
}
}
示例响应
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver",
"type": "Microsoft.ApiManagement/service/apis/resolvers",
"name": "newResolver",
"properties": {
"displayName": "Query Users",
"path": "Query/users",
"description": "A GraphQL Resolver example"
}
}
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver",
"type": "Microsoft.ApiManagement/service/apis/resolvers",
"name": "newResolver",
"properties": {
"displayName": "Query Users",
"path": "Query/users",
"description": "A GraphQL Resolver example"
}
}
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Resolver |
GraphQL API 解析程序详细信息。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
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: 1maxLength: 300 |
解析程序名称。 |
properties.path |
string minLength: 1maxLength: 300 |
路径是正在解析的类型/字段。 |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |