1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. GraphQLApiResolver
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.GraphQLApiResolver

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    GraphQL API Resolver details. Azure REST API version: 2022-08-01.

    Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview.

    Example Usage

    ApiManagementCreateGraphQLApiResolver

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var graphQLApiResolver = new AzureNative.ApiManagement.GraphQLApiResolver("graphQLApiResolver", new()
        {
            ApiId = "someAPI",
            Description = "A GraphQL Resolver example",
            DisplayName = "Query Users",
            Path = "Query/users",
            ResolverId = "newResolver",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apimanagement.NewGraphQLApiResolver(ctx, "graphQLApiResolver", &apimanagement.GraphQLApiResolverArgs{
    			ApiId:             pulumi.String("someAPI"),
    			Description:       pulumi.String("A GraphQL Resolver example"),
    			DisplayName:       pulumi.String("Query Users"),
    			Path:              pulumi.String("Query/users"),
    			ResolverId:        pulumi.String("newResolver"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apimanagement.GraphQLApiResolver;
    import com.pulumi.azurenative.apimanagement.GraphQLApiResolverArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var graphQLApiResolver = new GraphQLApiResolver("graphQLApiResolver", GraphQLApiResolverArgs.builder()        
                .apiId("someAPI")
                .description("A GraphQL Resolver example")
                .displayName("Query Users")
                .path("Query/users")
                .resolverId("newResolver")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    graph_ql_api_resolver = azure_native.apimanagement.GraphQLApiResolver("graphQLApiResolver",
        api_id="someAPI",
        description="A GraphQL Resolver example",
        display_name="Query Users",
        path="Query/users",
        resolver_id="newResolver",
        resource_group_name="rg1",
        service_name="apimService1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const graphQLApiResolver = new azure_native.apimanagement.GraphQLApiResolver("graphQLApiResolver", {
        apiId: "someAPI",
        description: "A GraphQL Resolver example",
        displayName: "Query Users",
        path: "Query/users",
        resolverId: "newResolver",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
    });
    
    resources:
      graphQLApiResolver:
        type: azure-native:apimanagement:GraphQLApiResolver
        properties:
          apiId: someAPI
          description: A GraphQL Resolver example
          displayName: Query Users
          path: Query/users
          resolverId: newResolver
          resourceGroupName: rg1
          serviceName: apimService1
    

    Create GraphQLApiResolver Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GraphQLApiResolver(name: string, args: GraphQLApiResolverArgs, opts?: CustomResourceOptions);
    @overload
    def GraphQLApiResolver(resource_name: str,
                           args: GraphQLApiResolverArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def GraphQLApiResolver(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           api_id: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           service_name: Optional[str] = None,
                           description: Optional[str] = None,
                           display_name: Optional[str] = None,
                           path: Optional[str] = None,
                           resolver_id: Optional[str] = None)
    func NewGraphQLApiResolver(ctx *Context, name string, args GraphQLApiResolverArgs, opts ...ResourceOption) (*GraphQLApiResolver, error)
    public GraphQLApiResolver(string name, GraphQLApiResolverArgs args, CustomResourceOptions? opts = null)
    public GraphQLApiResolver(String name, GraphQLApiResolverArgs args)
    public GraphQLApiResolver(String name, GraphQLApiResolverArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:GraphQLApiResolver
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GraphQLApiResolverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GraphQLApiResolverArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GraphQLApiResolverArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GraphQLApiResolverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GraphQLApiResolverArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var graphQLApiResolverResource = new AzureNative.ApiManagement.GraphQLApiResolver("graphQLApiResolverResource", new()
    {
        ApiId = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Description = "string",
        DisplayName = "string",
        Path = "string",
        ResolverId = "string",
    });
    
    example, err := apimanagement.NewGraphQLApiResolver(ctx, "graphQLApiResolverResource", &apimanagement.GraphQLApiResolverArgs{
    ApiId: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    Path: pulumi.String("string"),
    ResolverId: pulumi.String("string"),
    })
    
    var graphQLApiResolverResource = new GraphQLApiResolver("graphQLApiResolverResource", GraphQLApiResolverArgs.builder()        
        .apiId("string")
        .resourceGroupName("string")
        .serviceName("string")
        .description("string")
        .displayName("string")
        .path("string")
        .resolverId("string")
        .build());
    
    graph_ql_api_resolver_resource = azure_native.apimanagement.GraphQLApiResolver("graphQLApiResolverResource",
        api_id="string",
        resource_group_name="string",
        service_name="string",
        description="string",
        display_name="string",
        path="string",
        resolver_id="string")
    
    const graphQLApiResolverResource = new azure_native.apimanagement.GraphQLApiResolver("graphQLApiResolverResource", {
        apiId: "string",
        resourceGroupName: "string",
        serviceName: "string",
        description: "string",
        displayName: "string",
        path: "string",
        resolverId: "string",
    });
    
    type: azure-native:apimanagement:GraphQLApiResolver
    properties:
        apiId: string
        description: string
        displayName: string
        path: string
        resolverId: string
        resourceGroupName: string
        serviceName: string
    

    GraphQLApiResolver Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GraphQLApiResolver resource accepts the following input properties:

    ApiId 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.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Description string
    Description of the resolver. May include HTML formatting tags.
    DisplayName string
    Resolver Name.
    Path string
    Path is type/field being resolved.
    ResolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    ApiId 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.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Description string
    Description of the resolver. May include HTML formatting tags.
    DisplayName string
    Resolver Name.
    Path string
    Path is type/field being resolved.
    ResolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    apiId 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.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    description String
    Description of the resolver. May include HTML formatting tags.
    displayName String
    Resolver Name.
    path String
    Path is type/field being resolved.
    resolverId String
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    apiId 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.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    description string
    Description of the resolver. May include HTML formatting tags.
    displayName string
    Resolver Name.
    path string
    Path is type/field being resolved.
    resolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    api_id str
    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.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    description str
    Description of the resolver. May include HTML formatting tags.
    display_name str
    Resolver Name.
    path str
    Path is type/field being resolved.
    resolver_id str
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    apiId 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.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    description String
    Description of the resolver. May include HTML formatting tags.
    displayName String
    Resolver Name.
    path String
    Path is type/field being resolved.
    resolverId String
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GraphQLApiResolver resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:GraphQLApiResolver newResolver /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi