1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. GatewayApi

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.apimanagement.GatewayApi

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a API Management Gateway API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.apimanagement.getService({
        name: "example-api",
        resourceGroupName: "example-resources",
    });
    const exampleGetApi = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getApi({
        name: "search-api",
        apiManagementName: example.name,
        resourceGroupName: example1.resourceGroupName,
        revision: "2",
    }));
    const exampleGetGateway = example.then(example => azure.apimanagement.getGateway({
        name: "example-gateway",
        apiManagementId: example.id,
    }));
    const exampleGatewayApi = new azure.apimanagement.GatewayApi("example", {
        gatewayId: exampleGetGateway.then(exampleGetGateway => exampleGetGateway.id),
        apiId: exampleGetApi.then(exampleGetApi => exampleGetApi.id),
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.apimanagement.get_service(name="example-api",
        resource_group_name="example-resources")
    example_get_api = azure.apimanagement.get_api(name="search-api",
        api_management_name=example.name,
        resource_group_name=example.resource_group_name,
        revision="2")
    example_get_gateway = azure.apimanagement.get_gateway(name="example-gateway",
        api_management_id=example.id)
    example_gateway_api = azure.apimanagement.GatewayApi("example",
        gateway_id=example_get_gateway.id,
        api_id=example_get_api.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := apimanagement.LookupService(ctx, &apimanagement.LookupServiceArgs{
    			Name:              "example-api",
    			ResourceGroupName: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleGetApi, err := apimanagement.LookupApi(ctx, &apimanagement.LookupApiArgs{
    			Name:              "search-api",
    			ApiManagementName: example.Name,
    			ResourceGroupName: example.ResourceGroupName,
    			Revision:          "2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleGetGateway, err := apimanagement.LookupGateway(ctx, &apimanagement.LookupGatewayArgs{
    			Name:            "example-gateway",
    			ApiManagementId: example.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewGatewayApi(ctx, "example", &apimanagement.GatewayApiArgs{
    			GatewayId: pulumi.String(exampleGetGateway.Id),
    			ApiId:     pulumi.String(exampleGetApi.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.ApiManagement.GetService.Invoke(new()
        {
            Name = "example-api",
            ResourceGroupName = "example-resources",
        });
    
        var exampleGetApi = Azure.ApiManagement.GetApi.Invoke(new()
        {
            Name = "search-api",
            ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
            ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
            Revision = "2",
        });
    
        var exampleGetGateway = Azure.ApiManagement.GetGateway.Invoke(new()
        {
            Name = "example-gateway",
            ApiManagementId = example.Apply(getServiceResult => getServiceResult.Id),
        });
    
        var exampleGatewayApi = new Azure.ApiManagement.GatewayApi("example", new()
        {
            GatewayId = exampleGetGateway.Apply(getGatewayResult => getGatewayResult.Id),
            ApiId = exampleGetApi.Apply(getApiResult => getApiResult.Id),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.apimanagement.ApimanagementFunctions;
    import com.pulumi.azure.apimanagement.inputs.GetServiceArgs;
    import com.pulumi.azure.apimanagement.inputs.GetApiArgs;
    import com.pulumi.azure.apimanagement.inputs.GetGatewayArgs;
    import com.pulumi.azure.apimanagement.GatewayApi;
    import com.pulumi.azure.apimanagement.GatewayApiArgs;
    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) {
            final var example = ApimanagementFunctions.getService(GetServiceArgs.builder()
                .name("example-api")
                .resourceGroupName("example-resources")
                .build());
    
            final var exampleGetApi = ApimanagementFunctions.getApi(GetApiArgs.builder()
                .name("search-api")
                .apiManagementName(example.applyValue(getServiceResult -> getServiceResult.name()))
                .resourceGroupName(example.applyValue(getServiceResult -> getServiceResult.resourceGroupName()))
                .revision("2")
                .build());
    
            final var exampleGetGateway = ApimanagementFunctions.getGateway(GetGatewayArgs.builder()
                .name("example-gateway")
                .apiManagementId(example.applyValue(getServiceResult -> getServiceResult.id()))
                .build());
    
            var exampleGatewayApi = new GatewayApi("exampleGatewayApi", GatewayApiArgs.builder()
                .gatewayId(exampleGetGateway.applyValue(getGatewayResult -> getGatewayResult.id()))
                .apiId(exampleGetApi.applyValue(getApiResult -> getApiResult.id()))
                .build());
    
        }
    }
    
    resources:
      exampleGatewayApi:
        type: azure:apimanagement:GatewayApi
        name: example
        properties:
          gatewayId: ${exampleGetGateway.id}
          apiId: ${exampleGetApi.id}
    variables:
      example:
        fn::invoke:
          Function: azure:apimanagement:getService
          Arguments:
            name: example-api
            resourceGroupName: example-resources
      exampleGetApi:
        fn::invoke:
          Function: azure:apimanagement:getApi
          Arguments:
            name: search-api
            apiManagementName: ${example.name}
            resourceGroupName: ${example.resourceGroupName}
            revision: '2'
      exampleGetGateway:
        fn::invoke:
          Function: azure:apimanagement:getGateway
          Arguments:
            name: example-gateway
            apiManagementId: ${example.id}
    

    Create GatewayApi Resource

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

    Constructor syntax

    new GatewayApi(name: string, args: GatewayApiArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayApi(resource_name: str,
                   args: GatewayApiArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayApi(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_id: Optional[str] = None,
                   gateway_id: Optional[str] = None)
    func NewGatewayApi(ctx *Context, name string, args GatewayApiArgs, opts ...ResourceOption) (*GatewayApi, error)
    public GatewayApi(string name, GatewayApiArgs args, CustomResourceOptions? opts = null)
    public GatewayApi(String name, GatewayApiArgs args)
    public GatewayApi(String name, GatewayApiArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:GatewayApi
    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 GatewayApiArgs
    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 GatewayApiArgs
    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 GatewayApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayApiArgs
    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 gatewayApiResource = new Azure.ApiManagement.GatewayApi("gatewayApiResource", new()
    {
        ApiId = "string",
        GatewayId = "string",
    });
    
    example, err := apimanagement.NewGatewayApi(ctx, "gatewayApiResource", &apimanagement.GatewayApiArgs{
    	ApiId:     pulumi.String("string"),
    	GatewayId: pulumi.String("string"),
    })
    
    var gatewayApiResource = new GatewayApi("gatewayApiResource", GatewayApiArgs.builder()
        .apiId("string")
        .gatewayId("string")
        .build());
    
    gateway_api_resource = azure.apimanagement.GatewayApi("gatewayApiResource",
        api_id="string",
        gateway_id="string")
    
    const gatewayApiResource = new azure.apimanagement.GatewayApi("gatewayApiResource", {
        apiId: "string",
        gatewayId: "string",
    });
    
    type: azure:apimanagement:GatewayApi
    properties:
        apiId: string
        gatewayId: string
    

    GatewayApi 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 GatewayApi resource accepts the following input properties:

    ApiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    GatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    ApiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    GatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId String
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId String
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    api_id str
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gateway_id str
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId String
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId String
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GatewayApi Resource

    Get an existing GatewayApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GatewayApiState, opts?: CustomResourceOptions): GatewayApi
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_id: Optional[str] = None,
            gateway_id: Optional[str] = None) -> GatewayApi
    func GetGatewayApi(ctx *Context, name string, id IDInput, state *GatewayApiState, opts ...ResourceOption) (*GatewayApi, error)
    public static GatewayApi Get(string name, Input<string> id, GatewayApiState? state, CustomResourceOptions? opts = null)
    public static GatewayApi get(String name, Output<String> id, GatewayApiState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    GatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    ApiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    GatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId String
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId String
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId string
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId string
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    api_id str
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gateway_id str
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
    apiId String
    The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
    gatewayId String
    The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.

    Import

    API Management Gateway APIs can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/gatewayApi:GatewayApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1/apis/api1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi