GatewayArgs

data class GatewayArgs(val description: Output<String>? = null, val gatewayId: Output<String>? = null, val locationData: Output<ResourceLocationDataContractArgs>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null) : ConvertibleToJava<GatewayArgs>

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/#accessing-any-api-version-via-local-packages 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",
});
});
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
})
}
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());
}
}

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}

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, gatewayId: Output<String>? = null, locationData: Output<ResourceLocationDataContractArgs>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

Gateway description

Link copied to clipboard
val gatewayId: Output<String>? = null

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

Link copied to clipboard

Gateway location.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Functions

Link copied to clipboard
open override fun toJava(): GatewayArgs