Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ApiGateway
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.ApiGateway

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    A single API Management gateway resource in List or Get response. Azure REST API version: 2023-09-01-preview.

    Example Usage

    ApiManagementCreateStandardGateway

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

return await Deployment.RunAsync(() => 
{
    var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
    {
        Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
        {
            Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
            {
                Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
            },
        },
        GatewayName = "apimGateway1",
        Location = "South Central US",
        ResourceGroupName = "rg1",
        Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
        {
            Capacity = 1,
            Name = AzureNative.ApiManagement.SkuType.Standard,
        },
        Tags = 
        {
            { "Name", "Contoso" },
            { "Test", "User" },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
			Backend: &apimanagement.BackendConfigurationArgs{
				Subnet: &apimanagement.BackendSubnetConfigurationArgs{
					Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
				},
			},
			GatewayName:       pulumi.String("apimGateway1"),
			Location:          pulumi.String("South Central US"),
			ResourceGroupName: pulumi.String("rg1"),
			Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
				Capacity: pulumi.Int(1),
				Name:     pulumi.String(apimanagement.SkuTypeStandard),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Contoso"),
				"Test": pulumi.String("User"),
			},
		})
		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.ApiGateway;
import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
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 apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
            .backend(BackendConfigurationArgs.builder()
                .subnet(BackendSubnetConfigurationArgs.builder()
                    .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
                    .build())
                .build())
            .gatewayName("apimGateway1")
            .location("South Central US")
            .resourceGroupName("rg1")
            .sku(ApiManagementGatewaySkuPropertiesArgs.builder()
                .capacity(1)
                .name("Standard")
                .build())
            .tags(Map.ofEntries(
                Map.entry("Name", "Contoso"),
                Map.entry("Test", "User")
            ))
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

api_gateway = azure_native.apimanagement.ApiGateway("apiGateway",
    backend=azure_native.apimanagement.BackendConfigurationArgs(
        subnet=azure_native.apimanagement.BackendSubnetConfigurationArgs(
            id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
        ),
    ),
    gateway_name="apimGateway1",
    location="South Central US",
    resource_group_name="rg1",
    sku=azure_native.apimanagement.ApiManagementGatewaySkuPropertiesArgs(
        capacity=1,
        name=azure_native.apimanagement.SkuType.STANDARD,
    ),
    tags={
        "Name": "Contoso",
        "Test": "User",
    })

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

const apiGateway = new azure_native.apimanagement.ApiGateway("apiGateway", {
    backend: {
        subnet: {
            id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
        },
    },
    gatewayName: "apimGateway1",
    location: "South Central US",
    resourceGroupName: "rg1",
    sku: {
        capacity: 1,
        name: azure_native.apimanagement.SkuType.Standard,
    },
    tags: {
        Name: "Contoso",
        Test: "User",
    },
});

    resources:
  apiGateway:
    type: azure-native:apimanagement:ApiGateway
    properties:
      backend:
        subnet:
          id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1
      gatewayName: apimGateway1
      location: South Central US
      resourceGroupName: rg1
      sku:
        capacity: 1
        name: Standard
      tags:
        Name: Contoso
        Test: User

    ApiManagementCreateWorkspacePremiumGateway

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

return await Deployment.RunAsync(() => 
{
    var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
    {
        Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
        {
            Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
            {
                Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
            },
        },
        GatewayName = "apimGateway1",
        Location = "South Central US",
        ResourceGroupName = "rg1",
        Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
        {
            Capacity = 1,
            Name = "WorkspaceGatewayPremium",
        },
        Tags = 
        {
            { "Name", "Contoso" },
            { "Test", "User" },
        },
        VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.External,
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
			Backend: &apimanagement.BackendConfigurationArgs{
				Subnet: &apimanagement.BackendSubnetConfigurationArgs{
					Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
				},
			},
			GatewayName:       pulumi.String("apimGateway1"),
			Location:          pulumi.String("South Central US"),
			ResourceGroupName: pulumi.String("rg1"),
			Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
				Capacity: pulumi.Int(1),
				Name:     pulumi.String("WorkspaceGatewayPremium"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Contoso"),
				"Test": pulumi.String("User"),
			},
			VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeExternal),
		})
		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.ApiGateway;
import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
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 apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
            .backend(BackendConfigurationArgs.builder()
                .subnet(BackendSubnetConfigurationArgs.builder()
                    .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
                    .build())
                .build())
            .gatewayName("apimGateway1")
            .location("South Central US")
            .resourceGroupName("rg1")
            .sku(ApiManagementGatewaySkuPropertiesArgs.builder()
                .capacity(1)
                .name("WorkspaceGatewayPremium")
                .build())
            .tags(Map.ofEntries(
                Map.entry("Name", "Contoso"),
                Map.entry("Test", "User")
            ))
            .virtualNetworkType("External")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

api_gateway = azure_native.apimanagement.ApiGateway("apiGateway",
    backend=azure_native.apimanagement.BackendConfigurationArgs(
        subnet=azure_native.apimanagement.BackendSubnetConfigurationArgs(
            id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
        ),
    ),
    gateway_name="apimGateway1",
    location="South Central US",
    resource_group_name="rg1",
    sku=azure_native.apimanagement.ApiManagementGatewaySkuPropertiesArgs(
        capacity=1,
        name="WorkspaceGatewayPremium",
    ),
    tags={
        "Name": "Contoso",
        "Test": "User",
    },
    virtual_network_type=azure_native.apimanagement.VirtualNetworkType.EXTERNAL)

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

const apiGateway = new azure_native.apimanagement.ApiGateway("apiGateway", {
    backend: {
        subnet: {
            id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
        },
    },
    gatewayName: "apimGateway1",
    location: "South Central US",
    resourceGroupName: "rg1",
    sku: {
        capacity: 1,
        name: "WorkspaceGatewayPremium",
    },
    tags: {
        Name: "Contoso",
        Test: "User",
    },
    virtualNetworkType: azure_native.apimanagement.VirtualNetworkType.External,
});

    resources:
  apiGateway:
    type: azure-native:apimanagement:ApiGateway
    properties:
      backend:
        subnet:
          id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1
      gatewayName: apimGateway1
      location: South Central US
      resourceGroupName: rg1
      sku:
        capacity: 1
        name: WorkspaceGatewayPremium
      tags:
        Name: Contoso
        Test: User
      virtualNetworkType: External

    Create ApiGateway Resource

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

    Constructor syntax

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

@overload
def ApiGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               resource_group_name: Optional[str] = None,
               sku: Optional[ApiManagementGatewaySkuPropertiesArgs] = None,
               backend: Optional[BackendConfigurationArgs] = None,
               gateway_name: Optional[str] = None,
               location: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               virtual_network_type: Optional[Union[str, VirtualNetworkType]] = None)
    func NewApiGateway(ctx *Context, name string, args ApiGatewayArgs, opts ...ResourceOption) (*ApiGateway, error)
    public ApiGateway(string name, ApiGatewayArgs args, CustomResourceOptions? opts = null)
    public ApiGateway(String name, ApiGatewayArgs args)
public ApiGateway(String name, ApiGatewayArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:ApiGateway
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 ApiGatewayArgs
    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 ApiGatewayArgs
    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 ApiGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayArgs
    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 apiGatewayResource = new AzureNative.ApiManagement.ApiGateway("apiGatewayResource", new()
{
    ResourceGroupName = "string",
    Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
    {
        Name = "string",
        Capacity = 0,
    },
    Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
    {
        Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
        {
            Id = "string",
        },
    },
    GatewayName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VirtualNetworkType = "string",
});

    example, err := apimanagement.NewApiGateway(ctx, "apiGatewayResource", &apimanagement.ApiGatewayArgs{
ResourceGroupName: pulumi.String("string"),
Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
Name: pulumi.String("string"),
Capacity: pulumi.Int(0),
},
Backend: &apimanagement.BackendConfigurationArgs{
Subnet: &apimanagement.BackendSubnetConfigurationArgs{
Id: pulumi.String("string"),
},
},
GatewayName: pulumi.String("string"),
Location: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VirtualNetworkType: pulumi.String("string"),
})

    var apiGatewayResource = new ApiGateway("apiGatewayResource", ApiGatewayArgs.builder()
    .resourceGroupName("string")
    .sku(ApiManagementGatewaySkuPropertiesArgs.builder()
        .name("string")
        .capacity(0)
        .build())
    .backend(BackendConfigurationArgs.builder()
        .subnet(BackendSubnetConfigurationArgs.builder()
            .id("string")
            .build())
        .build())
    .gatewayName("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .virtualNetworkType("string")
    .build());

    api_gateway_resource = azure_native.apimanagement.ApiGateway("apiGatewayResource",
    resource_group_name="string",
    sku=azure_native.apimanagement.ApiManagementGatewaySkuPropertiesArgs(
        name="string",
        capacity=0,
    ),
    backend=azure_native.apimanagement.BackendConfigurationArgs(
        subnet=azure_native.apimanagement.BackendSubnetConfigurationArgs(
            id="string",
        ),
    ),
    gateway_name="string",
    location="string",
    tags={
        "string": "string",
    },
    virtual_network_type="string")

    const apiGatewayResource = new azure_native.apimanagement.ApiGateway("apiGatewayResource", {
    resourceGroupName: "string",
    sku: {
        name: "string",
        capacity: 0,
    },
    backend: {
        subnet: {
            id: "string",
        },
    },
    gatewayName: "string",
    location: "string",
    tags: {
        string: "string",
    },
    virtualNetworkType: "string",
});

    type: azure-native:apimanagement:ApiGateway
properties:
    backend:
        subnet:
            id: string
    gatewayName: string
    location: string
    resourceGroupName: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
    virtualNetworkType: string

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

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Sku Pulumi.AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuProperties
    SKU properties of the API Management gateway.
    Backend Pulumi.AzureNative.ApiManagement.Inputs.BackendConfiguration
    Information regarding how the gateway should integrate with backend systems.
    GatewayName string
    The name of the API Management gateway.
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualNetworkType string | Pulumi.AzureNative.ApiManagement.VirtualNetworkType
    The type of VPN in which API Management gateway needs to be configured in.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Sku ApiManagementGatewaySkuPropertiesArgs
    SKU properties of the API Management gateway.
    Backend BackendConfigurationArgs
    Information regarding how the gateway should integrate with backend systems.
    GatewayName string
    The name of the API Management gateway.
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    VirtualNetworkType string | VirtualNetworkType
    The type of VPN in which API Management gateway needs to be configured in.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sku ApiManagementGatewaySkuProperties
    SKU properties of the API Management gateway.
    backend BackendConfiguration
    Information regarding how the gateway should integrate with backend systems.
    gatewayName String
    The name of the API Management gateway.
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    virtualNetworkType String | VirtualNetworkType
    The type of VPN in which API Management gateway needs to be configured in.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sku ApiManagementGatewaySkuProperties
    SKU properties of the API Management gateway.
    backend BackendConfiguration
    Information regarding how the gateway should integrate with backend systems.
    gatewayName string
    The name of the API Management gateway.
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    virtualNetworkType string | VirtualNetworkType
    The type of VPN in which API Management gateway needs to be configured in.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    sku ApiManagementGatewaySkuPropertiesArgs
    SKU properties of the API Management gateway.
    backend BackendConfigurationArgs
    Information regarding how the gateway should integrate with backend systems.
    gateway_name str
    The name of the API Management gateway.
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    virtual_network_type str | VirtualNetworkType
    The type of VPN in which API Management gateway needs to be configured in.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sku Property Map
    SKU properties of the API Management gateway.
    backend Property Map
    Information regarding how the gateway should integrate with backend systems.
    gatewayName String
    The name of the API Management gateway.
    location String
    Resource location.
    tags Map<String>
    Resource tags.
    virtualNetworkType String | "None" | "External" | "Internal"
    The type of VPN in which API Management gateway needs to be configured in.

    Outputs

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

    CreatedAtUtc string
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    SystemData Pulumi.AzureNative.ApiManagement.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    TargetProvisioningState string
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    Type string
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    ConfigurationApi Pulumi.AzureNative.ApiManagement.Outputs.GatewayConfigurationApiResponse
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    Frontend Pulumi.AzureNative.ApiManagement.Outputs.FrontendConfigurationResponse
    Information regarding how the gateway should be exposed.
    CreatedAtUtc string
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    TargetProvisioningState string
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    Type string
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    ConfigurationApi GatewayConfigurationApiResponse
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    Frontend FrontendConfigurationResponse
    Information regarding how the gateway should be exposed.
    createdAtUtc String
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    targetProvisioningState String
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    type String
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    configurationApi GatewayConfigurationApiResponse
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    frontend FrontendConfigurationResponse
    Information regarding how the gateway should be exposed.
    createdAtUtc string
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    targetProvisioningState string
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    type string
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    configurationApi GatewayConfigurationApiResponse
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    frontend FrontendConfigurationResponse
    Information regarding how the gateway should be exposed.
    created_at_utc str
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    target_provisioning_state str
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    type str
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    configuration_api GatewayConfigurationApiResponse
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    frontend FrontendConfigurationResponse
    Information regarding how the gateway should be exposed.
    createdAtUtc String
    Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    targetProvisioningState String
    The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
    type String
    Resource type for API Management resource is set to Microsoft.ApiManagement.
    configurationApi Property Map
    Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    frontend Property Map
    Information regarding how the gateway should be exposed.

    Supporting Types

    ApiManagementGatewaySkuProperties, ApiManagementGatewaySkuPropertiesArgs

    Name string | Pulumi.AzureNative.ApiManagement.SkuType
    Name of the Sku.
    Capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    Name string | SkuType
    Name of the Sku.
    Capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    name String | SkuType
    Name of the Sku.
    capacity Integer
    Capacity of the SKU (number of deployed units of the SKU)
    name string | SkuType
    Name of the Sku.
    capacity number
    Capacity of the SKU (number of deployed units of the SKU)
    name str | SkuType
    Name of the Sku.
    capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    name String | "Developer" | "Standard" | "Premium" | "Basic" | "Consumption" | "Isolated"
    Name of the Sku.
    capacity Number
    Capacity of the SKU (number of deployed units of the SKU)

    ApiManagementGatewaySkuPropertiesResponse, ApiManagementGatewaySkuPropertiesResponseArgs

    Name string
    Name of the Sku.
    Capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    Name string
    Name of the Sku.
    Capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    name String
    Name of the Sku.
    capacity Integer
    Capacity of the SKU (number of deployed units of the SKU)
    name string
    Name of the Sku.
    capacity number
    Capacity of the SKU (number of deployed units of the SKU)
    name str
    Name of the Sku.
    capacity int
    Capacity of the SKU (number of deployed units of the SKU)
    name String
    Name of the Sku.
    capacity Number
    Capacity of the SKU (number of deployed units of the SKU)

    BackendConfiguration, BackendConfigurationArgs

    Subnet Pulumi.AzureNative.ApiManagement.Inputs.BackendSubnetConfiguration
    The default hostname of the data-plane gateway to which requests can be sent.
    Subnet BackendSubnetConfiguration
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfiguration
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfiguration
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfiguration
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet Property Map
    The default hostname of the data-plane gateway to which requests can be sent.

    BackendConfigurationResponse, BackendConfigurationResponseArgs

    Subnet Pulumi.AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationResponse
    The default hostname of the data-plane gateway to which requests can be sent.
    Subnet BackendSubnetConfigurationResponse
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfigurationResponse
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfigurationResponse
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet BackendSubnetConfigurationResponse
    The default hostname of the data-plane gateway to which requests can be sent.
    subnet Property Map
    The default hostname of the data-plane gateway to which requests can be sent.

    BackendSubnetConfiguration, BackendSubnetConfigurationArgs

    Id string
    The ARM ID of the subnet in which the backend systems are hosted.
    Id string
    The ARM ID of the subnet in which the backend systems are hosted.
    id String
    The ARM ID of the subnet in which the backend systems are hosted.
    id string
    The ARM ID of the subnet in which the backend systems are hosted.
    id str
    The ARM ID of the subnet in which the backend systems are hosted.
    id String
    The ARM ID of the subnet in which the backend systems are hosted.

    BackendSubnetConfigurationResponse, BackendSubnetConfigurationResponseArgs

    Id string
    The ARM ID of the subnet in which the backend systems are hosted.
    Id string
    The ARM ID of the subnet in which the backend systems are hosted.
    id String
    The ARM ID of the subnet in which the backend systems are hosted.
    id string
    The ARM ID of the subnet in which the backend systems are hosted.
    id str
    The ARM ID of the subnet in which the backend systems are hosted.
    id String
    The ARM ID of the subnet in which the backend systems are hosted.

    FrontendConfigurationResponse, FrontendConfigurationResponseArgs

    DefaultHostname string
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
    DefaultHostname string
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
    defaultHostname String
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
    defaultHostname string
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
    default_hostname str
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
    defaultHostname String
    The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.

    GatewayConfigurationApiResponse, GatewayConfigurationApiResponseArgs

    Hostname string
    Hostname to which the agent connects to propagate configuration to the cloud.
    Hostname string
    Hostname to which the agent connects to propagate configuration to the cloud.
    hostname String
    Hostname to which the agent connects to propagate configuration to the cloud.
    hostname string
    Hostname to which the agent connects to propagate configuration to the cloud.
    hostname str
    Hostname to which the agent connects to propagate configuration to the cloud.
    hostname String
    Hostname to which the agent connects to propagate configuration to the cloud.

    SkuType, SkuTypeArgs

    Developer
    DeveloperDeveloper SKU of Api Management.
    Standard
    StandardStandard SKU of Api Management.
    Premium
    PremiumPremium SKU of Api Management.
    Basic
    BasicBasic SKU of Api Management.
    Consumption
    ConsumptionConsumption SKU of Api Management.
    Isolated
    IsolatedIsolated SKU of Api Management.
    SkuTypeDeveloper
    DeveloperDeveloper SKU of Api Management.
    SkuTypeStandard
    StandardStandard SKU of Api Management.
    SkuTypePremium
    PremiumPremium SKU of Api Management.
    SkuTypeBasic
    BasicBasic SKU of Api Management.
    SkuTypeConsumption
    ConsumptionConsumption SKU of Api Management.
    SkuTypeIsolated
    IsolatedIsolated SKU of Api Management.
    Developer
    DeveloperDeveloper SKU of Api Management.
    Standard
    StandardStandard SKU of Api Management.
    Premium
    PremiumPremium SKU of Api Management.
    Basic
    BasicBasic SKU of Api Management.
    Consumption
    ConsumptionConsumption SKU of Api Management.
    Isolated
    IsolatedIsolated SKU of Api Management.
    Developer
    DeveloperDeveloper SKU of Api Management.
    Standard
    StandardStandard SKU of Api Management.
    Premium
    PremiumPremium SKU of Api Management.
    Basic
    BasicBasic SKU of Api Management.
    Consumption
    ConsumptionConsumption SKU of Api Management.
    Isolated
    IsolatedIsolated SKU of Api Management.
    DEVELOPER
    DeveloperDeveloper SKU of Api Management.
    STANDARD
    StandardStandard SKU of Api Management.
    PREMIUM
    PremiumPremium SKU of Api Management.
    BASIC
    BasicBasic SKU of Api Management.
    CONSUMPTION
    ConsumptionConsumption SKU of Api Management.
    ISOLATED
    IsolatedIsolated SKU of Api Management.
    "Developer"
    DeveloperDeveloper SKU of Api Management.
    "Standard"
    StandardStandard SKU of Api Management.
    "Premium"
    PremiumPremium SKU of Api Management.
    "Basic"
    BasicBasic SKU of Api Management.
    "Consumption"
    ConsumptionConsumption SKU of Api Management.
    "Isolated"
    IsolatedIsolated SKU of Api Management.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualNetworkType, VirtualNetworkTypeArgs

    None
    NoneThe service is not part of any Virtual Network.
    External
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    Internal
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
    VirtualNetworkTypeNone
    NoneThe service is not part of any Virtual Network.
    VirtualNetworkTypeExternal
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    VirtualNetworkTypeInternal
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
    None
    NoneThe service is not part of any Virtual Network.
    External
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    Internal
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
    None
    NoneThe service is not part of any Virtual Network.
    External
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    Internal
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
    NONE
    NoneThe service is not part of any Virtual Network.
    EXTERNAL
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    INTERNAL
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
    "None"
    NoneThe service is not part of any Virtual Network.
    "External"
    ExternalThe service is part of Virtual Network and it is accessible from Internet.
    "Internal"
    InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.

    Import

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

    $ pulumi import azure-native:apimanagement:ApiGateway apimGateway1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native