Azure Native v1.102.0, May 2 23

azure-native.apimanagement.Gateway

Explore with Pulumi AI

Gateway details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateGateway

using System.Collections.Generic;
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/go/azure/apimanagement"
	"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.ResourceLocationDataContractResponse{
				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 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(Map.of("name", "my location"))
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

gateway = azure_native.apimanagement.Gateway("gateway",
    description="my gateway 1",
    gateway_id="gw1",
    location_data=azure_native.apimanagement.ResourceLocationDataContractResponseArgs(
        name="my location",
    ),
    resource_group_name="rg1",
    service_name="apimService1")

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",
});

resources:
  gateway:
    type: azure-native:apimanagement:Gateway
    properties:
      description: my gateway 1
      gatewayId: gw1
      locationData:
        name: my location
      resourceGroupName: rg1
      serviceName: apimService1

Create Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            gateway_id: Optional[str] = None,
            location_data: Optional[ResourceLocationDataContractArgs] = None,
            resource_group_name: Optional[str] = None,
            service_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-native: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:

ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Description string: Gateway description
GatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
LocationData Pulumi.AzureNative.ApiManagement.Inputs.ResourceLocationDataContractArgs: Gateway location.

ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Description string: Gateway description
GatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
LocationData ResourceLocationDataContractArgs: Gateway location.

resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
description String: Gateway description
gatewayId String: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
locationData ResourceLocationDataContractArgs: Gateway location.

resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.
description string: Gateway description
gatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
locationData ResourceLocationDataContractArgs: Gateway location.

resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.
description str: Gateway description
gateway_id 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 String: The name of the resource group.
serviceName String: The name of the API Management service.
description String: Gateway description
gatewayId 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:

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
type string: Resource type for API Management resource.

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
type str: Resource type for API Management resource.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

Supporting Types

ResourceLocationDataContract

Name 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 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 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 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 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 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

Name 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 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 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 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 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 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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0