Gateway

Manages an API Management Gateway.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("exampleService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Consumption_0",
    });

    var exampleGateway = new Azure.ApiManagement.Gateway("exampleGateway", new()
    {
        ApiManagementId = exampleService.Id,
        Description = "Example API Management gateway",
        LocationData = new Azure.ApiManagement.Inputs.GatewayLocationDataArgs
        {
            Name = "example name",
            City = "example city",
            District = "example district",
            Region = "example region",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			PublisherName:     pulumi.String("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Consumption_0"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewGateway(ctx, "exampleGateway", &apimanagement.GatewayArgs{
			ApiManagementId: exampleService.ID(),
			Description:     pulumi.String("Example API Management gateway"),
			LocationData: &apimanagement.GatewayLocationDataArgs{
				Name:     pulumi.String("example name"),
				City:     pulumi.String("example city"),
				District: pulumi.String("example district"),
				Region:   pulumi.String("example region"),
			},
		})
		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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Gateway;
import com.pulumi.azure.apimanagement.GatewayArgs;
import com.pulumi.azure.apimanagement.inputs.GatewayLocationDataArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Consumption_0")
            .build());

        var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()        
            .apiManagementId(exampleService.id())
            .description("Example API Management gateway")
            .locationData(GatewayLocationDataArgs.builder()
                .name("example name")
                .city("example city")
                .district("example district")
                .region("example region")
                .build())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Consumption_0")
example_gateway = azure.apimanagement.Gateway("exampleGateway",
    api_management_id=example_service.id,
    description="Example API Management gateway",
    location_data=azure.apimanagement.GatewayLocationDataArgs(
        name="example name",
        city="example city",
        district="example district",
        region="example region",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Consumption_0",
});
const exampleGateway = new azure.apimanagement.Gateway("exampleGateway", {
    apiManagementId: exampleService.id,
    description: "Example API Management gateway",
    locationData: {
        name: "example name",
        city: "example city",
        district: "example district",
        region: "example region",
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      publisherName: pub1
      publisherEmail: pub1@email.com
      skuName: Consumption_0
  exampleGateway:
    type: azure:apimanagement:Gateway
    properties:
      apiManagementId: ${exampleService.id}
      description: Example API Management gateway
      locationData:
        name: example name
        city: example city
        district: example district
        region: example region

Create Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_management_id: Optional[str] = None,
            description: Optional[str] = None,
            location_data: Optional[GatewayLocationDataArgs] = None,
            name: Optional[str] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: azure:apimanagement:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args GatewayArgs
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 GatewayArgs
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 GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ApiManagementId string
LocationData GatewayLocationDataArgs

A location_data block as documented below.

Description string

The description of the API Management Gateway.

Name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

ApiManagementId string
LocationData GatewayLocationDataArgs

A location_data block as documented below.

Description string

The description of the API Management Gateway.

Name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId String
locationData GatewayLocationDataArgs

A location_data block as documented below.

description String

The description of the API Management Gateway.

name String

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId string
locationData GatewayLocationDataArgs

A location_data block as documented below.

description string

The description of the API Management Gateway.

name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

api_management_id str
location_data GatewayLocationDataArgs

A location_data block as documented below.

description str

The description of the API Management Gateway.

name str

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId String
locationData Property Map

A location_data block as documented below.

description String

The description of the API Management Gateway.

name String

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

Outputs

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

Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        description: Optional[str] = None,
        location_data: Optional[GatewayLocationDataArgs] = None,
        name: Optional[str] = None) -> Gateway
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
public static Gateway get(String name, Output<String> id, GatewayState 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:
ApiManagementId string
Description string

The description of the API Management Gateway.

LocationData GatewayLocationDataArgs

A location_data block as documented below.

Name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

ApiManagementId string
Description string

The description of the API Management Gateway.

LocationData GatewayLocationDataArgs

A location_data block as documented below.

Name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId String
description String

The description of the API Management Gateway.

locationData GatewayLocationDataArgs

A location_data block as documented below.

name String

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId string
description string

The description of the API Management Gateway.

locationData GatewayLocationDataArgs

A location_data block as documented below.

name string

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

api_management_id str
description str

The description of the API Management Gateway.

location_data GatewayLocationDataArgs

A location_data block as documented below.

name str

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

apiManagementId String
description String

The description of the API Management Gateway.

locationData Property Map

A location_data block as documented below.

name String

The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

Supporting Types

GatewayLocationData

Name string

A canonical name for the geographic or physical location.

City string

The city or locality where the resource is located.

District string

The district, state, or province where the resource is located.

Region string

The country or region where the resource is located.

Name string

A canonical name for the geographic or physical location.

City string

The city or locality where the resource is located.

District string

The district, state, or province where the resource is located.

Region string

The country or region where the resource is located.

name String

A canonical name for the geographic or physical location.

city String

The city or locality where the resource is located.

district String

The district, state, or province where the resource is located.

region String

The country or region where the resource is located.

name string

A canonical name for the geographic or physical location.

city string

The city or locality where the resource is located.

district string

The district, state, or province where the resource is located.

region string

The country or region where the resource is located.

name str

A canonical name for the geographic or physical location.

city str

The city or locality where the resource is located.

district str

The district, state, or province where the resource is located.

region str

The country or region where the resource is located.

name String

A canonical name for the geographic or physical location.

city String

The city or locality where the resource is located.

district String

The district, state, or province where the resource is located.

region String

The country or region where the resource is located.

Import

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

 $ pulumi import azure:apimanagement/gateway:Gateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.