Share via

Graph QL Api Resolver - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Creates a new resolver in the GraphQL API or updates an existing one.

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

URI Parameters

Name In Required Type Description
apiId
 path True

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Regex pattern: ^[^*#&+:<>?]+$
resolverId
 path True

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

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

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Header

Name Required Type Description
If-Match

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Type Description
properties.description

string

Description of the resolver. May include HTML formatting tags.
properties.displayName

string

Resolver Name.
properties.path

string

Path is type/field being resolved.

Responses

Name Type Description
200 OK

ResolverContract

Resolver was successfully updated.

Headers

ETag: string
201 Created

ResolverContract

Resolver was successfully created.

Headers

ETag: string
Other Status Codes

ErrorResponse

Error response describing why the resolver failed.

Security

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 impersonate your user account

Examples

ApiManagementCreateGraphQLApiResolver

Sample request

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"
  }
}

Sample response

Status code:
200 
{
  "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"
  }
}
Status code:
201 
{
  "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"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ResolverContract

GraphQL API Resolver details.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ResolverContract

GraphQL API Resolver details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.description

string

Description of the resolver. May include HTML formatting tags.
properties.displayName

string

Resolver Name.
properties.path

string

Path is type/field being resolved.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"