Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. Gateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.Gateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gateway details.

Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Example Usage

ApiManagementCreateGateway

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var gateway = new AzureNative.ApiManagement.Gateway("gateway", new()
    {
        Description = "my gateway 1",
        GatewayId = "gw1",
        LocationData = new AzureNative.ApiManagement.Inputs.ResourceLocationDataContractArgs
        {
            Name = "my location",
        },
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGateway(ctx, "gateway", &apimanagement.GatewayArgs{
			Description: pulumi.String("my gateway 1"),
			GatewayId:   pulumi.String("gw1"),
			LocationData: &apimanagement.ResourceLocationDataContractArgs{
				Name: pulumi.String("my location"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Gateway;
import com.pulumi.azurenative.apimanagement.GatewayArgs;
import com.pulumi.azurenative.apimanagement.inputs.ResourceLocationDataContractArgs;
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 gateway = new Gateway("gateway", GatewayArgs.builder()
            .description("my gateway 1")
            .gatewayId("gw1")
            .locationData(ResourceLocationDataContractArgs.builder()
                .name("my location")
                .build())
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gateway = new azure_native.apimanagement.Gateway("gateway", {
    description: "my gateway 1",
    gatewayId: "gw1",
    locationData: {
        name: "my location",
    },
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

gateway = azure_native.apimanagement.Gateway("gateway",
    description="my gateway 1",
    gateway_id="gw1",
    location_data={
        "name": "my location",
    },
    resource_group_name="rg1",
    service_name="apimService1")
Copy
resources:
  gateway:
    type: azure-native:apimanagement:Gateway
    properties:
      description: my gateway 1
      gatewayId: gw1
      locationData:
        name: my location
      resourceGroupName: rg1
      serviceName: apimService1
Copy

Create Gateway Resource

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

Constructor syntax

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            description: Optional[str] = None,
            gateway_id: Optional[str] = None,
            location_data: Optional[ResourceLocationDataContractArgs] = 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-native:apimanagement:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayArgs
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 gatewayResource = new AzureNative.ApiManagement.Gateway("gatewayResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    Description = "string",
    GatewayId = "string",
    LocationData = new AzureNative.ApiManagement.Inputs.ResourceLocationDataContractArgs
    {
        Name = "string",
        City = "string",
        CountryOrRegion = "string",
        District = "string",
    },
});
Copy
example, err := apimanagement.NewGateway(ctx, "gatewayResource", &apimanagement.GatewayArgs{
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Description:       pulumi.String("string"),
	GatewayId:         pulumi.String("string"),
	LocationData: &apimanagement.ResourceLocationDataContractArgs{
		Name:            pulumi.String("string"),
		City:            pulumi.String("string"),
		CountryOrRegion: pulumi.String("string"),
		District:        pulumi.String("string"),
	},
})
Copy
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .description("string")
    .gatewayId("string")
    .locationData(ResourceLocationDataContractArgs.builder()
        .name("string")
        .city("string")
        .countryOrRegion("string")
        .district("string")
        .build())
    .build());
Copy
gateway_resource = azure_native.apimanagement.Gateway("gatewayResource",
    resource_group_name="string",
    service_name="string",
    description="string",
    gateway_id="string",
    location_data={
        "name": "string",
        "city": "string",
        "country_or_region": "string",
        "district": "string",
    })
Copy
const gatewayResource = new azure_native.apimanagement.Gateway("gatewayResource", {
    resourceGroupName: "string",
    serviceName: "string",
    description: "string",
    gatewayId: "string",
    locationData: {
        name: "string",
        city: "string",
        countryOrRegion: "string",
        district: "string",
    },
});
Copy
type: azure-native:apimanagement:Gateway
properties:
    description: string
    gatewayId: string
    locationData:
        city: string
        countryOrRegion: string
        district: string
        name: string
    resourceGroupName: string
    serviceName: string
Copy

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

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

The Gateway resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Description string
Gateway description
GatewayId Changes to this property will trigger replacement. string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
LocationData Pulumi.AzureNative.ApiManagement.Inputs.ResourceLocationDataContract
Gateway location.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Description string
Gateway description
GatewayId Changes to this property will trigger replacement. string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
LocationData ResourceLocationDataContractArgs
Gateway location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
description String
Gateway description
gatewayId Changes to this property will trigger replacement. String
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
locationData ResourceLocationDataContract
Gateway location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
description string
Gateway description
gatewayId Changes to this property will trigger replacement. string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
locationData ResourceLocationDataContract
Gateway location.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
description str
Gateway description
gateway_id Changes to this property will trigger replacement. str
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
location_data ResourceLocationDataContractArgs
Gateway location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
description String
Gateway description
gatewayId Changes to this property will trigger replacement. String
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
locationData Property Map
Gateway location.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
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"
AzureApiVersion string
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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"
azureApiVersion string
The Azure API version of the resource.
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"
azure_api_version str
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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

ResourceLocationDataContract
, ResourceLocationDataContractArgs

Name This property is required. string
A canonical name for the geographic or physical location.
City string
The city or locality where the resource is located.
CountryOrRegion string
The country or region where the resource is located.
District string
The district, state, or province where the resource is located.
Name This property is required. string
A canonical name for the geographic or physical location.
City string
The city or locality where the resource is located.
CountryOrRegion string
The country or region where the resource is located.
District string
The district, state, or province where the resource is located.
name This property is required. String
A canonical name for the geographic or physical location.
city String
The city or locality where the resource is located.
countryOrRegion String
The country or region where the resource is located.
district String
The district, state, or province where the resource is located.
name This property is required. string
A canonical name for the geographic or physical location.
city string
The city or locality where the resource is located.
countryOrRegion string
The country or region where the resource is located.
district string
The district, state, or province where the resource is located.
name This property is required. str
A canonical name for the geographic or physical location.
city str
The city or locality where the resource is located.
country_or_region str
The country or region where the resource is located.
district str
The district, state, or province where the resource is located.
name This property is required. String
A canonical name for the geographic or physical location.
city String
The city or locality where the resource is located.
countryOrRegion String
The country or region where the resource is located.
district String
The district, state, or province where the resource is located.

ResourceLocationDataContractResponse
, ResourceLocationDataContractResponseArgs

Name This property is required. string
A canonical name for the geographic or physical location.
City string
The city or locality where the resource is located.
CountryOrRegion string
The country or region where the resource is located.
District string
The district, state, or province where the resource is located.
Name This property is required. string
A canonical name for the geographic or physical location.
City string
The city or locality where the resource is located.
CountryOrRegion string
The country or region where the resource is located.
District string
The district, state, or province where the resource is located.
name This property is required. String
A canonical name for the geographic or physical location.
city String
The city or locality where the resource is located.
countryOrRegion String
The country or region where the resource is located.
district String
The district, state, or province where the resource is located.
name This property is required. string
A canonical name for the geographic or physical location.
city string
The city or locality where the resource is located.
countryOrRegion string
The country or region where the resource is located.
district string
The district, state, or province where the resource is located.
name This property is required. str
A canonical name for the geographic or physical location.
city str
The city or locality where the resource is located.
country_or_region str
The country or region where the resource is located.
district str
The district, state, or province where the resource is located.
name This property is required. String
A canonical name for the geographic or physical location.
city String
The city or locality where the resource is located.
countryOrRegion String
The country or region where the resource is located.
district String
The district, state, or province where the resource is located.

Import

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

$ pulumi import azure-native:apimanagement:Gateway a1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native