1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. GraphQLApiResolverPolicy
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.69.0 published on Monday, Oct 28, 2024 by Pulumi

azure-native.apimanagement.GraphQLApiResolverPolicy

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.69.0 published on Monday, Oct 28, 2024 by Pulumi

    Policy Contract details. Azure REST API version: 2022-08-01.

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

    Example Usage

    ApiManagementCreateGraphQLApiResolverPolicy

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var graphQLApiResolverPolicy = new AzureNative.ApiManagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicy", new()
        {
            ApiId = "5600b57e7e8880006a040001",
            Format = AzureNative.ApiManagement.PolicyContentFormat.Xml,
            PolicyId = "policy",
            ResolverId = "5600b57e7e8880006a080001",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Value = "<http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url=\"https://some.service.com\" /><set-url>/api/users</set-url></http-request></http-data-source>",
        });
    
    });
    
    package main
    
    import (
    	apimanagement "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.NewGraphQLApiResolverPolicy(ctx, "graphQLApiResolverPolicy", &apimanagement.GraphQLApiResolverPolicyArgs{
    			ApiId:             pulumi.String("5600b57e7e8880006a040001"),
    			Format:            pulumi.String(apimanagement.PolicyContentFormatXml),
    			PolicyId:          pulumi.String("policy"),
    			ResolverId:        pulumi.String("5600b57e7e8880006a080001"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    			Value:             pulumi.String("<http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url=\"https://some.service.com\" /><set-url>/api/users</set-url></http-request></http-data-source>"),
    		})
    		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.GraphQLApiResolverPolicy;
    import com.pulumi.azurenative.apimanagement.GraphQLApiResolverPolicyArgs;
    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 graphQLApiResolverPolicy = new GraphQLApiResolverPolicy("graphQLApiResolverPolicy", GraphQLApiResolverPolicyArgs.builder()
                .apiId("5600b57e7e8880006a040001")
                .format("xml")
                .policyId("policy")
                .resolverId("5600b57e7e8880006a080001")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .value("<http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url=\"https://some.service.com\" /><set-url>/api/users</set-url></http-request></http-data-source>")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    graph_ql_api_resolver_policy = azure_native.apimanagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicy",
        api_id="5600b57e7e8880006a040001",
        format=azure_native.apimanagement.PolicyContentFormat.XML,
        policy_id="policy",
        resolver_id="5600b57e7e8880006a080001",
        resource_group_name="rg1",
        service_name="apimService1",
        value="<http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url=\"https://some.service.com\" /><set-url>/api/users</set-url></http-request></http-data-source>")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const graphQLApiResolverPolicy = new azure_native.apimanagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicy", {
        apiId: "5600b57e7e8880006a040001",
        format: azure_native.apimanagement.PolicyContentFormat.Xml,
        policyId: "policy",
        resolverId: "5600b57e7e8880006a080001",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
        value: "<http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url=\"https://some.service.com\" /><set-url>/api/users</set-url></http-request></http-data-source>",
    });
    
    resources:
      graphQLApiResolverPolicy:
        type: azure-native:apimanagement:GraphQLApiResolverPolicy
        properties:
          apiId: 5600b57e7e8880006a040001
          format: xml
          policyId: policy
          resolverId: 5600b57e7e8880006a080001
          resourceGroupName: rg1
          serviceName: apimService1
          value: <http-data-source><http-request><set-method>GET</set-method><set-backend-service base-url="https://some.service.com" /><set-url>/api/users</set-url></http-request></http-data-source>
    

    Create GraphQLApiResolverPolicy Resource

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

    Constructor syntax

    new GraphQLApiResolverPolicy(name: string, args: GraphQLApiResolverPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def GraphQLApiResolverPolicy(resource_name: str,
                                 args: GraphQLApiResolverPolicyArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def GraphQLApiResolverPolicy(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 api_id: Optional[str] = None,
                                 resolver_id: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 value: Optional[str] = None,
                                 format: Optional[Union[str, PolicyContentFormat]] = None,
                                 policy_id: Optional[str] = None)
    func NewGraphQLApiResolverPolicy(ctx *Context, name string, args GraphQLApiResolverPolicyArgs, opts ...ResourceOption) (*GraphQLApiResolverPolicy, error)
    public GraphQLApiResolverPolicy(string name, GraphQLApiResolverPolicyArgs args, CustomResourceOptions? opts = null)
    public GraphQLApiResolverPolicy(String name, GraphQLApiResolverPolicyArgs args)
    public GraphQLApiResolverPolicy(String name, GraphQLApiResolverPolicyArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:GraphQLApiResolverPolicy
    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 GraphQLApiResolverPolicyArgs
    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 GraphQLApiResolverPolicyArgs
    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 GraphQLApiResolverPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GraphQLApiResolverPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GraphQLApiResolverPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var graphQLApiResolverPolicyResource = new AzureNative.ApiManagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicyResource", new()
    {
        ApiId = "string",
        ResolverId = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Value = "string",
        Format = "string",
        PolicyId = "string",
    });
    
    example, err := apimanagement.NewGraphQLApiResolverPolicy(ctx, "graphQLApiResolverPolicyResource", &apimanagement.GraphQLApiResolverPolicyArgs{
    	ApiId:             pulumi.String("string"),
    	ResolverId:        pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	ServiceName:       pulumi.String("string"),
    	Value:             pulumi.String("string"),
    	Format:            pulumi.String("string"),
    	PolicyId:          pulumi.String("string"),
    })
    
    var graphQLApiResolverPolicyResource = new GraphQLApiResolverPolicy("graphQLApiResolverPolicyResource", GraphQLApiResolverPolicyArgs.builder()
        .apiId("string")
        .resolverId("string")
        .resourceGroupName("string")
        .serviceName("string")
        .value("string")
        .format("string")
        .policyId("string")
        .build());
    
    graph_ql_api_resolver_policy_resource = azure_native.apimanagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicyResource",
        api_id="string",
        resolver_id="string",
        resource_group_name="string",
        service_name="string",
        value="string",
        format="string",
        policy_id="string")
    
    const graphQLApiResolverPolicyResource = new azure_native.apimanagement.GraphQLApiResolverPolicy("graphQLApiResolverPolicyResource", {
        apiId: "string",
        resolverId: "string",
        resourceGroupName: "string",
        serviceName: "string",
        value: "string",
        format: "string",
        policyId: "string",
    });
    
    type: azure-native:apimanagement:GraphQLApiResolverPolicy
    properties:
        apiId: string
        format: string
        policyId: string
        resolverId: string
        resourceGroupName: string
        serviceName: string
        value: string
    

    GraphQLApiResolverPolicy Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GraphQLApiResolverPolicy 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.
    ResolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Value string
    Contents of the Policy as defined by the format.
    Format string | Pulumi.AzureNative.ApiManagement.PolicyContentFormat
    Format of the policyContent.
    PolicyId string
    The identifier of the Policy.
    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.
    ResolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Value string
    Contents of the Policy as defined by the format.
    Format string | PolicyContentFormat
    Format of the policyContent.
    PolicyId string
    The identifier of the Policy.
    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.
    resolverId String
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    value String
    Contents of the Policy as defined by the format.
    format String | PolicyContentFormat
    Format of the policyContent.
    policyId String
    The identifier of the Policy.
    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.
    resolverId string
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    value string
    Contents of the Policy as defined by the format.
    format string | PolicyContentFormat
    Format of the policyContent.
    policyId string
    The identifier of the Policy.
    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.
    resolver_id str
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    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.
    value str
    Contents of the Policy as defined by the format.
    format str | PolicyContentFormat
    Format of the policyContent.
    policy_id str
    The identifier of the Policy.
    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.
    resolverId String
    Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    value String
    Contents of the Policy as defined by the format.
    format String | "xml" | "xml-link" | "rawxml" | "rawxml-link"
    Format of the policyContent.
    policyId String
    The identifier of the Policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GraphQLApiResolverPolicy 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"

    Supporting Types

    PolicyContentFormat, PolicyContentFormatArgs

    Xml
    xmlThe contents are inline and Content type is an XML document.
    Xml_link
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    Rawxml_link
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
    PolicyContentFormatXml
    xmlThe contents are inline and Content type is an XML document.
    PolicyContentFormat_Xml_Link
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    PolicyContentFormatRawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    PolicyContentFormat_Rawxml_Link
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
    Xml
    xmlThe contents are inline and Content type is an XML document.
    Xmllink
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    Rawxmllink
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
    Xml
    xmlThe contents are inline and Content type is an XML document.
    Xml_link
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    Rawxml_link
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
    XML
    xmlThe contents are inline and Content type is an XML document.
    XML_LINK
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    RAWXML
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    RAWXML_LINK
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
    "xml"
    xmlThe contents are inline and Content type is an XML document.
    "xml-link"
    xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
    "rawxml"
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    "rawxml-link"
    rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.

    Import

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

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

    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.69.0 published on Monday, Oct 28, 2024 by Pulumi